grml-live

   1 #!/bin/bash
   2 # Filename:      grml-live
   3 # Purpose:       build process script for generating a (grml based) Linux Live-ISO
   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 or any later version.
   7 # Latest change: Thu Oct 04 22:16:28 CEST 2007 [mika]
   8 ################################################################################
   9
  10 # read configuration files, set some misc variables {{{
  11
  12 export LANG=C
  13 export LC_ALL=C
  14
  15 # exit on any error:
  16 set -e
  17
  18 # we need root permissions for the build-process:
  19 if [ "$(id -u 2>/dev/null)" != 0 ] ; then
  20    echo "Error: please run this script with uid 0 (root)." >&2
  21    exit 1
  22 fi
  23
  24 if [ -r /var/run/fai/FAI_INSTALLATION_IN_PROGRESS ] ; then
  25    echo "/usr/sbin/fai already running or was aborted before."&>2
  26    echo "You may remove /var/run/fai/FAI_INSTALLATION_IN_PROGRESS and try again.">&2
  27    exit 1
  28 fi
  29
  30 # make sure they are not set by default
  31 VERBOSE=''
  32 FORCE=''
  33
  34 if [ -r /etc/grml/lsb-functions ] ; then
  35    . /etc/grml/lsb-functions
  36 else
  37    einfo()  { echo "  [*] $*" ;}
  38    eerror() { echo "  [!] $*">&2 ;}
  39    ewarn()  { echo "  [x] $*" ;}
  40    eend()   { return 0 ;}
  41 fi
  42
  43 # source main configuration file:
  44 LIVE_CONF=/etc/grml/grml-live.conf
  45 . $LIVE_CONF
  46
  47 PN=$(basename $0)
  48 # }}}
  49
  50 # clean exit {{{
  51 bailout() {
  52   [ -n "$MIRROR_DIRECTORY" ] && umount "${CHROOT_OUTPUT}/${MIRROR_DIRECTORY}"
  53   [ -n "$1" ] && EXIT="$1" || EXIT="1"
  54   [ -n "$2" ] && eerror "$2">&2
  55   exit "$EXIT"
  56 }
  57 trap bailout 1 2 3 15
  58 # }}}
  59
  60 # check for important variables {{{
  61 [ -n "$GRML_FAI_CONFIG" ] || GRML_FAI_CONFIG=/etc/grml/fai
  62 [ -n "$HOSTNAME" ] || HOSTNAME=grml
  63 [ -n "$USERNAME" ] || USERNAME=grml
  64 [ -n "$CLASSES" ]  || CLASSES="GRML,I386"
  65 [ -n "$BOOT_METHOD" ] || BOOT_METHOD='isolinux'
  66 [ -n "$OUTPUT" ] || bailout 1 "${PN}: \$OUTPUT not specified. Please adjust $LIVE_CONF. Exiting."
  67
  68 [ -n "$VERSION" ]  || VERSION="0.0.1"
  69 [ -n "$RELEASENAME" ] || RELEASENAME="grml-live rocks"
  70 [ -n "$GRML_NAME" ] || GRML_NAME='grml'
  71
  72 [ -n "$LOGDIR" ] || LOGDIR="/var/log/"
  73 LOGFILE="$LOGDIR/grml-live.log"
  74 # }}}
  75
  76 # some important functions {{{
  77
  78 # log output:
  79 # usage: log "string to log"
  80 log() { echo "$*" >> $LOGFILE ; }
  81
  82 # cut string at character number int = $1
  83 # usage: cut_string 5 "1234567890" will output "12345"
  84 cut_string() {
  85   [ -n "$2" ] || return 1
  86   echo "$2" | head -c "$1"; echo -ne "\n"
  87 }
  88
  89 # prepend int = $1 spaces before string = $2
  90 # usage: extend_string_begin 5 "123" will output "  123"
  91 extend_string_begin() {
  92   [ -n "$2" ] || return 1
  93   local COUNT="$(echo $2 | wc -c)"
  94   local FILL="$(expr $COUNT - $1)"
  95   while [ "$FILL" -gt 1 ] ; do
  96     echo -n " "
  97     local FILL=$(expr $FILL - 1)
  98   done
  99   while [ "$FILL" -lt 1 ] ; do
 100     echo -n " "
 101     local FILL=$(expr $FILL + 1)
 102   done
 103   echo "$2" | head -c "$1"; echo -ne "\n"
 104 }
 105
 106 # append int = $1 spaces to string = $2
 107 # usage: extend_string_begin 5 "123" will output "123  "
 108 extend_string_end() {
 109   [ -n "$2" ] || return 1
 110   echo -n "$2" | head -c "$1"
 111   local COUNT="$(echo $2 | wc -c)"
 112   local FILL="$(expr $COUNT - $1)"
 113   while [ "$FILL" -gt 1 ] ; do
 114     echo -n " "
 115     local FILL=$(expr $FILL - 1)
 116   done
 117   while [ "$FILL" -lt 1 ] ; do
 118     echo -n " "
 119     local FILL=$(expr $FILL + 1)
 120   done
 121   echo -ne "\n"
 122 }
 123 # }}}
 124
 125 # usage information {{{
 126 usage()
 127 {
 128   echo "
 129 $PN - build process script for generating a (grml based) Linux Live-ISO
 130
 131 Usage: $PN [-c <classe[s]>] [-g <grml_name>] [-i <iso_name> ] \\
 132                  [-o <output_directory>] [-s <suite>] [-t <template_directory>] \\
 133                  [-s <suite>] [-v <version_number>] [-FVh]
 134
 135 Usage examples:
 136
 137     $PN
 138     $PN -c GRMLBASE,GRML_SMALL,I386 -o /grml/
 139     $PN -c GRMLBASE,GRML_MEDIUM,I386 -o /dev/shm/grml
 140     $PN -c GRMLBASE,GRML_SMALL,I386 -g grml-small -v 1.0
 141     $PN -c GRMLBASE,GRML_FULL,I386 -i grml_0.0-1.iso
 142     $PN -c GRMLBASE,GRML_FULL,I386 -s sid -V
 143
 144 More details: man grml-live
 145               /usr/share/doc/grml-live/grml-live.html
 146
 147 Please send your bug reports, feedback,.. to the grml-team.
 148 http://grml.org/bugs/
 149 "
 150 }
 151 # }}}
 152
 153 # command line parsing {{{
 154
 155 while getopts "c:g:i:r:s:t:v:FhV" opt; do
 156   case "$opt" in
 157     c) CLASSES="$OPTARG" ;;
 158     g) GRML_NAME="$OPTARG" ;;
 159     i) ISO_NAME="$OPTARG" ;;
 160     r) RELEASENAME="$OPTARG" ;;
 161     s) SUITE="$OPTARG" ;;
 162     t) TEMPLATE_DIRECTORY="$OPTARG"
 163     o) OUTPUT="$OPTARG"
 164        CHROOT_OUTPUT="$OUTPUT/grml_chroot"
 165        BUILD_OUTPUT="$OUTPUT/grml_cd"
 166        ISO_OUTPUT="$OUTPUT/grml_isos"
 167        ;;
 168     v) VERSION="$OPTARG" ;;
 169     F) FORCE=1 ;;
 170     h) usage ; bailout 0 ;;
 171     V) VERBOSE="-v" ;;
 172     ?) echo "invalid option -$OPTARG" >&2; bailout 1 ;;
 173   esac
 174 done
 175 shift $(($OPTIND - 1))  # set ARGV to the first not parsed commandline parameter
 176
 177 # }}}
 178
 179 # some misc checks before executing FAI {{{
 180 [ -n "$CLASSES" ] || bailout 1 "Error: \$CLASSES unset, please set it in $LIVE_CONF or
 181 specify it on the command line using the -c option."
 182 [ -n "$OUTPUT" ] || bailout 1 "Error: \$OUTPUT unset, please set it in $LIVE_CONF or
 183 specify it on the command line using the -o option."
 184 # }}}
 185
 186 # ask user whether the setup is ok {{{
 187 if [ -z "$FORCE" ] ; then
 188    echo
 189    echo "${PN}: check your configuration (or use -F to force execution without prompting):"
 190    echo
 191    echo "  FAI classes:       $CLASSES"
 192    echo "  main directory:    $OUTPUT"
 193    [ -n "$CHROOT_OUTPUT" ] && echo "  chroot target:     $CHROOT_OUTPUT"
 194    [ -n "$BUILD_OUTPUT" ]  && echo "  build target:      $BUILD_OUTPUT"
 195    [ -n "$ISO_OUTPUT" ]    && echo "  ISO target:        $ISO_OUTPUT"
 196    [ -n "$GRML_NAME" ]     && echo "  grml name:         $GRML_NAME"
 197    [ -n "$RELEASENAME" ]   && echo "  release name:      $RELEASENAME"
 198    [ -n "$VERSION" ]       && echo "  grml version:      $VERSION"
 199    [ -n "$SUITE" ]         && echo "  Debian suite:      $SUITE"
 200    [ -n "$BOOT_METHOD" ]   && echo "  Boot method:       $BOOT_METHOD"
 201    [ -n "$FAI_ARGS" ]      && echo "  additional arguments for FAI: $FAI_ARGS"
 202    [ -n "$VERBOSE" ]       && echo "  Using VERBOSE mode."
 203    echo
 204    echo -n "Is this ok for you? [y/N] "
 205    read a
 206    if ! [ "$a" = 'y' -o "$a" = 'Y' ] ; then
 207       bailout 1 "Exiting as requested."
 208    fi
 209    echo
 210
 211    start_seconds=$(cut -d . -f 1 /proc/uptime)
 212    log "------------------------------------------------------------------------------"
 213    log "Starting grml-live run [$(date)]"
 214 fi
 215 # }}}
 216
 217 # on-the-fly configuration {{{
 218 if [ -n "$MIRROR_DIRECTORY" ] ; then
 219    if ! [ -d "$MIRROR_DIRECTORY/debian" ] ; then
 220       log "Sorry, $MIRROR_DIRECTORY/debian does not seem to exist. Exiting. [$(date)]"
 221       eerror "Sorry, $MIRROR_DIRECTORY/debian does not seem to exist. Exiting."
 222       bailout 1
 223    fi
 224    echo "$MIRROR_SOURCES" > /etc/grml/fai/apt/sources.list
 225    if [ -n "$GRML_LIVE_SOURCES" ] ; then
 226       echo "$GRML_LIVE_SOURCES" >> /etc/grml/fai/apt/sources.list
 227    fi
 228 elif [ -n "$GRML_LIVE_SOURCES" ] ; then
 229    echo "$GRML_LIVE_SOURCES" > /etc/grml/fai/apt/sources.list
 230 fi
 231
 232 if [ -n "$FAI_DEBOOTSTRAP" ] ; then
 233    sed -i "s#^FAI_DEBOOTSTRAP=.*#FAI_DEBOOTSTRAP=\"$FAI_DEBOOTSTRAP\"#" /etc/grml/fai/make-fai-nfsroot.conf
 234 fi
 235
 236 # does this suck? YES!
 237 if [ -n "$SUITE" ] ; then
 238    sed -i "s/SUITE=.*/SUITE=\"$SUITE\"/" $LIVE_CONF
 239
 240    DIST="\|\ etch\ \|\ stable\ \|\ lenny\ \|\ testing\ \|\ sid\ \|\ unstable\ "
 241    sed -i "s/\(deb .\+\)\([ \t]+\)$DIST\([ \t]+\)\(main \)/\1\2 $SUITE \3\4/" $LIVE_CONF
 242    sed -i "s/\(deb .\+\)\([ \t]+\)$DIST\([ \t]+\)\(main \)/\1\2 $SUITE \3\4/" /etc/grml/fai/apt/sources.list
 243
 244    DIST='\"etch\|=\"stable=\"lenny=\"testing=\"sid=\"unstable'
 245    sed -i "s#FAI_DEBOOTSTRAP=$DIST#FAI_DEBOOTSTRAP=\"$SUITE#" $LIVE_CONF
 246    sed -i "s#FAI_DEBOOTSTRAP=$DIST#FAI_DEBOOTSTRAP=\"$SUITE#" /etc/grml/fai/make-fai-nfsroot.conf
 247 fi
 248 # }}}
 249
 250 # CHROOT_OUTPUT - execute FAI {{{
 251 [ -n "$CHROOT_OUTPUT" ] || CHROOT_OUTPUT="$OUTPUT/grml_chroot"
 252
 253 if [ -d "$CHROOT_OUTPUT/bin" ] ; then
 254    log "$CHROOT_OUTPUT exists already, skipping stage 'fai dirinstall'"
 255    ewarn "$CHROOT_OUTPUT exists already, skipping stage 'fai dirinstall'" ; eend 0
 256 else
 257    mkdir -p "$CHROOT_OUTPUT" || bailout 5 "Problem with creating $CHROOT_OUTPUT for FAI"
 258    if [ -n "${MIRROR_DIRECTORY}" ] ; then
 259       mkdir -p "${CHROOT_OUTPUT}/${MIRROR_DIRECTORY}"
 260       mount --bind "${MIRROR_DIRECTORY}" "${CHROOT_OUTPUT}/${MIRROR_DIRECTORY}"
 261    fi
 262    fai $VERBOSE -C "$GRML_FAI_CONFIG" -c"$CLASSES" -u "$HOSTNAME" dirinstall "$CHROOT_OUTPUT" $FAI_ARGS | tee -a $LOGFILE
 263    umount $CHROOT_OUTPUT/proc 2>/dev/null || /bin/true
 264    umount $CHROOT_OUTPUT/sys  2>/dev/null || /bin/true
 265    [ -n "$MIRROR_DIRECTORY" ] && umount "${CHROOT_OUTPUT}/${MIRROR_DIRECTORY}"
 266
 267    # notice: 'fai dirinstall' does not seem to exit appropriate, so:
 268    ERROR=''
 269    if [ -r "/var/log/fai/dirinstall/$HOSTNAME/software.log" ] ; then
 270       grep 'dpkg: error processing' /var/log/fai/dirinstall/$HOSTNAME/software.log >> $LOGFILE && ERROR=1
 271    fi
 272
 273    if [ -r "/var/log/fai/dirinstall/$HOSTNAME/shell.log" ] ; then
 274       grep 'FAILED with exit code' /var/log/fai/dirinstall/$HOSTNAME/shell.log >> $LOGFILE && ERROR=2
 275    fi
 276
 277    if [ -n "$ERROR" ] ; then
 278       log "There was an error during execution of stage 'fai dirinstall' [$(date)]"
 279       eerror "There was an error during execution of stage 'fai dirinstall'"
 280       echo "   Check out /var/log/fai/dirinstall/$HOSTNAME/ for details. [exit ${ERROR}]"
 281       eend 1 ; exit 1
 282    else
 283       log "Finished execution of stage 'fai dirinstall' [$(date)]"
 284       einfo "Finished execution of stage 'fai dirinstall'"
 285    fi
 286 fi
 287 # }}}
 288
 289 # BUILD_OUTPUT - execute arch specific stuff and squashfs {{{
 290 [ -n "$BUILD_OUTPUT" ] || BUILD_OUTPUT="$OUTPUT/grml_cd"
 291 mkdir -p "$BUILD_OUTPUT" || bailout 6 "Problem with creating $BUILD_OUTPUT for stage ARCH"
 292
 293 [ -n "$ARCH" ] || ARCH="$(dpkg --print-architecture)"
 294
 295 # i386:
 296 if [ "$ARCH" = i386 ] || [ "$ARCH" = amd64 ] ; then
 297    if [ -d "$BUILD_OUTPUT"/boot ] ; then
 298       log "$BUILD_OUTPUT/boot exists already, skipping stage 'boot'"
 299       ewarn "$BUILD_OUTPUT/boot exists already, skipping stage 'boot'" ; eend 0
 300    else
 301       # booting stuff:
 302       mkdir -p "$BUILD_OUTPUT"/boot/isolinux
 303       cp /boot/memtest86+.bin                              "$BUILD_OUTPUT"/boot/isolinux/memtest
 304       # do not keep the initrd inside the chroot, let's save space instead:
 305       mv "$CHROOT_OUTPUT"/boot/initrd*                     "$BUILD_OUTPUT"/boot/isolinux/initrd.gz
 306       cp "$CHROOT_OUTPUT"/boot/vmlinuz*                    "$BUILD_OUTPUT"/boot/isolinux/linux26
 307       cp /usr/lib/syslinux/chain.c32                       "$BUILD_OUTPUT"/boot/isolinux/
 308       cp /usr/lib/syslinux/isolinux.bin                    "$BUILD_OUTPUT"/boot/isolinux/
 309       cp /usr/lib/syslinux/memdisk                         "$BUILD_OUTPUT"/boot/isolinux/
 310       cp /usr/lib/syslinux/menu.c32                        "$BUILD_OUTPUT"/boot/isolinux/
 311
 312       if ! [ -d "${TEMPLATE_DIRECTORY}"/boot ] ; then
 313          log "${TEMPLATE_DIRECTORY}/boot does not exist. Exiting."
 314          eerror "${TEMPLATE_DIRECTORY}/boot does not exist. Exiting." ; eend 1
 315          bailout 8
 316       fi
 317       cp ${TEMPLATE_DIRECTORY}/boot/isolinux/*               "$BUILD_OUTPUT"/boot/isolinux/
 318       cp ${TEMPLATE_DIRECTORY}/boot/isolinux/*               "$BUILD_OUTPUT"/boot/isolinux/
 319       cp -a ${TEMPLATE_DIRECTORY}/boot/grub                  "$BUILD_OUTPUT"/boot/
 320
 321       if ! [ -d "${TEMPLATE_DIRECTORY}"/GRML ] ; then
 322          log "${TEMPLATE_DIRECTORY}/GRML does not exist. Exiting."
 323          eerror "${TEMPLATE_DIRECTORY}/GRML does not exist. Exiting." ; eend 1
 324          bailout 9
 325       fi
 326       [ -d "$BUILD_OUTPUT"/GRML ] || mkdir "$BUILD_OUTPUT"/GRML
 327       cp -a ${TEMPLATE_DIRECTORY}/GRML/* "$BUILD_OUTPUT"/GRML/
 328
 329       # adjust boot splash information:
 330       ISO_DATE="$(date +%Y-%m-%d)"
 331       RELEASE_INFO="$GRML_NAME $VERSION - Release Codename $RELEASENAME"
 332       RELEASE_INFO="$(cut_string 68 "$RELEASE_INFO")"
 333       RELEASE_INFO="$(extend_string_end 68 "$RELEASE_INFO")"
 334
 335       sed -i "s/%RELEASE_INFO%/$GRML_NAME $VERSION - $RELEASENAME/" "$BUILD_OUTPUT"/GRML/grml-version
 336       sed -i "s/%DATE%/$ISO_DATE/"             "$BUILD_OUTPUT"/GRML/grml-version
 337
 338       sed -i "s/%RELEASE_INFO%/$RELEASE_INFO/" "$BUILD_OUTPUT"/boot/isolinux/boot.msg
 339       sed -i "s/%DATE%/$ISO_DATE/"             "$BUILD_OUTPUT"/boot/isolinux/boot.msg
 340
 341       sed -i "s/%RELEASE_INFO%/$RELEASE_INFO/" "$BUILD_OUTPUT"/boot/isolinux/boot-beep.msg
 342       sed -i "s/%DATE%/$ISO_DATE/"             "$BUILD_OUTPUT"/boot/isolinux/boot-beep.msg
 343
 344       sed -i "s/%VERSION%/$VERSION/"           "$BUILD_OUTPUT"/boot/grub/menu.lst
 345       sed -i "s/%GRML_NAME%/$GRML_NAME/"       "$BUILD_OUTPUT"/boot/grub/menu.lst
 346
 347       # autostart for Windows:
 348       if [ -d "${TEMPLATE_DIRECTORY}/windows/autostart/" ] ; then
 349          cp ${TEMPLATE_DIRECTORY}/windows/autostart/* "$BUILD_OUTPUT"/
 350       fi
 351       # windows-binaries:
 352       if [ -n "$WINDOWS_BINARIES" ] ; then
 353          if [ -f "$BUILD_OUTPUT"/windows/putty.exe ] ; then
 354             log "$BUILD_OUTPUT/windows exists already, skipping stage 'WINDOWS_BINARIES'"
 355             ewarn "$BUILD_OUTPUT/windows exists already, skipping stage 'WINDOWS_BINARIES'" ; eend 0
 356          else
 357             mkdir "$BUILD_OUTPUT"/windows
 358             ( cd "$BUILD_OUTPUT"/windows
 359               for file in pageant plink pscp psftp putty puttygen ; do
 360                  wget -O ${file}.exe ${WINDOWS_BINARIES}/${file}.exe
 361               done )
 362          fi
 363       log "Finished execution of stage 'WINDOWS_BINARIES' [$(date)]"
 364       einfo "Finished execution of stage 'WINDOWS_BINARIES'" ; eend 0
 365       fi
 366    einfo "Finished execution of stage 'boot'" ; eend 0
 367    fi
 368 # ppc:
 369 elif [ "$ARCH" = powerpc ] ; then
 370     ewarn 'Warning: formorer, it is your turn. :)'>&2
 371 # unsuported:
 372 else
 373    eerror 'Error: Unsupported ARCH, sorry. Want to support it? Contribute!' ; eend 1
 374 fi
 375
 376 if [ -f "$BUILD_OUTPUT"/live/grml.squashfs ] ; then
 377    log "$BUILD_OUTPUT/live exists already, skipping stage 'squashfs'"
 378    ewarn "$BUILD_OUTPUT/live exists already, skipping stage 'squashfs'" ; eend 0
 379 else
 380    mkdir "$BUILD_OUTPUT"/live
 381    mksquashfs $CHROOT_OUTPUT/* $BUILD_OUTPUT/live/grml.squashfs -noappend
 382    log "Finished execution of stage 'squashfs' [$(date)]"
 383    einfo "Finished execution of stage 'squashfs'" ; eend 0
 384 fi
 385
 386 # create md5sum file:
 387 ( cd $BUILD_OUTPUT/GRML &&
 388 find .. -type f -not -name md5sums -not -name isolinux.bin -exec md5sum {} \; > md5sums )
 389 # }}}
 390
 391 # ISO_OUTPUT - mkisofs {{{
 392 [ -n "$ISO_OUTPUT" ] || ISO_OUTPUT="$OUTPUT/grml_isos"
 393 [ -n "$ISO_NAME" ] || ISO_NAME="${GRML_NAME}_${VERSION}.iso"
 394
 395 if [ "$BOOT_METHOD" = "isolinux" ] ; then
 396    BOOT_FILE="boot/isolinux/isolinux.bin -c boot/isolinux/boot.cat"
 397 elif [ "$BOOT_METHOD" = "grub" ] ; then
 398    BOOT_FILE="boot/grub/stage2_eltorito"
 399 fi
 400
 401 if [ -f "${ISO_OUTPUT}/${ISO_NAME}" ] ; then
 402    log "$ISO_OUTPUT exists already, skipping stage 'iso build'"
 403    ewarn "$ISO_OUTPUT exists already, skipping stage 'iso build'" ; eend 0
 404 else
 405    mkdir -p "$ISO_OUTPUT" || bailout 6 "Problem with creating $ISO_OUTPUT for stage 'iso build'"
 406    CURRENT_DIR=$(pwd)
 407    cd "$BUILD_OUTPUT" &&
 408    mkisofs -V "grml $VERSION" -publisher 'grml-live | grml.org' \
 409            -l -r -J -no-emul-boot -boot-load-size 4 -boot-info-table    \
 410            -b $BOOT_FILE \
 411            -o "${ISO_OUTPUT}/${ISO_NAME}" . ; RC=$?
 412    cd $CURRENT_DIR
 413    if [ "$RC" = 0 ] ; then
 414       log "Finished execution of stage 'iso build' [$(date)]"
 415       einfo "Finished execution of stage 'iso build'" ; eend 0
 416    else
 417       log "There was an error ($RC) executing stage 'iso build' [$(date)]"
 418       eerror "There was an error executing stage 'iso build'" ; eend 1
 419       bailout $RC
 420    fi
 421 fi
 422 # }}}
 423
 424 # finalize {{{
 425 [ -n "$start_seconds" ] && SECONDS="$[$(cut -d . -f 1 /proc/uptime)-$start_seconds]"
 426 einfo "Sucessfully finished execution of $PN [running ${SECONDS} seconds]" ; eend 0
 427 log "Sucessfully finished execution of $PN [running ${SECONDS} seconds]"
 428 log "------------------------------------------------------------------------------"
 429 bailout 0
 430 # }}}
 431
 432 ## END OF FILE #################################################################
 433 # vim:foldmethod=marker ts=2 ft=sh ai expandtab tw=80 sw=3