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