Default to C.UTF-8 locale and deprecate /etc/debootstrap/locale.gen, DEFAULT_LOCALES...
[grml-debootstrap.git] / grml-debootstrap
1 #!/bin/bash
2 # Filename:      grml-debootstrap
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 https://grml.org/bugs/
6 # License:       This file is licensed under the GPL v2+
7 ################################################################################
8
9 # error_handler {{{
10 [ -n "$REPORT_TRAP_ERR" ] || REPORT_TRAP_ERR='no'
11 [ -n "$FAIL_TRAP_ERR" ] || FAIL_TRAP_ERR='no'
12
13 error_handler() {
14    last_exit_code="$?"
15    last_bash_command="$BASH_COMMAND"
16    if [ "$REPORT_TRAP_ERR" = "yes" ]; then
17       echo "Unexpected non-zero exit code $last_exit_code in ${BASH_SOURCE[*]} at line ${BASH_LINENO[*]} detected!
18 last bash command: $last_bash_command"
19    fi
20    if [ ! "$FAIL_TRAP_ERR" = "yes" ]; then
21       return
22    fi
23    ## Check if "bailout" function is available.
24    ## This is not the case in chroot-script.
25    if command -v bailout >/dev/null 2>&1; then
26       bailout 1
27    else
28       echo 'FAIL_TRAP_ERR is set to "yes", exit 1.'
29       exit 1
30    fi
31 }
32
33 if [ "$REPORT_TRAP_ERR" = "yes" ] || [ "$FAIL_TRAP_ERR" = "yes" ]; then
34    set -E
35    set -o pipefail
36    trap "error_handler" ERR
37    export -f "error_handler"
38 fi
39 # }}}
40
41 # variables {{{
42 PN="$(basename "$0")"
43 if [[ -d "$(dirname "$(command -v "$0")")"/.git ]]; then
44   VERSION="$(git describe | sed 's|^v||')"
45 else
46   VERSION="$(dpkg-query --show --showformat='${Version}' "$PN")"
47 fi
48 VERSION="${VERSION:-unknown}"
49 MNTPOINT="/mnt/debootstrap.$$"
50
51 # defaults
52 [ -n "$CHROOT_SCRIPTS" ] || CHROOT_SCRIPTS='yes'
53 [ -n "$CONFFILES" ] || CONFFILES='/etc/debootstrap'
54 [ -n "$DEBCONF" ] || DEBCONF='yes'
55 [ -n "$DEBIAN_FRONTEND" ] || DEBIAN_FRONTEND='noninteractive'
56 [ -n "$DEBOOTSTRAP" ] || DEBOOTSTRAP='debootstrap'
57 [ -n "$DISK_IDENTIFIER" ] || DISK_IDENTIFIER='26ada0c0-1165-4098-884d-aafd2220c2c6'
58 [ -n "$EXTRAPACKAGES" ] || EXTRAPACKAGES='yes'
59 [ -n "$FALLBACK_MIRROR" ] || FALLBACK_MIRROR='http://deb.debian.org/debian'
60 [ -n "$FIXED_DISK_IDENTIFIERS" ] || FIXED_DISK_IDENTIFIERS="no"
61 [ -n "$FORCE" ] || FORCE=''
62 [ -n "$HOSTNAME" ] || HOSTNAME='grml'
63 [ -n "$INITRD" ] || INITRD='yes'
64 [ -n "$INSTALL_NOTES" ] || INSTALL_NOTES='/etc/debootstrap/install_notes'
65 [ -n "$MIRROR" ] || MIRROR="$FALLBACK_MIRROR"
66 [ -n "$MKFS" ] || MKFS='mkfs.ext4'
67 [ -n "$MKFS_OPTS" ] || MKFS_OPTS=''
68 [ -n "$PACKAGES" ] || PACKAGES='yes'
69 [ -n "$POST_SCRIPTS" ] || POST_SCRIPTS='yes'
70 [ -n "$PRE_SCRIPTS" ] || PRE_SCRIPTS='yes'
71 [ -n "$RECONFIGURE" ] || RECONFIGURE='console-data'
72 [ -n "$RELEASE" ] || RELEASE='buster'
73 [ -n "$RM_APTCACHE" ] || RM_APTCACHE='yes'
74 [ -n "$SCRIPTS" ] || SCRIPTS='no' # deprecated, replaced by POST_SCRIPTS
75 [ -n "$SECURE" ] || SECURE='yes'
76 [ -n "$TIMEZONE" ] || TIMEZONE='Europe/Vienna'
77 [ -n "$TUNE2FS" ] || TUNE2FS='tune2fs -c0 -i0'
78 [ -n "$UPGRADE_SYSTEM" ] || UPGRADE_SYSTEM='yes'
79 [ -n "$VMSIZE" ] || VMSIZE="2G"
80 [ -n "$GRUB_INSTALL" ] || GRUB_INSTALL='yes'
81
82 # inside the chroot system locales might not be available, so use minimum:
83 export LANG=C
84 export LC_ALL=C
85 export LANGUAGE=C
86
87 # make sure interactive mode is only executed when
88 # using an empty configuration file or option --interactive
89 INTERACTIVE=''
90 # }}}
91
92 # help text {{{
93 usage() {
94   echo "$PN - wrapper around debootstrap for installing Debian
95
96 Usage: $PN [options]
97
98 Bootstrap options:
99
100   -m, --mirror <URL>     Mirror which should be used for apt-get/aptitude.
101   -i, --iso <mnt>        Mountpoint where a Debian ISO is mounted to, for use
102                          instead of fetching packages from a mirror.
103   -r, --release <name>   Release of new Debian system (default: buster).
104   -t, --target <target>  Target partition (/dev/...) or directory where the
105                          system should be installed to.
106   -p, --mntpoint <mnt>   Mountpoint used for mounting the target system,
107                          has no effect if -t is given and represents a directory.
108       --debopt <params>  Extra parameters passed to the debootstrap command.
109       --interactive      Use interactive mode (frontend).
110       --nodebootstrap    Skip debootstrap, only do configuration to the target.
111       --grub <device>    Target for grub installation. Usage example: /dev/sda
112       --efi <device>     Target for EFI installation. Usage example: /dev/sda1
113       --arch <arch>      Set target architecture, use for installing i386 on amd64.
114       --filesystem <fs>  Filesystem that should be used when target is a partition
115                          or Virtual Machine (see --vmfile).
116       --force            Do not prompt for user acknowledgement.
117
118 Options for Virtual Machine deployment:
119
120       --vm               Set up a Virtual Machine on an existing block device
121                          instead of plainly installing to a partition or
122                          directory. Needs to be combined with --target.
123                          Example: --vm --target /dev/mapper/your-vm-disk
124       --vmfile           Like --vm, but install into a regular file (created by
125                          'qemu-img create -f raw ...') instead.
126                          Example: --vmfile --target /mnt/sda1/qemu.img
127       --vmsize <size>    Use specified size for size of VM file (default: 2G).
128                          Syntax as supported by qemu-img, like: --vmsize 3G
129
130 Configuration options:
131
132   -c, --config <file>      Use specified configuration file, defaults to
133                              /etc/debootstrap/config
134   -d, --confdir <path>     Place of config files for debootstrap, defaults
135                              to /etc/debootstrap
136       --packages <file>    Install packages defined in specified list file
137                              instead of using /etc/debootstrap/packages.
138       --nopackages         Skip installation of packages defined in
139                              /etc/debootstrap/packages
140       --nokernel           Skip installation of default kernel images.
141       --nointerfaces       Do not copy /etc/network/interfaces from host system
142                            to target system.
143                            (This option is automatically enabled when using --vmfile.)
144       --defaultinterfaces  Install a default /etc/network/interfaces file (enabling
145                            DHCP for eth0) instead of taking over config from host system.
146       --debconf <file>     Pre-seed packages using specified pre-seed db file.
147       --grmlrepos          Enable Grml's Debian repository (deb.grml.org).
148       --backportrepos      Enable Debian's backports repository (backports.debian.org).
149       --keep_src_list      Do not overwrite user provided apt sources.list.
150       --contrib            Enable 'contrib' in COMPONENTS (defaults to 'main' only).
151       --non-free           Enable non-free in COMPONENTS (defaults to 'main' only).
152       --hostname <name>    Hostname of Debian system.
153       --nopassword         Do not prompt for the root password.
154       --password <pwd>     Use specified password as password for user root.
155       --sshcopyid          Use locally available public keys to authorise root login on the target system.
156       --bootappend <line>  Add specified appendline to kernel whilst booting.
157       --chroot-scripts <d> Execute chroot scripts from specified directory.
158       --pre-scripts <dir>  Execute scripts from specified directory (before chroot-scripts).
159       --scripts <dir>      Execute scripts from specified directory (after chroot-scripts).
160       --remove-configs     Delete grml-debootstrap configuration files from installed system.
161
162 Other options:
163
164   -v, --verbose            Increase verbosity.
165       --debug              Execute in very verbose way.
166   -h, --help               Print this usage information and exit.
167   -V, --version            Show summary of options and exit.
168
169 Usage examples can be found in the grml-debootstrap manpage.
170 Send bugreports to the grml-team: bugs (at) grml.org || https://grml.org/bugs/
171 "
172 }
173
174 if [ "$1" = '-h' ] || [ "$1" = '-help' ] || [ "$1" = "--help" ] ; then
175    usage
176    echo 'Please notice that this script requires root permissions!'
177    exit 0
178 fi
179 # }}}
180
181 # early helper functions {{{
182 GOOD='\e[32;01m'
183 BAD='\e[31;01m'
184 WARN='\e[33;01m'
185 NORMAL='\e[0m'
186
187 einfo() {
188   einfon "$1\\n"
189   return 0
190 }
191
192 einfon() {
193   [ "${RC_ENDCOL}" != "yes" ] && [ "${LAST_E_CMD}" = "ebegin" ] && echo
194   printf " %s*%s $*" "${GOOD}" "${NORMAL}"
195   LAST_E_CMD=einfon
196   return 0
197 }
198
199 ewarn() {
200   printf " %s*%s $*\\n" "${WARN}" "${NORMAL}"
201   return 0
202 }
203
204 eerror() {
205   [ "${RC_ENDCOL}" != "yes" ] && [ "${LAST_E_CMD}" = "ebegin" ] && echo
206   printf " %s*%s $*\\n" "${BAD}" "${NORMAL}" >&2
207   LAST_E_CMD=eerror
208   return 0
209 }
210
211 eend() {
212   local retval="${1:-0}"
213   shift
214   if [ "$retval" -gt 0 ]; then
215     printf " %s-> Failed (rc=%s)%s\\n" "${BAD}" "${retval}" "${NORMAL}"
216   fi
217   return "$retval"
218 }
219
220 check4root(){
221   if [ "$(id -u 2>/dev/null)" != 0 ] ; then
222     echo 1>&2 "Error: please run this script with uid 0 (root)." ; return 1
223   fi
224 }
225
226 check4progs(){
227   local RC=''
228   for arg in "$@" ; do
229     command -v "$arg" >/dev/null 2>&1 || RC="$arg"
230   done
231   if [ -n "$RC" ] ; then
232      echo "$RC not installed"
233      return 1
234   fi
235 }
236 # }}}
237
238 # helper functions {{{
239 cleanup() {
240   if [ -n "$CHROOT_VARIABLES" ] ; then
241     einfo "Removing ${CHROOT_VARIABLES}" ; rm "$CHROOT_VARIABLES" ; eend $?
242   fi
243
244   if [ -n "$STAGES" ] ; then
245     einfo "Removing ${STAGES}" ; rmdir "$STAGES" ; eend $?
246   fi
247
248   # Remove temporary mountpoint again
249   if echo "$MNTPOINT" | grep -q '/mnt/debootstrap\.' ; then
250     rmdir "$MNTPOINT" 2>/dev/null
251   fi
252
253   # make sure $TARGET is not mounted when exiting grml-debootstrap
254   if [ -n "$MNTPOINT" ] ; then
255     if grep -q "$MNTPOINT" /proc/mounts ; then
256       # make sure nothing is left inside chroot so we can unmount it
257       for service in ssh mdadm ; do
258         if [ -x "${MNTPOINT}/etc/init.d/${service}" ] ; then
259           chroot "$MNTPOINT" "/etc/init.d/${service}" stop
260         fi
261       done
262
263       [ -x "$MNTPOINT"/bin/umount ] && chroot "$MNTPOINT" umount -a >/dev/null 2>&1
264
265       # ugly, but make sure we really don't leave anything (/proc /proc and
266       # /dev /dev are intended, trying to work around timing issues, see #657023)
267       for ARG in /run/udev /sys /proc /proc /dev/pts /dev/pts /dev /dev ; do
268         [ -x "$MNTPOINT"/bin/umount ] && chroot "$MNTPOINT" umount $ARG >/dev/null 2>&1
269         umount "$MNTPOINT"/$ARG >/dev/null 2>&1
270       done
271
272       if [ -n "$ISODIR" ] ; then
273         [ -d "$MNTPOINT/$ISODIR" ] && umount "$MNTPOINT/$ISODIR" >/dev/null 2>&1
274       fi
275
276       if [ -n "$DIRECTORY" ] ; then
277         einfo "Not unmounting $MNTPOINT as you requested me to install into a directory of your own choice." ; eend 0
278       else
279         einfo "Unmounting $MNTPOINT"
280         umount "$MNTPOINT"
281         eend $?
282       fi
283
284       if [ -n "$STAGES" ] ; then
285         echo -n "Removing stages directory ${STAGES}: "
286         rm -rf "$STAGES" && echo 'done'
287       fi
288
289       # remove directory only if we used the default with process id inside the name
290       if echo "$MNTPOINT" | grep -q '/mnt/debootstrap\.' ; then
291         einfo "Removing directory ${MNTPOINT}"
292         rmdir "$MNTPOINT"
293         eend $?
294       fi
295     fi
296   fi
297
298   if [ -n "${ORIG_TARGET}" ] ; then
299     einfo "Removing loopback mount of file ${ORIG_TARGET}."
300     kpartx -d "${ORIG_TARGET}"
301     # Workaround for a bug in kpartx which doesn't clean up properly,
302     # see Debian Bug #891077 and Github-PR grml/grml-debootstrap#112
303     if dmsetup ls | grep -q "^${LOOP_PART} "; then
304       kpartx -d "/dev/${LOOP_DISK}" >/dev/null
305     fi
306     eend $?
307   fi
308 }
309
310 # we want to exit smoothly and clean:
311 bailout(){
312
313   cleanup
314
315   [ -n "$1" ] && EXIT="$1" || EXIT="1"
316   [ -n "$2" ] && einfo "Notice: remove $STAGES/$2 to reexecute the stage"
317
318   exit "$EXIT"
319 }
320 trap bailout HUP INT QUIT TERM
321
322 # we want to execute all the functions only once, simple check for it:
323 stage() {
324   if [ -n "$2" ] ; then
325      echo "$2" > "${STAGES}/${1}"
326      return 0
327   elif grep -q 'done' "${STAGES}/${1}" 2>/dev/null ; then
328      ewarn "Notice: stage $1 has been executed already, skipping execution therefore." ; eend 0
329      ewarn "  To reexecute it clean up the according directory inside $STAGES" ; eend 0
330      return 1
331   fi
332 }
333 # }}}
334
335 # make sure we have what we need {{{
336 check4progs "${DEBOOTSTRAP}" || bailout 1
337 # }}}
338
339 # source main configuration file {{{
340 if [ -r /etc/debootstrap/config ] ; then
341   # shellcheck disable=SC1091
342   . /etc/debootstrap/config
343 fi
344 # }}}
345
346 # cmdline handling {{{
347 CMDLINE_OPTS=mirror:,iso:,release:,target:,mntpoint:,debopt:,defaultinterfaces,interactive,nodebootstrap,nointerfaces,nokernel,nopackages,filesystem:,config:,confdir:,packages:,chroot-scripts:,scripts:,post-scripts:,pre-scripts:,debconf:,vm,vmfile,vmsize:,keep_src_list,hostname:,password:,nopassword,grmlrepos,backportrepos,bootappend:,grub:,efi:,arch:,insecure,verbose,help,version,force,debug,contrib,non-free,remove-configs,sshcopyid
348
349 _opt_temp=$(getopt --name grml-debootstrap -o +m:i:r:t:p:c:d:vhV --long \
350   $CMDLINE_OPTS -- "$@")
351
352 if [ $? != 0 ]; then
353   eerror "Try 'grml-debootstrap --help' for more information."; eend 1; exit 1
354 fi
355 eval set -- "$_opt_temp"
356
357 while :; do
358   case "$1" in
359
360   # == Bootstrap options
361   --mirror|-m)         # Mirror which should be used for apt-get/aptitude
362     shift; _opt_mirror="$1"
363     ;;
364   --iso|-i)            # Mountpoint where a Debian ISO is mounted to
365     shift; _opt_iso="$1"
366     ;;
367   --release|-r)        # Release of new Debian system
368     shift; _opt_release="$1"
369     ;;
370   --target|-t)         # Target partition (/dev/...) or directory
371     shift; _opt_target="$1"
372     ;;
373   --vm)                # Virtual machine image (no file)
374     _opt_vm="T"
375     ;;
376   --vmfile)            # Virtual machine file
377     _opt_vmfile="T"
378     ;;
379   --vmsize)            # size of Virtual machine file
380     shift; _opt_vmsize="$1"
381     ;;
382   --mntpoint|-p)       # Mountpoint used for mounting the target system
383     shift; _opt_mntpoint="$1"
384     ;;
385   --debopt)            # Extra parameters passed to the debootstrap command
386     shift; _opt_debopt="$1"
387     ;;
388   --filesystem)        # Filesystem that should be used
389     shift; _opt_filesystem="$1"
390     ;;
391   --interactive)       # Use interactive mode (frontend)
392     _opt_interactive=T
393     ;;
394   --nodebootstrap)     # Skip debootstrap, only do configuration to the target
395     _opt_nodebootstrap=T
396     ;;
397   --nopackages)        # Skip installation of packages defined in /etc/debootstrap/packages
398     _opt_nopackages=T
399     ;;
400   --arch)              # Target architecutre
401     shift; _opt_arch="$1"
402     ;;
403   # just for backwards compatibility
404   --insecure)
405     _opt_insecure=T
406     ;;
407   #
408
409   # == Configuration options
410   --config|-c)         # Use specified configuration file, defaults to /etc/debootstrap
411     shift; _opt_config="$1"
412     ;;
413   --confdir|-d)        # Place of config files for debootstrap, defaults to /etc/debootstrap
414     shift; _opt_confdir="$1"
415     ;;
416   --packages)          # Install packages defined in specified file
417     shift; _opt_packages="$1"
418     _opt_packages_set=T
419     ;;
420   --debconf)           # Pre-seed packages using specified file
421     shift; _opt_debconf="$1"
422     _opt_debconf_set=T
423     ;;
424   --pre-scripts)       # Execute scripts from specified directory (before chroot-scripts).
425     shift; _opt_pre_scripts="$1"
426     _opt_pre_scripts_set=T
427     ;;
428   --scripts)           # Execute scripts from specified directory [NOTE: deprecated, replaced via --post-scripts]
429     shift; _opt_scripts="$1"
430     _opt_scripts_set=T
431     ;;
432   --post-scripts)       # Execute scripts from specified directory
433     shift; _opt_post_scripts="$1"
434     _opt_post_scripts_set=T
435     ;;
436   --chroot-scripts)   # Execute chroot scripts from specified directory
437     shift; _opt_chroot_scripts="$1"
438     _opt_chroot_scripts_set=T
439     ;;
440   --keep_src_list)     # Do not overwrite user provided apt sources.list
441     _opt_keep_src_list=T
442     ;;
443   --hostname)          # Hostname of Debian system
444     shift; _opt_hostname="$1"
445     ;;
446   --password)          # Use specified password as password for user root
447     shift; _opt_password="$1"
448     ;;
449   --defaultinterfaces) # Install default /etc/network/interfaces
450     _opt_defaultinterfaces=T
451     ;;
452   --nointerfaces)      # Skip installation of /etc/network/interfaces
453     _opt_nointerfaces=T
454     ;;
455   --nokernel)          # Skip installation of default kernel images
456     _opt_nokernel=T
457     ;;
458   --nopassword)        # Skip password dialog
459     _opt_nopassword=T
460     ;;
461   --sshcopyid)         # Use locally available public keys to authorise root login on the target system
462     _opt_sshcopyid=T
463     ;;
464   --grmlrepos)         # Enable Grml repository
465     _opt_grmlrepos=T
466     ;;
467   --backportrepos)     # Enable Debian backports repository
468     _opt_backportrepos=T
469     ;;
470   --bootappend)        # Add specified appendline to kernel whilst booting
471     shift; _opt_bootappend="$1"
472     ;;
473   --grub)              # Target for grub installation. Use grub syntax for specifying
474     shift; _opt_grub="$1"
475     ;;
476   --efi)               # Target for EFI boot installation
477     shift; _opt_efi="$1"
478     ;;
479   --contrib)           # Add 'contrib' to list of components
480     _opt_contrib=T
481     ;;
482   --non-free)          # Add 'non-free' to list of components
483     _opt_non_free=T
484     ;;
485   --remove-configs)    # Drop config files from installed system
486     _opt_remove_configs=T
487     ;;
488
489   # == Other options
490   --verbose|-v)        # Increase verbosity
491     if [ "$_opt_verbose" ]; then
492       _opt_verbose=$( _opt_verbose + 1 )
493     else
494       _opt_verbose=1
495     fi
496     ;;
497   --debug)             # Execute in debug mode
498     _opt_debug=T
499     ;;
500   --help|-h)           # Print usage information and exit
501     _opt_help=T
502     ;;
503   --version|-V)        # Show version information and exit
504     _opt_version=T
505     ;;
506   --force)             # Do not prompt for user input
507     _opt_force=T
508     ;;
509   --)
510     shift; break
511     ;;
512   *)
513     eerror "Internal getopt error!"; eend 1 ; exit 1
514     ;;
515   esac
516   shift
517 done
518
519 # == business-logic of command line parameter-processing
520
521 # source configuration file in <confdir> if supplied. {{{
522 [ "$_opt_confdir" ] && {
523   CONFFILES=$_opt_confdir
524   einfo "Using config files under $CONFFILES/."
525   if ! [ -r "$CONFFILES/config" ] ; then
526     eerror "Error: config file $CONFFILES/config not found."; eend 1; bailout 1
527   fi
528   # shellcheck disable=SC1091 source=config
529   if ! . "$CONFFILES/config" ; then
530     eerror "Error reading config file $CONFFILES/config" ; eend 1 ; bailout 1
531   fi
532   # restore the command line parameter value
533   CONFFILES=$_opt_confdir
534 }
535 # }}}
536
537 [ "$_opt_mirror" ]              && MIRROR=$_opt_mirror
538 [ "$_opt_iso" ]                 && ISO=$_opt_iso
539 [ "$_opt_release" ]             && RELEASE=$_opt_release
540 [ "$_opt_target" ]              && TARGET=$_opt_target
541 [ "$_opt_vm" ]                  && VIRTUAL=1
542 [ "$_opt_vmfile" ]              && VMFILE=1 && VIRTUAL=1
543 [ "$_opt_vmsize" ]              && VMSIZE=$_opt_vmsize
544 [ "$_opt_mntpoint" ]            && MNTPOINT=$_opt_mntpoint
545 [ "$_opt_debopt" ]              && DEBOOTSTRAP_OPT=$_opt_debopt
546 [ "$_opt_interactive" ]         && INTERACTIVE=1
547 [ "$_opt_config" ]              && CONFIGFILE=$_opt_config
548 [ "$_opt_filesystem" ]          && MKFS="mkfs.$_opt_filesystem"
549 [ "$_opt_packages_set" ]        && PACKAGES='yes'
550 [ "$_opt_nopackages" ]          && PACKAGES=''
551 [ "$_opt_debconf_set" ]         && DEBCONF='yes'
552 [ "$_opt_post_scripts_set" ]    && POST_SCRIPTS='yes'
553 [ "$_opt_pre_scripts_set" ]     && PRE_SCRIPTS='yes'
554 [ "$_opt_chroot_scripts_set" ]  && CHROOT_SCRIPTS='yes'
555 [ "$_opt_keep_src_list" ]       && KEEP_SRC_LIST='yes'
556 [ "$_opt_grmlrepos" ]           && GRMLREPOS='yes'
557 [ "$_opt_backportrepos" ]       && BACKPORTREPOS='yes'
558 [ "$_opt_hostname" ]            && HOSTNAME=$_opt_hostname
559 [ "$_opt_password" ]            && ROOTPASSWORD=$_opt_password
560 [ "$_opt_nopassword" ]          && NOPASSWORD='yes'
561 [ "$_opt_defaultinterfaces" ]   && USE_DEFAULT_INTERFACES="true"
562 [ "$_opt_nointerfaces" ]        && NOINTERFACES="true"
563 [ "$_opt_nokernel" ]            && NOKERNEL="true"
564 [ "$_opt_sshcopyid" ]           && SSHCOPYID="true"
565 [ "$_opt_bootappend" ]          && BOOT_APPEND=$_opt_bootappend
566 [ "$_opt_grub" ]                && GRUB=$_opt_grub
567 [ "$_opt_efi" ]                 && EFI=$_opt_efi
568 [ "$_opt_arch" ]                && ARCH=$_opt_arch
569 [ "$_opt_insecure" ]            && echo "Warning: --insecure is deprecated, continuing anyway."
570 [ "$_opt_force" ]               && FORCE=$_opt_force
571 [ "$_opt_verbose" ]             && VERBOSE="-v"
572 [ "$_opt_debug" ]               && DEBUG="true"
573 [ "$_opt_remove_configs" ]      && REMOVE_CONFIGS="yes"
574
575 # make sure main is always included
576 [ -z "$COMPONENTS" ]            && COMPONENTS="main"
577 [ "$_opt_contrib" ]             && COMPONENTS="$COMPONENTS contrib"
578 [ "$_opt_non_free" ]            && COMPONENTS="$COMPONENTS non-free"
579
580 # variable checks
581 if [ -n "${LOCALES:-}" ] ; then
582   ewarn "Deprecation NOTE: LOCALES handling is deprecated, please customize locale handling via post scripts instead."
583 fi
584
585 if [ -n "${DEFAULT_LOCALES:-}" ] ; then
586   ewarn "Deprecation NOTE: DEFAULT_LOCALES handling is deprecated, please customize locale handling via post scripts instead."
587 fi
588
589 if [ -n "${DEFAULT_DEFAULT_LANGUAGE:-}" ] ; then
590   ewarn "Deprecation NOTE: DEFAULT_DEFAULT_LANGUAGE handling is deprecated, please customize locale handling via post scripts instead."
591 fi
592
593 if [ -r "${CONFFILES:-}"/locale.gen ] ; then
594   ewarn "Deprecation NOTE: ${CONFFILES}/locale.gen handling is deprecated, please customize locale handling via post scripts instead."
595 fi
596
597 # command line option checks
598 if [ "$_opt_scripts_set" ] ; then
599   ewarn "Deprecation NOTE: --scripts option is deprecated, please switch to --post-scripts instead."
600   SCRIPTS='yes' # deprecated since grml-debootstrap >=0.71
601 fi
602
603 if [ "$_opt_grub" ] && [ "$_opt_vmfile" ] ; then
604   eerror "The --grub option is incompatible with --vmfile, please drop it from your command line."
605   eerror "The --grub option is unneeded as GRUB will be installed automatically."
606   eend 1
607   bailout 1
608 fi
609
610 if [ -n "$ISO" ] && [[ "$DEBOOTSTRAP" =~ mmdebstrap$ ]] ; then
611   eerror "The ISO option is incompatible with usage of mmdebstrap for bootstrapping."
612   eerror "Either drop the --iso ... option or use plain debootstrap instead."
613   eend 1
614   bailout 1
615 fi
616
617 if [ "$DEBUG" = "true" ] ; then
618   set -x
619 fi
620
621 [ "$_opt_help" ] && {
622   usage ; eend 0
623   eend 0
624   exit 0
625 }
626
627 [ "$_opt_version" ] && {
628   einfo "$PN - version $VERSION"
629   einfo "Report bugs via https://github.com/grml/grml-debootstrap/ or https://grml.org/bugs/"
630   eend 0
631   exit 0
632 }
633 # }}}
634
635 # check for root permissions {{{
636 if ! check4root ; then
637    echo "For usage instructions please execute '$PN --help'."
638    bailout 1
639 fi
640 # }}}
641
642 # make sure we have what we need {{{
643 if [ -n "$VIRTUAL" ] ; then
644   check4progs kpartx parted qemu-img || bailout 1
645 fi
646 # }}}
647
648 # source specified configuration file {{{
649 if [ -n "$CONFIGFILE" ] ; then
650   einfo "Reading specified config file $CONFIGFILE."
651   # shellcheck disable=SC1091 source=config
652   if ! . "$CONFIGFILE" ; then
653     eerror "Error reading config file $CONFIGFILE" ; eend 1 ; bailout 1
654   fi
655 fi
656 # }}}
657
658 # backwards compatibility checks {{{
659 if [ -n "$GROOT" ] ; then
660    eerror "Error: you seem to have \$GROOT configured."
661    eerror "This variable is no longer supported, please visit the"
662    eerror "grml-debootstrap documentation for details."
663    eend 1
664    bailout 1
665 fi
666
667 if echo "$GRUB" | grep -q '^hd' ; then
668    eerror "Error: this syntax for the grub configuration variable is no longer supported."
669    eerror "Please do not use hd... any longer but /dev/sdX instead."
670    eend 1
671    bailout 1
672 fi
673 # }}}
674
675 # welcome screen {{{
676 welcome_dialog()
677 {
678    dialog --title "$PN" --yesno "Welcome to the interactive configuration of ${PN}.
679 Do you want to continue installing Debian using this frontend?" 0 0 || bailout 0
680 }
681 # }}}
682
683 # ask for target {{{
684 prompt_for_target()
685 {
686   AVAILABLE_PARTITIONS=$(LANG=C fdisk -l 2>/dev/null | \
687                sed 's/*//' | \
688                grep -v 'Extended$' | \
689                gawk -v num=0 -v ORS=' ' '/^\/dev\// {print $1}'; ls /dev/md[0-9]* 2>/dev/null || true);
690
691   if [ -z "$AVAILABLE_PARTITIONS" ] ; then
692      dialog --title "$PN" --trim \
693      --msgbox "Sorry, no partitions found. Please configure your
694      harddisks (see /proc/partitions) using a tool like fdisk,
695      cfdisk, gpart, gparted,..." 0 0
696      bailout 1
697   fi
698
699   PARTITION_LIST=$(for i in $AVAILABLE_PARTITIONS ; do
700                      fs="$(blkid -s TYPE -o value "$i" 2>/dev/null)"
701                      [ -n "$fs" ] || fs='[no_filesystem_yet]'
702                      echo "$i" "$fs"
703                      unset fs
704                    done)
705
706   # shellcheck disable=SC2086
707   TARGET=$(dialog --title "$PN" --single-quoted --stdout \
708          --menu "Please select the target partition:" 0 0 0 \
709          $PARTITION_LIST)
710   [ $? -eq 0 ] || bailout 1
711 }
712 # }}}
713
714 # ask for bootmanager {{{
715 prompt_for_bootmanager()
716 {
717   ADDITIONAL_PARAMS=""
718
719   if echo "$TARGET" | grep -q "/dev/md" ; then
720      MBRPART="all disks of Software RAID $TARGET"
721   else
722      # figure out whole disk device
723      found=
724      for device in /dev/disk/by-id/*
725      do
726         [ "$(readlink -f "$device")" = "${TARGET}" ] || continue
727         found=1
728         break
729      done
730      # shellcheck disable=SC2001
731      [ -n "$found" ] && MBRDISK=$(echo "${device}" | sed -e 's/-part[0-9][0-9]*$//')
732      if [ -e "$MBRDISK" ]; then
733         MBRDISK=$(readlink -f "$MBRDISK")
734      else
735         # fall back to old behaviour
736         # shellcheck disable=SC2001
737         MBRDISK=$(echo "${TARGET}" | sed -e 's/[0-9][0-9]*$//')
738      fi
739
740      MBRPART="MBR of $MBRDISK"
741   fi
742
743   for device in cciss/c0d0 sda hda; do
744     if [ "/dev/$device" != "${MBRDISK}" ]; then
745       grep -q $device /proc/partitions && \
746       ADDITIONAL_PARAMS="$ADDITIONAL_PARAMS:$device:install bootmanager grub into MBR of /dev/$device"
747     fi
748   done
749   ADDITIONAL_PARAMS=${ADDITIONAL_PARAMS#:}
750
751   OIFS="$IFS"; IFS=:
752
753   # shellcheck disable=SC2086
754   GETMBR=$(dialog --stdout --title "$PN" --default-item mbr \
755           --menu "Where do you want to install the bootmanager grub?" 0 0 0 \
756             mbr       "install bootmanager into $MBRPART" \
757             nowhere   "do not install bootmanager at all" \
758           ${ADDITIONAL_PARAMS})
759   [ $? -eq 0 ] || bailout 3
760   IFS="$OIFS"
761
762   case "$GETMBR" in
763     mbr)
764       # /dev/md0: has to be installed in MBR of /dev/md0 and not in /dev/md:
765       if echo "$TARGET" | grep -q "/dev/md" ; then
766         GRUB="$TARGET"
767       else
768         GRUB="$MBRDISK"
769       fi
770       ;;
771     hda)
772       GRUB="/dev/hda"
773       ;;
774     sda)
775       GRUB="/dev/sda"
776       ;;
777     nowhere)
778       GRUB=''
779       ;;
780   esac
781 }
782 # }}}
783
784 # ask for Debian release {{{
785 prompt_for_release()
786 {
787   [ -n "$RELEASE" ] && DEFAULT_RELEASE="$RELEASE" || DEFAULT_RELEASE='buster'
788   RELEASE="$(dialog --stdout --title "${PN}" --default-item $DEFAULT_RELEASE --menu \
789             "Please enter the Debian release you would like to use for installation:" \
790             0 50 8 \
791             lenny    Debian/5.0 \
792             squeeze  Debian/6.0 \
793             wheezy   Debian/7.0 \
794             jessie   Debian/8.0 \
795             stretch  Debian/9.0 \
796             buster   Debian/10.0 \
797             bullseye Debian/11.0 \
798             sid      Debian/unstable)"
799   [ $? -eq 0 ] || bailout
800 }
801 # }}}
802
803 # ask for hostname {{{
804 prompt_for_hostname()
805 {
806   HOSTNAME="$(dialog --stdout --title "${PN}" --inputbox \
807             "Please enter the hostname you would like to use for installation:" \
808             0 0 "$HOSTNAME")"
809   [ $? -eq 0 ] || bailout
810 }
811 # }}}
812
813 # ask for password {{{
814 prompt_for_password()
815 {
816   if [ "$_opt_nopassword" ] ; then
817     einfo "Skip asking for root password as requested."
818     return 0
819   fi
820
821   ROOTPW1='PW1'
822   ROOTPW2='PW2'
823   while [ "$ROOTPW1" != "$ROOTPW2" ]; do
824     ROOTPW1=$(dialog --insecure --stdout --title "${PN}" --passwordbox \
825     "Please enter the password for the root account:" 10 60)
826     [ $? -eq 0 ] || bailout
827
828     ROOTPW2=$(dialog --insecure --stdout --title "${PN}" --passwordbox \
829     "Please enter the password for the root account again for \
830     confirmation:" 10 60)
831     [ $? -eq 0 ] || bailout
832
833     if [ "$ROOTPW1" != "$ROOTPW2" ]; then
834       dialog --stdout --title "${PN}" --ok-label \
835         "Retry" --msgbox "Passwords do not match!" 10 60
836     fi
837   done
838   ROOTPASSWORD="$ROOTPW1"
839 }
840 # }}}
841
842 # ask for Debian mirror {{{
843 prompt_for_mirror()
844 {
845   [ -n "$ISO" ] && DEFAULT_MIRROR='local' || DEFAULT_MIRROR='net'
846
847   CHOOSE_MIRROR=$(dialog --stdout --title "$PN" --default-item $DEFAULT_MIRROR \
848           --menu "Where do you want to install from?" 0 0 0 \
849             net   "install via network (downloading from mirror)" \
850             local "install from local directory/mirror"
851           )
852   [ $? -eq 0 ] || bailout
853
854   if [ "$CHOOSE_MIRROR" = 'net' ] ; then
855      [ -n "$MIRROR" ] || MIRROR='http://deb.debian.org/debian'
856      MIRROR="$(dialog --stdout --title "${PN}" --inputbox \
857                "Please enter Debian mirror you would like to use for installing packages." \
858                0 0 $MIRROR)"
859      [ $? -eq 0 ] || bailout
860   else # CHOOSE_MIRROR == local
861      [ -n "$ISO" ] || ISO='/mnt/mirror'
862      ISO="$(dialog --stdout --title "${PN}" --inputbox \
863                "Please enter directory name you would like to use for installing packages." \
864                0 0 $ISO)"
865      [ $? -eq 0 ] || bailout
866   fi
867 }
868 # }}}
869
870 # software raid setup {{{
871 config_swraid_setup()
872 {
873 TMPFILE=$(mktemp)
874
875 # Currently we support only raid1:
876 RAIDLEVEL='raid1'
877
878 MD_LIST=$(for i in $(seq 0 9) ; do
879             awk '{print $4}' /proc/partitions | grep -q "md$i" || \
880             echo "/dev/md$i /dev/md$i"
881           done)
882
883 # shellcheck disable=SC2086
884 TARGET=$(dialog --stdout --title "$PN" --default-item /dev/md0 \
885 --menu "Which device do you want to use for ${RAIDLEVEL}?
886
887 Notice: activated devices will not be listed for security reasons. Anyway, please make sure the selected device is not in use already!" 0 0 0 \
888 $MD_LIST)
889 [ $? -eq 0 ] || bailout 20
890
891 AVAILABLE_PARTITIONS=$(LANG=C fdisk -l 2>/dev/null | \
892              sed 's/*//' | \
893              grep -v 'Extended$' | \
894              gawk -v num=0 -v ORS=' ' '/^\/dev\// {print $1}')
895 [ -n "$AVAILABLE_PARTITIONS" ] || echo "Fatal error: no partitions available?"
896 PARTITION_LIST=$(for i in $AVAILABLE_PARTITIONS ; do
897                      echo "$i $(blkid -s TYPE -o value "$i" 2>/dev/null || echo '[no_filesystem_yet]') off"
898                  done)
899
900 # shellcheck disable=SC2086
901 dialog --title "$PN" --separate-output \
902        --checklist "Please select the partitions you would like to use for your $RAIDLEVEL on ${TARGET}:" 0 0 0 \
903        $PARTITION_LIST 2>"$TMPFILE"
904 [ $? -eq 0 ] || bailout
905 SELECTED_PARTITIONS="$(cat "$TMPFILE")"
906
907 NUM_PARTITIONS=0
908 while IFS= read -r i; do
909   NUM_PARTITIONS=$(( NUM_PARTITIONS + 1 ))
910 done < "$TMPFILE"
911
912 # force metadata version 0.90 for lenny so old grub can boot from this array.
913 METADATA_VERSION=""
914 if [ "$RELEASE" = "lenny" ]; then
915    METADATA_VERSION="-e0"
916 fi
917
918 ERRORFILE=$(mktemp)
919 # shellcheck disable=SC2086
920 yes | mdadm --create "${TARGET}" --level="${RAIDLEVEL}" \
921       --raid-devices="${NUM_PARTITIONS}" ${METADATA_VERSION} ${SELECTED_PARTITIONS} >/dev/null 2>$ERRORFILE
922 RC=$?
923 if [ "$RC" = 0 ] ; then
924    dialog --title "$PN" --msgbox \
925    "Creating $TARGET was successful." 0 0
926    rm -f "$TMPFILE" "$ERRORFILE"
927 else
928    dialog --title "$PN" --msgbox \
929    "There was an error setting up $TARGET:
930
931 $(cat "$ERRORFILE")
932
933 Exiting." 0 0
934    rm -f "$TMPFILE" "$ERRORFILE"
935    bailout 1
936 fi
937
938 }
939
940 prompt_for_swraid()
941 {
942 if dialog --stdout --title "$PN" \
943           --defaultno --yesno "Do you want to configure Software RAID?
944
945 Please notice that only RAID level 1 is supported by ${PN} currently. Configuration will take place using mdadm." 0 0 ; then
946   config_swraid_setup
947 fi
948 }
949 # }}}
950
951 # user should recheck his configuration {{{
952 # support full automatic installation:
953 checkforrun() {
954    dialog --timeout 10 --title "$PN" \
955           --yesno "Do you want to stop at this stage?
956
957 Notice: you are running ${PN} in non-interactive mode.
958 ${PN} will install Debian ${RELEASE} on ${TARGET}.
959 Last chance to quit. Timeout of 10 seconds running....
960
961 Do you want to stop now?" 0 0 2>/dev/null
962 }
963 # }}}
964
965 # format efi partition {{{
966 format_efi_partition() {
967   if [ -z "$EFI" ] ; then
968     return 0
969   fi
970
971   if ! [ -b "$EFI" ] ; then
972     eerror "Specified efi argument [$EFI] not a valid block device."
973     bailout 1
974   fi
975
976   if fsck.vfat -bn "$EFI" >/dev/null; then
977     einfo "EFI partition $EFI seems to have a FAT filesystem, not modifying." ; eend 0
978   else
979     einfo "EFI partition $EFI doesn't seem to be formatted, creating filesystem."
980     mkfs.fat -F32 -n "EFI System Partition" "$EFI"
981     RC=$?
982     if [ $RC -eq 0 ] ; then
983       eend 0
984     else
985       eerror "Error while creating filesystem on ${EFI}."
986       eend 1
987       bailout 1
988     fi
989   fi
990 }
991 # }}}
992
993 # check for EFI support or try to enable it {{{
994 efi_support() {
995   if lsmod | grep -q efivars ; then
996     einfo "EFI support detected." ; eend 0
997     return 0
998   fi
999
1000   if modprobe efivars &>/dev/null ; then
1001     einfo "EFI support enabled now." ; eend 0
1002     return 0
1003   fi
1004
1005   return 1
1006 }
1007 # }}}
1008
1009 # make sure the user is aware of the used configuration {{{
1010 checkconfiguration()
1011 {
1012
1013 if efi_support ; then
1014   if [ -z "$_opt_efi" ] ; then
1015     ewarn "EFI support detected but no --efi option given, please consider enabling it." ; eend 0
1016   fi
1017 else
1018   if [ -n "$_opt_efi" ] ; then
1019      eerror "EFI option used but no EFI support detected." ; eend 0
1020      bailout 1
1021   fi
1022 fi
1023
1024 if [ -n "$AUTOINSTALL" ] ; then
1025    if checkforrun ; then
1026       eerror "Exiting as requested" ; eend 0
1027       bailout 1
1028    fi
1029 elif [ -n "$INTERACTIVE" ] ; then
1030
1031    INFOTEXT="Please recheck configuration before execution:
1032    "
1033    [ -n "$TARGET" ]  && INFOTEXT="$INFOTEXT
1034    Target:          $TARGET"
1035    [ -n "$GRUB" ]    && INFOTEXT="$INFOTEXT
1036    Install grub:    $GRUB"
1037    [ -n "$EFI" ]    && INFOTEXT="$INFOTEXT
1038    Install efi:     $EFI"
1039    [ -n "$RELEASE" ] && INFOTEXT="$INFOTEXT
1040    Using release:   $RELEASE"
1041    [ -n "$HOSTNAME" ] && INFOTEXT="$INFOTEXT
1042    Using hostname:  $HOSTNAME"
1043    [ -n "$MIRROR" ]  && INFOTEXT="$INFOTEXT
1044    Using mirror:    $MIRROR"
1045    [ -n "$ISO" ]  && INFOTEXT="$INFOTEXT
1046    Using ISO:       $ISO"
1047    [ -n "$ARCH" ]  && INFOTEXT="$INFOTEXT
1048    Using arch:      $ARCH"
1049    [ -n "$CONFFILES" ] && INFOTEXT="$INFOTEXT
1050    Config files:    $CONFFILES"
1051
1052    INFOTEXT="$INFOTEXT
1053
1054 Is this ok for you? Notice: selecting 'No' will exit ${PN}."
1055
1056    dialog --title "$PN" --no-collapse \
1057           --yesno "$INFOTEXT" 0 0
1058    [ $? -eq 0 ] || bailout 0
1059
1060 else # if not running automatic installation display configuration and prompt for execution:
1061    einfo "$PN [${VERSION}] - Please recheck configuration before execution:"
1062    echo
1063    echo "   Target:          $TARGET"
1064
1065    # do not display if MNTPOINT is the default one
1066    case "$MNTPOINT" in /mnt/debootstrap*) ;; *) echo "   Mount point:     $MNTPOINT" ;; esac
1067
1068    if [ -n "$VIRTUAL" ] ; then
1069       echo "   Install grub:    yes"
1070    else
1071      [ -n "$GRUB" ]     && echo "   Install grub:    $GRUB" || echo "   Install grub:    no"
1072      [ -n "$EFI" ]      && echo "   Install efi:     $EFI"  || echo "   Install efi:     no"
1073    fi
1074
1075    [ -n "$RELEASE" ]   && echo "   Using release:   $RELEASE"
1076    [ -n "$HOSTNAME" ]  && echo "   Using hostname:  $HOSTNAME"
1077    [ -n "$MIRROR" ]    && echo "   Using mirror:    $MIRROR"
1078    [ -n "$ISO" ]       && echo "   Using ISO:       $ISO"
1079    [ -n "$ARCH" ]      && echo "   Using arch:      $ARCH"
1080    [ -n "$CONFFILES" ] && echo "   Config files:    $CONFFILES"
1081    if [ -n "$VIRTUAL" ] ; then
1082       echo "   Deploying as Virtual Machine."
1083       if [ -n "$VMSIZE" ] && [ -n "$VMFILE" ]; then
1084          echo "   Using Virtual Disk file with size of ${VMSIZE}."
1085       fi
1086    fi
1087
1088    if [ ! -t 0 ] && [ -z "$ROOTPASSWORD" ] && [ -z "$NOPASSWORD" ] ; then
1089       echo
1090       echo "   You do not have a TTY allocated, your password will be shown in"
1091       echo "   plaintext on the terminal! If you are using SSH, try its -t option!"
1092    fi
1093
1094    echo
1095    echo "   Important! Continuing will delete all data from ${TARGET}!"
1096
1097    if [ -n "$FORCE" ] ; then
1098      einfo "Skip user acknowledgement as requested via --force option."
1099    else
1100      echo
1101      einfon "Is this ok for you? [y/N] "
1102      read -r a
1103      if ! [ "$a" = 'y' ] || [ "$a" = 'Y' ] ; then
1104         eerror "Exiting as requested." ; eend 1
1105         bailout 1
1106      fi
1107    fi
1108 fi
1109 }
1110 # }}}
1111
1112 # interactive mode {{{
1113 interactive_mode()
1114 {
1115   check4progs dialog || bailout 1
1116
1117   welcome_dialog
1118
1119   prompt_for_release
1120
1121   prompt_for_swraid
1122
1123   prompt_for_target
1124
1125   prompt_for_bootmanager
1126
1127   prompt_for_hostname
1128
1129   prompt_for_password
1130
1131   prompt_for_mirror
1132 }
1133
1134 # run interactive mode if we didn't get the according configuration yet
1135 if [ -z "$TARGET" ] || [ -n "$INTERACTIVE" ] ; then
1136    # only target might be unset, so make sure the INTERACTIVE flag is set as well
1137    INTERACTIVE=1
1138    interactive_mode
1139 fi
1140 # }}}
1141
1142 # architecture setup {{{
1143 if [ -n "$ARCH" ] ; then
1144    ARCHCMD="--arch $ARCH"
1145    ARCHINFO=" (${ARCH})"
1146 else
1147    ARCH="$(dpkg --print-architecture)"
1148    ARCHCMD="--arch $ARCH"
1149    ARCHINFO=" (${ARCH})"
1150 fi
1151 # }}}
1152
1153 # It is not possible to build amd64 on i686. {{{
1154 CURRENT_ARCH="$(uname -m)"
1155 if [ "$CURRENT_ARCH" != "x86_64" ] ; then
1156    if [ "$ARCH" = "amd64" ] ; then
1157       eerror "It is not possible to build amd64 on $CURRENT_ARCH. Consider installing and booting the 'linux-image-amd64' kernel or using '--arch i386' instead." ; eend 1
1158       bailout 1
1159    fi
1160 fi
1161 # }}}
1162
1163 # Support for generic release codenames is unavailable. {{{
1164 if [ "$RELEASE" = "stable" ] || [ "$RELEASE" = "testing" ] ; then
1165    eerror "Generic release codenames (stable, testing) are unsupported. \
1166 Please use specific codenames such as stretch or buster." ; eend 1
1167    bailout 1
1168 fi
1169 # }}}
1170
1171 checkconfiguration
1172
1173 # finally make sure at least $TARGET is set [the partition for the new system] {{{
1174 if [ -n "$TARGET" ] ; then
1175    SHORT_TARGET="${TARGET##*/}"
1176 else
1177    eerror "Please adjust $CONFFILES/config or..."
1178    eerror "... use the interactive version for configuration before running ${0}" ; eend 1
1179    bailout 1
1180 fi
1181 # }}}
1182
1183 # stages setup {{{
1184 if [ -z "$STAGES" ] ; then
1185    STAGES="/var/cache/grml-debootstrap/stages_${SHORT_TARGET}"
1186    [ -d "$STAGES" ] || mkdir -p "$STAGES"
1187 fi
1188
1189 if [ -r "$STAGES"/grml-debootstrap ] ; then
1190    if grep -q 'done' "${STAGES}/grml-debootstrap" ; then
1191       eerror "Error: grml-debootstrap has been executed already, won't continue therefore."
1192       eerror "If you want to re-execute grml-debootstrap just manually remove ${STAGES}" ; eend 1
1193    fi
1194 fi
1195 # }}}
1196
1197 # partition handling {{{
1198 PARTITION=''
1199 DIRECTORY=''
1200
1201 set_target_directory(){
1202     # assume we are installing into a directory, don't run mkfs and grub related stuff therefore
1203     DIRECTORY=1
1204     MNTPOINT="$TARGET"
1205     MKFS=''
1206     TUNE2FS=''
1207     FSCK=''
1208     # make sure we normalise the path to an absolute directory name so something like:
1209     #  mkdir -p foo/a bar/a; (cd foo; grml-debootstrap -t a)&; (cd bar; grml-debootstrap -t a)&; wait
1210     # works
1211     TARGET="$(readlink -f "$TARGET")"
1212 }
1213
1214 if [ -b "$TARGET" ] || [ -n "$VIRTUAL" ] ; then
1215     PARTITION=1
1216 else
1217     # $TARGET was not detected as block device, but we do not want to create target directory in /dev/
1218     if [[ $TARGET == "/dev/"* ]]; then
1219       eerror "Error: Will not create target directory $TARGET in /dev."
1220       eerror "  Please check the partition(s) of the blockdevice."; eend 1
1221       bailout 1
1222     fi
1223     set_target_directory
1224 fi
1225 # }}}
1226
1227 # make sure we have the right syntax when using an iso image {{{
1228 if [ -n "$ISO" ] ; then
1229    case $ISO in
1230       file*) # do nothing
1231       ;;
1232       *)
1233       ISO=file:$ISO
1234       ;;
1235    esac
1236 fi
1237 ISODIR=${ISO##file:}
1238 ISODIR=${ISODIR%%/}
1239 # }}}
1240
1241 # Debian ISOs do not contain signed Release files {{{
1242 if [ -n "$ISO" ] ; then
1243     DEBOOTSTRAP_OPT="$DEBOOTSTRAP_OPT --no-check-gpg"
1244 fi
1245 # }}}
1246
1247 # create filesystem {{{
1248 mkfs() {
1249   if [ -n "$DIRECTORY" ] ; then
1250      einfo "Running grml-debootstrap on a directory, skipping mkfs stage."
1251      return 0
1252   fi
1253
1254   if grep -q "$TARGET" /proc/mounts ; then
1255     eerror "$TARGET already mounted, exiting to avoid possible damage. (Manually unmount $TARGET)" ; eend 1
1256     bailout 1
1257   fi
1258
1259   # mkfs.ext* might prompt with "/dev/sdX# contains a ext* file system
1260   # created on ... Proceed anyway? (y,n)" which we want to skip in force mode
1261   if [ -n "$MKFS" ] && [ -n "$FORCE" ] ; then
1262     case "$MKFS" in
1263       mkfs.ext*)
1264         einfo "Enabling force option (-F) for mkfs.ext* tool as requested via --force switch."
1265         MKFS_OPTS="$MKFS_OPTS -F"
1266         eend 0
1267
1268         ;;
1269     esac
1270   fi
1271
1272   # starting with e2fsprogs 1.43~WIP.2015.05.18-1 mkfs.ext4 enables the metadata_csum feature
1273   # by default, which requires a recent version of tune2fs on the target system then,
1274   # so disable this feature for older Debian releases where it's known to be unsupported
1275   if [ -n "$MKFS" ] && [ "$MKFS" = "mkfs.ext4" ] ; then
1276     case "$RELEASE" in
1277       lenny|squeeze|wheezy|jessie)
1278         # assume a more recent version if we can't identify the version via dpkg-query
1279         local e2fsprogs_version
1280         e2fsprogs_version="$(dpkg-query --show --showformat='${Version}' e2fsprogs 2>/dev/null || echo 1.44)"
1281         if [ -n "$e2fsprogs_version" ] && dpkg --compare-versions "$e2fsprogs_version" ge '1.43~WIP.2015.05.18-1' ; then
1282           einfo "Disabling metadata_csum feature for $MKFS as $RELEASE doesn't support it."
1283           MKFS_OPTS="$MKFS_OPTS -O ^metadata_csum"
1284           eend 0
1285         fi
1286         ;;
1287     esac
1288   fi
1289
1290   if [ -n "$MKFS" ] ; then
1291     einfo "Running $MKFS $MKFS_OPTS on $TARGET"
1292     # shellcheck disable=SC2086
1293     "$MKFS" $MKFS_OPTS "$TARGET" ; RC=$?
1294
1295     if [ "$FIXED_DISK_IDENTIFIERS" = "yes" ] ; then
1296       if ! echo "$MKFS" | grep -q "mkfs.ext" ; then
1297         eerror "Not changing disk uuid for $TARGET because $MKFS doesn't seem to match for ext{2,3,4} file system"
1298         eend 1
1299         bailout 1
1300       else
1301         einfo "Changing disk uuid for $TARGET to fixed (non-random) value $DISK_IDENTIFIER using tune2fs"
1302         tune2fs "$TARGET" -U "$DISK_IDENTIFIER"
1303         eend $?
1304       fi
1305     fi
1306
1307     # make sure /dev/disk/by-uuid/... is up2date, otherwise grub
1308     # will fail to detect the uuid in the chroot
1309     if [ -n "$VIRTUAL" ] ; then
1310       einfo "Virtual environment doesn't require blockdev --rereadpt, skipping therefore"
1311     elif echo "$TARGET" | grep -q "/dev/md" ; then
1312       blockdev --rereadpt "${TARGET}"
1313     else
1314       # if we deploy to /dev/sdX# then let's see if /dev/sdX exists
1315       local main_device="${TARGET%%[0-9]*}"
1316       # sanity check to not try to e.g. access /dev/loop if we get /dev/loop0
1317       if [ -f "/sys/block/$(basename "${main_device}")/$(basename "${TARGET}")/dev" ] ; then
1318         blockdev --rereadpt "$main_device"
1319       else
1320         einfo "No underlying block device for $TARGET identified, skipping blockdev --rereadpt."
1321       fi
1322     fi
1323     # give the system 2 seconds, otherwise we might run into
1324     # race conditions :-/
1325     sleep 2
1326
1327     eend $RC
1328   fi
1329 }
1330 # }}}
1331
1332 # retrieve ID_FS_UUID {{{
1333 identify_target_uuid() {
1334   local device="$1"
1335
1336   if ! [ -b "$device" ] ; then
1337     return 1
1338   fi
1339
1340   eval "$(blkid -o udev "$1" 2>/dev/null)"
1341
1342   if [ -n "$ID_FS_UUID" ] ; then
1343     echo "$ID_FS_UUID"
1344   else
1345     return 1
1346   fi
1347 }
1348 # }}}
1349
1350 # identify TARGET_UUID {{{
1351 mountpoint_to_blockdevice() {
1352   TARGET_UUID=''
1353
1354   TARGET_UUID=$(identify_target_uuid "$TARGET" 2>/dev/null || true)
1355   if [ -n "$TARGET_UUID" ] ; then
1356     einfo "Identified UUID $TARGET_UUID for $TARGET"
1357     return 0
1358   fi
1359
1360   # $TARGET might be a mountpoint and not a blockdevice, search for according entry
1361   for file in /sys/block/*/*/dev ; do
1362     if grep -q "^$(mountpoint -d "${TARGET}")$" "$file" ; then
1363       local dev
1364       dev="${file%/dev}"
1365       dev="/dev/${dev##*/}"
1366       TARGET_UUID=$(identify_target_uuid "$dev" 2>/dev/null || true)
1367
1368       if [ -n "$TARGET_UUID" ] ; then
1369         einfo "Identified UUID $TARGET_UUID for $TARGET (via $file)"
1370         return 0
1371       fi
1372     fi
1373   done
1374 }
1375 # }}}
1376
1377 # modify filesystem settings {{{
1378 tunefs() {
1379   if [ -n "$TUNE2FS" ] && echo "$MKFS" | grep -q "mkfs.ext" ; then
1380      einfo "Disabling automatic filesystem check on $TARGET via tune2fs"
1381      $TUNE2FS "$TARGET"
1382      eend $?
1383   fi
1384 }
1385 # }}}
1386
1387 # mount the new partition or if it's a directory do nothing at all {{{
1388 mount_target() {
1389   if [ -n "$DIRECTORY" ] ; then
1390      einfo "Running grml-debootstrap on a directory, nothing to mount."
1391   else
1392      if grep -q "$TARGET" /proc/mounts ; then
1393         ewarn "$TARGET already mounted, continuing anyway." ; eend 0
1394      else
1395        if ! [ -d "${MNTPOINT}" ] ; then
1396           [ -n "$VIRTUAL" ] || mkdir -p "${MNTPOINT}"
1397        fi
1398        einfo "Mounting $TARGET to $MNTPOINT"
1399        mkdir -p "$MNTPOINT"
1400        mount -o rw,suid,dev "$TARGET" "$MNTPOINT"
1401        eend $?
1402      fi
1403   fi
1404   if [ -n "$ISODIR" ] ; then
1405      einfo "Mounting Debian image loopback to $MNTPOINT/$ISODIR."
1406      mkdir -p "$MNTPOINT/$ISODIR"
1407      mount --bind "$ISODIR" "$MNTPOINT/$ISODIR"
1408      eend $?
1409   fi
1410 }
1411 # }}}
1412
1413 # prepare VM image for usage with debootstrap {{{
1414 prepare_vm() {
1415   if [ -z "$VIRTUAL" ] ; then
1416      return 0 # be quiet by intention
1417   fi
1418
1419   if [ -b "$TARGET" ] && [ -n "$VMFILE" ] ; then
1420      eerror "Error: specified virtual disk target ($TARGET) is an existing block device."
1421      eend 1
1422      bailout 1
1423   fi
1424   if [ ! -b "$TARGET" ] && [ -z "$VMFILE" ] ; then
1425      eerror "Error: specified virtual disk target ($TARGET) does not exist yet."
1426      eend 1
1427      bailout 1
1428   fi
1429
1430   # make sure loop module is present and a usable loop device exists
1431   modprobe -q loop
1432   if ! losetup -f >/dev/null 2>&1; then
1433     eerror "Error finding usable loop device" ; eend 1
1434     bailout 1
1435   fi
1436
1437   # if dm-mod isn't available then kpartx will fail with
1438   # "Is device-mapper driver missing from kernel? [...]"
1439   modprobe -q dm-mod
1440   if ! grep -q 'device-mapper' /proc/misc >/dev/null 2>&1 ; then
1441     eerror "Device-mapper support missing in kernel." ; eend 1
1442     bailout 1
1443   fi
1444
1445   ORIG_TARGET="$TARGET" # store for later reuse
1446
1447   if [ -n "$VMFILE" ]; then
1448     qemu-img create -f raw "${TARGET}" "${VMSIZE}"
1449   fi
1450   parted -s "${TARGET}" 'mklabel msdos'
1451   if [ "$FIXED_DISK_IDENTIFIERS" = "yes" ] ; then
1452     einfo "Adjusting disk signature to a fixed (non-random) value"
1453     MBRTMPFILE=$(mktemp)
1454     dd if="${TARGET}" of="${MBRTMPFILE}" bs=512 count=1
1455     echo -en "\\x41\\x41\\x41\\x41" | dd of="${MBRTMPFILE}" conv=notrunc seek=440 bs=1
1456     dd if="${MBRTMPFILE}" of="${TARGET}" conv=notrunc
1457     eend $?
1458   fi
1459   parted -s "${TARGET}" 'mkpart primary ext4 2M -1'
1460   parted -s "${TARGET}" 'set 1 boot on'
1461
1462   DEVINFO=$(kpartx -asv "$TARGET") # e.g. 'add map loop0p1 (254:5): 0 20477 linear 7:0 3'
1463   if [ -z "${DEVINFO}" ] ; then
1464     eerror "Error setting up loopback device." ; eend 1
1465     bailout 1
1466   fi
1467
1468   # hopefully this always works as expected
1469   LOOP_PART="${DEVINFO##add map }" # 'loop0p1 (254:5): 0 20477 linear 7:0 3'
1470   LOOP_PART="${LOOP_PART// */}"    # 'loop0p1'
1471   LOOP_DISK="${LOOP_PART%p*}"      # 'loop0'
1472   export TARGET="/dev/mapper/$LOOP_PART" # '/dev/mapper/loop1p1'
1473
1474   if [ -z "$TARGET" ] ; then
1475      eerror "Error: target could not be set to according /dev/mapper/* device." ; eend 1
1476      bailout 1
1477   fi
1478 }
1479 # }}}
1480
1481 # make VM image bootable {{{
1482 grub_install() {
1483   if [ -z "${VIRTUAL}" ] ; then
1484      return 0
1485   fi
1486   if [ "${GRUB_INSTALL}" != "yes" ] ; then
1487     einfo "Not installing GRUB as requested via \$GRUB_INSTALL=$GRUB_INSTALL"
1488     return 0
1489   fi
1490
1491   if ! mount "${TARGET}" "${MNTPOINT}" ; then
1492     eerror "Error: Mounting ${TARGET} failed, can not continue." ; eend 1
1493     bailout 1
1494   fi
1495
1496   mount -t proc none "${MNTPOINT}"/proc
1497   mount -t sysfs none "${MNTPOINT}"/sys
1498   mount -t devtmpfs udev "${MNTPOINT}"/dev
1499   mount -t devpts devpts "${MNTPOINT}"/dev/pts
1500
1501 # Has chroot-script installed GRUB to MBR using grub-install (successfully), already?
1502 # chroot-script skips installation for unset ${GRUB}
1503 if [[ -z "${GRUB}" ]] || ! dd if="${GRUB}" bs=512 count=1 2>/dev/null | cat -v | grep -Fq GRUB; then
1504   einfo "Installing Grub as bootloader."
1505
1506   if ! chroot "${MNTPOINT}" dpkg --list grub-pc 2>/dev/null | grep -q '^ii' ; then
1507     echo "Notice: grub-pc package not present yet, installing it therefore."
1508     # shellcheck disable=SC2086
1509     DEBIAN_FRONTEND=$DEBIAN_FRONTEND chroot "$MNTPOINT" apt-get -y install $DPKG_OPTIONS grub-pc
1510   fi
1511
1512   mkdir -p "${MNTPOINT}/boot/grub"
1513   if ! [ -d "${MNTPOINT}"/usr/lib/grub/i386-pc/ ] ; then
1514      eerror "Error: grub not installed inside Virtual Machine. Can not install bootloader." ; eend 1
1515      bailout 1
1516   fi
1517
1518   case "$RELEASE" in
1519     lenny|squeeze|wheezy)
1520       cp "${MNTPOINT}"/usr/lib/grub/i386-pc/* "${MNTPOINT}/boot/grub/"
1521       ;;
1522     *)
1523       cp -a "${MNTPOINT}"/usr/lib/grub/i386-pc "${MNTPOINT}/boot/grub/"
1524       ;;
1525   esac
1526   dd if="${MNTPOINT}/usr/lib/grub/i386-pc/boot.img" of="${ORIG_TARGET}" conv=notrunc bs=440 count=1
1527   chroot "${MNTPOINT}" grub-mkimage -O i386-pc -p "(hd0,msdos1)/boot/grub" -o /tmp/core.img biosdisk part_msdos ext2
1528   dd if="${MNTPOINT}/tmp/core.img" of="${ORIG_TARGET}" conv=notrunc seek=1
1529   rm -f "${MNTPOINT}/tmp/core.img"
1530 fi
1531
1532   einfo "Updating grub configuration file."
1533   if [ -n "$BOOT_APPEND" ] ; then
1534      sed -i "/GRUB_CMDLINE_LINUX_DEFAULT/ s#\"\$# ${BOOT_APPEND}\"#" "${MNTPOINT}"/etc/default/grub
1535   fi
1536   chroot "${MNTPOINT}" update-grub
1537
1538   case "$RELEASE" in
1539     jessie)
1540       einfo "Applying workaround for GRUB font path bug in jessie (Debian #787685)."
1541       mkdir -p "${MNTPOINT}/boot/grub/fonts/"
1542       cp "${MNTPOINT}/usr/share/grub/unicode.pf2" "${MNTPOINT}/boot/grub/fonts/"
1543       ;;
1544   esac
1545
1546   if grep -q '^GRUB_DISABLE_LINUX_UUID=.*true' "${MNTPOINT}"/etc/default/grub 2>/dev/null ; then
1547     ewarn "GRUB_DISABLE_LINUX_UUID is set to true in /etc/default/grub, not adjusting root= in grub.cfg."
1548     ewarn "Please note that your system might NOT be able to properly boot."
1549   else
1550     einfo "Adjusting grub.cfg for successful boot sequence."
1551     sed -i "s;root=[^ ]\\+;root=UUID=$TARGET_UUID;" "${MNTPOINT}"/boot/grub/grub.cfg
1552   fi
1553
1554   umount "${MNTPOINT}"/proc
1555   umount "${MNTPOINT}"/sys
1556   umount "${MNTPOINT}"/dev/pts
1557   try_umount 3 "${MNTPOINT}"/dev
1558
1559 }
1560 # }}}
1561
1562 # unmount VM image {{{
1563 umount_target() {
1564   if [ -z "${VIRTUAL}" ] ; then
1565      return 0
1566   fi
1567
1568   umount "${MNTPOINT}"
1569   kpartx -d "${ORIG_TARGET}" >/dev/null
1570   # Workaround for a bug in kpartx which doesn't clean up properly,
1571   # see Debian Bug #891077 and Github-PR grml/grml-debootstrap#112
1572   if dmsetup ls | grep -q "^${LOOP_PART} "; then
1573     kpartx -d "/dev/${LOOP_DISK}" >/dev/null
1574   fi
1575 }
1576 # }}}
1577
1578 # install main chroot {{{
1579 debootstrap_system() {
1580   if [ "$_opt_nodebootstrap" ]; then
1581      einfo "Skipping debootstrap as requested."
1582      return
1583   fi
1584
1585   if grep -q "$MNTPOINT" /proc/mounts || [ -n "$DIRECTORY" ] ; then
1586     :
1587   else
1588     eerror "Error: $MNTPOINT not mounted, can not continue."
1589     eend 1 ; exit 1
1590   fi
1591
1592   if [ -n "$ISO" ] ; then
1593     einfo "Running $DEBOOTSTRAP $DEBOOTSTRAP_OPT for release ${RELEASE}${ARCHINFO} using ${ISO}"
1594     einfo "Executing: $DEBOOTSTRAP $ARCHCMD $KEYRING $DEBOOTSTRAP_OPT $RELEASE $MNTPOINT $ISO"
1595     # shellcheck disable=SC2086
1596     "$DEBOOTSTRAP" $ARCHCMD $KEYRING $DEBOOTSTRAP_OPT "$RELEASE" "$MNTPOINT" "$ISO"
1597     RC=$?
1598   else
1599     einfo "Running $DEBOOTSTRAP $DEBOOTSTRAP_OPT for release ${RELEASE}${ARCHINFO} using ${MIRROR}"
1600     einfo "Executing: $DEBOOTSTRAP $ARCHCMD $KEYRING $DEBOOTSTRAP_OPT $RELEASE $MNTPOINT $MIRROR"
1601     # shellcheck disable=SC2086
1602     "$DEBOOTSTRAP" $ARCHCMD $KEYRING $DEBOOTSTRAP_OPT "$RELEASE" "$MNTPOINT" "$MIRROR"
1603     RC=$?
1604   fi
1605
1606   if [ $RC -ne 0 ] ; then
1607     if [ -r "$MNTPOINT/debootstrap/debootstrap.log" ] && \
1608       [ -s "$MNTPOINT/debootstrap/debootstrap.log" ] ; then
1609       einfo "Presenting last ten lines of debootstrap.log:"
1610       tail -10 "${MNTPOINT}"/debootstrap/debootstrap.log
1611       einfo "End of debootstrap.log"
1612     fi
1613   fi
1614
1615   eend $RC
1616 }
1617 # }}}
1618
1619 # prepare chroot via chroot-script {{{
1620 preparechroot() {
1621   einfo "Preparing chroot system"
1622
1623   # provide variables to chroot system
1624   CHROOT_VARIABLES="/var/cache/grml-debootstrap/variables_${SHORT_TARGET}"
1625   touch "$CHROOT_VARIABLES"
1626   chmod 600 "$CHROOT_VARIABLES" # make sure nobody except root can read it
1627   echo "# Configuration of ${PN}"                                                                                   > "$CHROOT_VARIABLES"
1628   # Resorting to sed(1) for escaping since "VAR='${VAR//\'/\'\\\'\'}'" does not work with all versions of Bash,
1629   #   e.g. not with 4.2.37(1)-release (a.k.a 4.2+dfsg-0.1+deb7u3) of Debian wheezy
1630   [ -n "$ARCH" ]                && echo "ARCH='$(sed "s,','\\\\'',g" <<<"${ARCH}")'"                               >> "$CHROOT_VARIABLES"
1631   [ -n "$BACKPORTREPOS" ]       && echo "BACKPORTREPOS='$(sed "s,','\\\\'',g" <<<"${BACKPORTREPOS}")'"             >> "$CHROOT_VARIABLES"
1632   [ -n "$CHROOT_SCRIPTS" ]      && echo "CHROOT_SCRIPTS='$(sed "s,','\\\\'',g" <<<"${CHROOT_SCRIPTS}")'"           >> "$CHROOT_VARIABLES"
1633   [ -n "$COMPONENTS" ]          && echo "COMPONENTS='$(sed "s,','\\\\'',g" <<<"${COMPONENTS}")'"                   >> "$CHROOT_VARIABLES"
1634   [ -n "$CONFFILES" ]           && echo "CONFFILES='$(sed "s,','\\\\'',g" <<<"${CONFFILES}")'"                     >> "$CHROOT_VARIABLES"
1635   [ -n "$DEBCONF" ]             && echo "DEBCONF='$(sed "s,','\\\\'',g" <<<"${DEBCONF}")'"                         >> "$CHROOT_VARIABLES"
1636   [ -n "$DEBIAN_FRONTEND" ]     && echo "DEBIAN_FRONTEND='$(sed "s,','\\\\'',g" <<<"${DEBIAN_FRONTEND}")'"         >> "$CHROOT_VARIABLES"
1637   [ -n "$DEBOOTSTRAP" ]         && echo "DEBOOTSTRAP='$(sed "s,','\\\\'',g" <<<"${DEBOOTSTRAP}")'"                 >> "$CHROOT_VARIABLES"
1638   [ -n "$EXTRAPACKAGES" ]       && echo "EXTRAPACKAGES='$(sed "s,','\\\\'',g" <<<"${EXTRAPACKAGES}")'"             >> "$CHROOT_VARIABLES"
1639   [ -n "$EFI" ]                 && echo "EFI='$(sed "s,','\\\\'',g" <<<"${EFI}")'"                                 >> "$CHROOT_VARIABLES"
1640   [ -n "$FALLBACK_MIRROR" ]     && echo "FALLBACK_MIRROR='$(sed "s,','\\\\'',g" <<<"${FALLBACK_MIRROR}")'"         >> "$CHROOT_VARIABLES"
1641   [ -n "$FORCE" ]               && echo "FORCE='$(sed "s,','\\\\'',g" <<<"${FORCE}")'"                             >> "$CHROOT_VARIABLES"
1642   [ -n "$GRMLREPOS" ]           && echo "GRMLREPOS='$(sed "s,','\\\\'',g" <<<"${GRMLREPOS}")'"                     >> "$CHROOT_VARIABLES"
1643   [ -n "$GRUB" ]                && echo "GRUB='$(sed "s,','\\\\'',g" <<<"${GRUB}")'"                               >> "$CHROOT_VARIABLES"
1644   [ -n "$HOSTNAME" ]            && echo "HOSTNAME='$(sed "s,','\\\\'',g" <<<"${HOSTNAME}")'"                       >> "$CHROOT_VARIABLES"
1645   [ -n "$INITRD" ]              && echo "INITRD='$(sed "s,','\\\\'',g" <<<"${INITRD}")'"                           >> "$CHROOT_VARIABLES"
1646   [ -n "$INSTALL_NOTES" ]       && echo "INSTALL_NOTES='$(sed "s,','\\\\'',g" <<<"${INSTALL_NOTES}")'"             >> "$CHROOT_VARIABLES"
1647   [ -n "$ISODIR" ]              && echo "ISODIR='$(sed "s,','\\\\'',g" <<<"${ISO}")'"                              >> "$CHROOT_VARIABLES"
1648   [ -n "$ISO" ]                 && echo "ISO='$(sed "s,','\\\\'',g" <<<"${ISO}")'"                                 >> "$CHROOT_VARIABLES"
1649   [ -n "$KEEP_SRC_LIST" ]       && echo "KEEP_SRC_LIST='$(sed "s,','\\\\'',g" <<<"${KEEP_SRC_LIST}")'"             >> "$CHROOT_VARIABLES"
1650   [ -n "$MIRROR" ]              && echo "MIRROR='$(sed "s,','\\\\'',g" <<<"${MIRROR}")'"                           >> "$CHROOT_VARIABLES"
1651   [ -n "$MKFS" ]                && echo "MKFS='$(sed "s,','\\\\'',g" <<<"${MKFS}")'"                               >> "$CHROOT_VARIABLES"
1652   [ -n "$NOPASSWORD" ]          && echo "NOPASSWORD=\"true\""                                                      >> "$CHROOT_VARIABLES"
1653   [ -n "$NOKERNEL" ]            && echo "NOKERNEL=\"true\""                                                        >> "$CHROOT_VARIABLES"
1654   [ -n "$PACKAGES" ]            && echo "PACKAGES='$(sed "s,','\\\\'',g" <<<"${PACKAGES}")'"                       >> "$CHROOT_VARIABLES"
1655   [ -n "$POST_SCRIPTS" ]        && echo "POST_SCRIPTS='$(sed "s,','\\\\'',g" <<<"${POST_SCRIPTS}")'"               >> "$CHROOT_VARIABLES"
1656   [ -n "$PRE_SCRIPTS" ]         && echo "PRE_SCRIPTS='$(sed "s,','\\\\'',g" <<<"${PRE_SCRIPTS}")'"                 >> "$CHROOT_VARIABLES"
1657   [ -n "$RECONFIGURE" ]         && echo "RECONFIGURE='$(sed "s,','\\\\'',g" <<<"${RECONFIGURE}")'"                 >> "$CHROOT_VARIABLES"
1658   [ -n "$RELEASE" ]             && echo "RELEASE='$(sed "s,','\\\\'',g" <<<"${RELEASE}")'"                         >> "$CHROOT_VARIABLES"
1659   [ -n "$RM_APTCACHE" ]         && echo "RM_APTCACHE='$(sed "s,','\\\\'',g" <<<"${RM_APTCACHE}")'"                 >> "$CHROOT_VARIABLES"
1660   [ -n "$ROOTPASSWORD" ]        && echo "ROOTPASSWORD='$(sed "s,','\\\\'',g" <<<"${ROOTPASSWORD}")'"               >> "$CHROOT_VARIABLES"
1661   [ -n "$SCRIPTS" ]             && echo "SCRIPTS='$(sed "s,','\\\\'',g" <<<"${SCRIPTS}")'"                         >> "$CHROOT_VARIABLES"
1662   [ -n "$SECURE" ]              && echo "SECURE='$(sed "s,','\\\\'',g" <<<"${SECURE}")'"                           >> "$CHROOT_VARIABLES"
1663   [ -n "$SELECTED_PARTITIONS" ] && echo "SELECTED_PARTITIONS='$(sed "s,','\\\\'',g" <<<"${SELECTED_PARTITIONS}")'" >> "$CHROOT_VARIABLES"
1664   [ -n "$TARGET" ]              && echo "TARGET='$(sed "s,','\\\\'',g" <<<"${TARGET}")'"                           >> "$CHROOT_VARIABLES"
1665   [ -n "$UPGRADE_SYSTEM" ]      && echo "UPGRADE_SYSTEM='$(sed "s,','\\\\'',g" <<<"${UPGRADE_SYSTEM}")'"           >> "$CHROOT_VARIABLES"
1666   [ -n "$TARGET_UUID" ]         && echo "TARGET_UUID='$(sed "s,','\\\\'',g" <<<"${TARGET_UUID}")'"                 >> "$CHROOT_VARIABLES"
1667   [ -n "$TIMEZONE" ]            && echo "TIMEZONE='$(sed "s,','\\\\'',g" <<<"${TIMEZONE}")'"                       >> "$CHROOT_VARIABLES"
1668   [ -n "$TUNE2FS" ]             && echo "TUNE2FS='$(sed "s,','\\\\'',g" <<<"${TUNE2FS}")'"                         >> "$CHROOT_VARIABLES"
1669   [ -n "$VMSIZE" ]              && echo "VMSIZE='$(sed "s,','\\\\'',g" <<<"${VMSIZE}")'"                           >> "$CHROOT_VARIABLES"
1670
1671   cp $VERBOSE "${CONFFILES}"/chroot-script "${MNTPOINT}"/bin/chroot-script
1672   chmod 755 "${MNTPOINT}"/bin/chroot-script
1673   [ -d "$MNTPOINT"/etc/debootstrap/ ] || mkdir "$MNTPOINT"/etc/debootstrap/
1674
1675   # make sure we have our files for later use via chroot-script
1676   cp $VERBOSE "${CONFFILES}/config"           "${MNTPOINT}"/etc/debootstrap/
1677   # make sure we adjust the configuration variables accordingly:
1678   sed -i "s#RELEASE=.*#RELEASE=\"$RELEASE\"#" "${MNTPOINT}"/etc/debootstrap/config
1679   sed -i "s#TARGET=.*#TARGET=\"$TARGET\"#"    "${MNTPOINT}"/etc/debootstrap/config
1680   sed -i "s#GRUB=.*#GRUB=\"$GRUB\"#"          "${MNTPOINT}"/etc/debootstrap/config
1681
1682   # install notes:
1683   if [ -n "$INSTALL_NOTES" ] ; then
1684      [ -r "$INSTALL_NOTES" ] && cp "$INSTALL_NOTES" "${MNTPOINT}"/etc/debootstrap/
1685   fi
1686
1687   # package selection:
1688   if [ "$PACKAGES" = 'yes' ] ; then
1689     cp $VERBOSE "${_opt_packages:-$CONFFILES/packages}" \
1690       "${MNTPOINT}"/etc/debootstrap/packages
1691   fi
1692
1693   # debconf preseeding:
1694   _opt_debconf=${_opt_debconf:-$CONFFILES/debconf-selections}
1695   [ -f "${_opt_debconf}" ] && [ "$DEBCONF" = 'yes' ] && \
1696     cp $VERBOSE "${_opt_debconf}" "${MNTPOINT}"/etc/debootstrap/debconf-selections
1697
1698   # copy scripts that should be executed inside the chroot:
1699   _opt_chroot_scripts=${_opt_chroot_scripts:-$CONFFILES/chroot-scripts/}
1700   [ -d "$_opt_chroot_scripts" ] && [ "$CHROOT_SCRIPTS" = 'yes' ] && {
1701     mkdir -p "${MNTPOINT}"/etc/debootstrap/chroot-scripts
1702     cp -a $VERBOSE "${_opt_chroot_scripts}"/* "${MNTPOINT}"/etc/debootstrap/chroot-scripts/
1703   }
1704
1705   # notice: do NOT use $CHROOT_VARIABLES inside chroot but statically file instead!
1706   cp $VERBOSE "${CHROOT_VARIABLES}" "${MNTPOINT}"/etc/debootstrap/variables
1707
1708   cp $VERBOSE -a -L "${CONFFILES}"/extrapackages/ "${MNTPOINT}"/etc/debootstrap/
1709
1710   # make sure we can access network [relevant for cdebootstrap/mmdebstrap]
1711   [ -f "${MNTPOINT}"/etc/resolv.conf ] || cp $VERBOSE /etc/resolv.conf "${MNTPOINT}"/etc/resolv.conf
1712
1713   # MAKEDEV is just a forking bomb crap, let's do it on our own instead :)
1714   ( cd "${MNTPOINT}"/dev && tar zxf /etc/debootstrap/devices.tar.gz )
1715
1716   # copy any existing files to chroot
1717   [ -d "${CONFFILES}"/bin   ] && cp $VERBOSE -a -L "${CONFFILES}"/bin/*   "${MNTPOINT}"/bin/
1718   [ -d "${CONFFILES}"/boot  ] && cp $VERBOSE -a -L "${CONFFILES}"/boot/*  "${MNTPOINT}"/boot/
1719   [ -d "${CONFFILES}"/etc   ] && cp $VERBOSE -a -L "${CONFFILES}"/etc/*   "${MNTPOINT}"/etc/
1720   [ -d "${CONFFILES}"/sbin  ] && cp $VERBOSE -a -L "${CONFFILES}"/sbin/*  "${MNTPOINT}"/sbin/
1721   [ -d "${CONFFILES}"/share ] && cp $VERBOSE -a -L "${CONFFILES}"/share/* "${MNTPOINT}"/share/
1722   [ -d "${CONFFILES}"/usr   ] && cp $VERBOSE -a -L "${CONFFILES}"/usr/*   "${MNTPOINT}"/usr/
1723   [ -d "${CONFFILES}"/var   ] && cp $VERBOSE -a -L "${CONFFILES}"/var/*   "${MNTPOINT}"/var/
1724
1725   # network setup
1726   DEFAULT_INTERFACES="# /etc/network/interfaces - generated by grml-debootstrap
1727
1728 # Include files from /etc/network/interfaces.d when using
1729 # ifupdown v0.7.44 or newer:
1730 #source-directory /etc/network/interfaces.d
1731
1732 auto lo
1733 iface lo inet loopback
1734
1735 allow-hotplug eth0
1736 iface eth0 inet dhcp
1737 "
1738
1739   # add dhcp setting for Predictable Network Interface Names
1740   if [ -x /bin/udevadm ]; then
1741     tmpfile=$(mktemp)
1742     for interface in /sys/class/net/*; do
1743       udevadm info --query=all --path="${interface}" > "${tmpfile}"
1744       # skip virtual devices, like bridges, vboxnet,...
1745       if grep -q 'P: /devices/virtual/net/' "${tmpfile}" ; then
1746         continue
1747       fi
1748
1749       # iterate over possible naming policies by precedence (see udev/net/link-config.c),
1750       # use and stop on first match to have same behavior as udev's link_config_apply()
1751       for property in ID_NET_NAME_FROM_DATABASE ID_NET_NAME_ONBOARD ID_NET_NAME_SLOT ID_NET_NAME_PATH ID_NET_NAME_MAC ; do
1752         if grep -q "${property}" "${tmpfile}" ; then
1753           interface=$(grep "${property}" "${tmpfile}" | sed -n -e "s/E: ${property}=\([^\$*]\)/\1/p")
1754           DEFAULT_INTERFACES="${DEFAULT_INTERFACES}
1755 allow-hotplug ${interface}
1756 iface ${interface} inet dhcp
1757 "
1758           break
1759         fi
1760       done
1761     done
1762     rm -f "${tmpfile}"
1763   fi
1764
1765   if [ -n "$NOINTERFACES" ] ; then
1766     einfo "Not installing /etc/network/interfaces as requested via --nointerfaces option" ; eend 0
1767   elif [ -n "$USE_DEFAULT_INTERFACES" ] ; then
1768     einfo "Installing default /etc/network/interfaces as requested via --defaultinterfaces options."
1769     mkdir -p "${MNTPOINT}/etc/network"
1770     echo "$DEFAULT_INTERFACES" > "${MNTPOINT}/etc/network/interfaces"
1771     eend $?
1772   elif [ -n "$VIRTUAL" ] ; then
1773     einfo "Setting up Virtual Machine, installing default /etc/network/interfaces"
1774     mkdir -p "${MNTPOINT}/etc/network"
1775     echo "$DEFAULT_INTERFACES" > "${MNTPOINT}/etc/network/interfaces"
1776     eend $?
1777   elif [ -r /etc/network/interfaces ] ; then
1778     einfo "Copying /etc/network/interfaces from host to target system"
1779     mkdir -p "${MNTPOINT}/etc/network"
1780     cp $VERBOSE /etc/network/interfaces "${MNTPOINT}/etc/network/interfaces"
1781     eend $?
1782   else
1783     ewarn "Couldn't read /etc/network/interfaces, installing default /etc/network/interfaces"
1784     mkdir -p "${MNTPOINT}/etc/network"
1785     echo "$DEFAULT_INTERFACES" > "${MNTPOINT}/etc/network/interfaces"
1786     eend $?
1787   fi
1788
1789   # install config file providing some example entries
1790   if [ -r /etc/network/interfaces.examples ] && [ ! -r "$MNTPOINT/etc/network/interfaces.examples" ] ; then
1791     mkdir -p "${MNTPOINT}/etc/network"
1792     cp /etc/network/interfaces.examples "$MNTPOINT/etc/network/interfaces.examples"
1793   fi
1794
1795   if [ -n "${SSHCOPYID}" ] ; then
1796     if ssh-add -L >/dev/null 2>&1 ; then
1797       einfo "Use locally available public keys to authorise root login on the target system as requested via --sshcopyid option."
1798       mkdir -p "${MNTPOINT}"/root/.ssh
1799       chmod 0700 "${MNTPOINT}"/root/.ssh
1800       if ssh-add -L >> "${MNTPOINT}"/root/.ssh/authorized_keys ; then
1801         eend 0
1802       else
1803         eerror "Error: executing 'ssh-add -L' failed."
1804         eend 1
1805         bailout 1
1806       fi
1807     else
1808       eerror "Could not open a connection to your authentication agent or the agent has no identites."
1809       eend 1
1810       bailout 1
1811     fi
1812   fi
1813
1814   if [ -d /run/udev ] ; then
1815     einfo "Setting up bind-mount /run/udev"
1816     mkdir -p "${MNTPOINT}"/run/udev
1817     mount --bind /run/udev "${MNTPOINT}"/run/udev
1818     eend $?
1819   fi
1820
1821   eend 0
1822 }
1823 # }}}
1824
1825 # execute all scripts in /etc/debootstrap/pre-scripts/ {{{
1826 execute_pre_scripts() {
1827   # make sure hostname is set even before chroot-script get executed
1828   echo "$HOSTNAME" > "$MNTPOINT"/etc/hostname
1829
1830   # make sure we have $MNTPOINT available for our scripts
1831   export MNTPOINT
1832
1833   if [ -d "$_opt_pre_scripts" ] || [ "$PRE_SCRIPTS" = 'yes' ] ; then
1834     [ -d "$_opt_pre_scripts" ] && pre_scripts="$_opt_pre_scripts" || pre_scripts="${CONFFILES}/pre-scripts/"
1835     for script in "${pre_scripts}"/* ; do
1836       if [ -x "$script" ] ; then
1837         einfo "Executing pre-script $script"
1838         "$script" ; eend $?
1839       fi
1840     done
1841   fi
1842 }
1843 # }}}
1844
1845 # execute all scripts in /etc/debootstrap/post-scripts/ {{{
1846 execute_post_scripts() {
1847   # make sure we have $MNTPOINT and HOSTNAME available for our scripts
1848   export MNTPOINT
1849   export TARGET_HOSTNAME=$HOSTNAME
1850
1851   if [ -d "$_opt_scripts" ] || [ "$SCRIPTS" = 'yes' ] ; then
1852     # legacy support for /etc/debootstrap/scripts/
1853     [ -d "$_opt_scripts" ] && post_scripts="$_opt_scripts" || post_scripts="${CONFFILES}/scripts/"
1854     ewarn "Deprecation NOTE: --scripts/SCRIPTS are deprecated, please switch to --post-scripts/POST_SCRIPTS instead."
1855   elif [ -d "$_opt_post_scripts" ] || [ "$POST_SCRIPTS" = 'yes' ] ; then
1856     [ -d "$_opt_post_scripts" ] && post_scripts="$_opt_post_scripts" || post_scripts="${CONFFILES}/post-scripts/"
1857   fi
1858
1859   if [ -n "$post_scripts" ] ; then
1860     for script in "${post_scripts}"/* ; do
1861       if [ -x "$script" ] ; then
1862         einfo "Executing post-script $script"
1863         "$script" ; eend $?
1864       fi
1865     done
1866   fi
1867 }
1868 # }}}
1869
1870 # unmount mountpoint {{{
1871 try_umount() {
1872   local tries=$1
1873   local mountpoint="$2"
1874
1875   for (( try=1; try<=tries; try++ )); do
1876     if [[ ${try} -eq ${tries} ]]; then
1877       # Last time, show errors this time
1878       umount "${mountpoint}" && return 0
1879     else
1880       # Not last time, hide errors until fatal
1881       if umount "${mountpoint}" 2>/dev/null ; then
1882         return 0
1883       else
1884         sleep 1
1885       fi
1886     fi
1887   done
1888   return 1  # Tried enough
1889 }
1890 # }}}
1891
1892 # execute chroot-script {{{
1893 chrootscript() {
1894   if ! [ -r "$MNTPOINT/bin/chroot-script" ] ; then
1895     mount_target
1896   fi
1897
1898   if ! [ -x "$MNTPOINT/bin/chroot-script" ] ; then
1899     eerror "Fatal: $MNTPOINT/bin/chroot-script could not be found."
1900     eend 1
1901   else
1902     einfo "Executing chroot-script now"
1903     mount -t devtmpfs udev "${MNTPOINT}"/dev
1904     mount -t devpts devpts "${MNTPOINT}"/dev/pts
1905     if [ "$DEBUG" = "true" ] ; then
1906       chroot "$MNTPOINT" /bin/bash -x /bin/chroot-script ; RC=$?
1907     else
1908       chroot "$MNTPOINT" /bin/chroot-script ; RC=$?
1909     fi
1910     try_umount 3 "$MNTPOINT"/dev/pts
1911     try_umount 3 "$MNTPOINT"/dev
1912     eend $RC
1913   fi
1914
1915   # finally get rid of chroot-script again, there's no good reason to
1916   # keep it on the installed system
1917   if grep -q GRML_CHROOT_SCRIPT_MARKER "${MNTPOINT}/bin/chroot-script" ; then
1918     einfo "Removing chroot-script again"
1919     rm -f "${MNTPOINT}/bin/chroot-script"
1920     eend $?
1921   else
1922     einfo "Keeping chroot-script as string GRML_CHROOT_SCRIPT_MARKER could not be found"
1923     eend 0
1924   fi
1925 }
1926 # }}}
1927
1928 # unmount $MNTPOINT {{{
1929 umount_chroot() {
1930
1931   # display installation notes:
1932   if [ -n "$INSTALL_NOTES" ] ; then
1933      [ -r "${MNTPOINT}/${INSTALL_NOTES}" ] && cat "${MNTPOINT}/${INSTALL_NOTES}"
1934   fi
1935
1936   if [ -n "$ISODIR" ] ; then
1937      if grep -q "$ISODIR" /proc/mounts ; then
1938         einfo "Unmount $MNTPOINT/$ISODIR"
1939         umount "$MNTPOINT/$ISODIR"
1940         eend $?
1941      fi
1942   fi
1943
1944   if grep -q "$MNTPOINT" /proc/mounts ; then
1945     if mountpoint "${MNTPOINT}"/run/udev &>/dev/null ; then
1946       einfo "Unmounting bind-mount /run/udev"
1947       umount "${MNTPOINT}"/run/udev
1948       eend $?
1949     fi
1950
1951      if [ -n "$PARTITION" ] ; then
1952         einfo "Unmount $MNTPOINT"
1953         umount "$MNTPOINT"
1954         eend $?
1955      fi
1956   fi
1957 }
1958 # }}}
1959
1960 # execute filesystem check {{{
1961 fscktool() {
1962  if [ -n "$VIRTUAL" ] ; then
1963    einfo "Skipping filesystem check because we deploy a virtual machine."
1964    return 0
1965  fi
1966
1967  if [ "$FSCK" = 'yes' ] ; then
1968    [ -n "$FSCKTOOL" ] || FSCKTOOL="fsck.${MKFS#mkfs.}"
1969    einfo "Checking filesystem on $TARGET using $FSCKTOOL"
1970    "$FSCKTOOL" "$TARGET"
1971    eend $?
1972  fi
1973 }
1974 # }}}
1975
1976 # get rid of grml-debootstrap config files {{{
1977 remove_configs() {
1978   if [ "$REMOVE_CONFIGS" != "yes" ] ; then
1979     return 0
1980   fi
1981
1982   if ! mountpoint "${MNTPOINT}" >/dev/null 2>&1 ; then
1983     ewarn "Target ${MNTPOINT} doesn't seem to be mounted, can't remove configuration files." ; eend 0
1984     return 0
1985   fi
1986
1987   einfo "Removing configuration files from installed system as requested via --remove-configs / REMOVE_CONFIGS."
1988   rm -rf "${MNTPOINT}"/etc/debootstrap/
1989   eend $?
1990 }
1991 # }}}
1992
1993 # now execute all the functions {{{
1994 for i in format_efi_partition prepare_vm mkfs tunefs \
1995          mount_target mountpoint_to_blockdevice debootstrap_system \
1996          preparechroot execute_pre_scripts chrootscript execute_post_scripts \
1997          remove_configs umount_chroot grub_install umount_target fscktool ; do
1998     if stage "${i}" ; then
1999       if "$i" ; then
2000         stage "${i}" 'done' && rm -f "${STAGES}/${i}"
2001       else
2002         bailout 2 "$i"
2003       fi
2004     fi
2005 done
2006
2007 cleanup
2008 # }}}
2009
2010 # end dialog of autoinstallation {{{
2011 if [ -n "$AUTOINSTALL" ] ; then
2012    if dialog --title "${PN}" --pause "Finished execution of ${PN}.
2013 Automatically rebooting in 10 seconds.
2014
2015 Choose Cancel to skip rebooting." 10 60 10 ; then
2016      noeject noprompt reboot
2017   fi
2018 else
2019    einfo "Finished execution of ${PN}. Enjoy your Debian system." ; eend 0
2020 fi
2021 # }}}
2022
2023 ## END OF FILE #################################################################
2024 # vim: ai tw=100 expandtab foldmethod=marker shiftwidth=2