path: root/helpers/lh_binary_syslinux

#!/bin/sh

# lh_binary_syslinux(1) - installs syslinux into binary
# Copyright (C) 2006-2007 Daniel Baumann <daniel@debian.org>
#
# live-helper comes with ABSOLUTELY NO WARRANTY; for details see COPYING.
# This is free software, and you are welcome to redistribute it
# under certain conditions; see COPYING for details.

set -e

# Including common functions
LH_BASE="${LH_BASE:-/usr/share/live-helper}"

for FUNCTION in "${LH_BASE}"/functions/*.sh
do
	. "${FUNCTION}"
done

# Setting static variables
DESCRIPTION="installs syslinux into binary"
HELP=""
USAGE="${PROGRAM} [--force]"

Arguments "${@}"

# Reading configuration files
Read_conffile config/common
Read_conffile config/bootstrap
Read_conffile config/chroot
Read_conffile config/binary
Read_conffile config/source
Set_defaults

if [ "${LIVE_BOOTLOADER}" != "syslinux" ]
then
	exit 0
fi

Echo_message "Begin installing syslinux..."

# Requiring stage file
Require_stagefile .stage/bootstrap

# Checking stage file
Check_stagefile .stage/binary_syslinux

# Checking syslinux templates
Check_templates syslinux

# Checking lock file
Check_lockfile .lock

# Creating lock file
Create_lockfile .lock

# Check architecture
Check_architecture amd64 i386

# Checking depends
Check_package chroot/usr/bin/syslinux syslinux

# Restoring cache
Restore_cache cache/packages_binary

# Installing depends
Install_package

# Local functions
Syslinux_live_entry ()
{
	LABEL="${1}"
	KERNEL="${2}"
	INITRD="${3}"
	APPEND="${4}"

	# syslinux << 3.36 lacks support to file/path
	if [ "${LIVE_BINARY_IMAGES}" != "net" ] && [ "`basename ${DESTDIR_LIVE}`" != "binary" ]
	then
		DIRECTORY="`basename ${DESTDIR_LIVE}`"
		KERNEL="${DIRECTORY}/${KERNEL}"
		INITRD="${DIRECTORY}/${INITRD}"
	fi

	LINUX_LIVE="${LINUX_LIVE}\nLABEL ${LABEL}\n"
	LINUX_LIVE="${LINUX_LIVE}\tkernel /${KERNEL}\n"
	LINUX_LIVE="${LINUX_LIVE}\tappend initrd=/${INITRD} boot=${INITFS} LIVE_BOOTAPPEND ${APPEND}\n"
}

Syslinux_install_entry ()
{
	LABEL="${1}"
	KERNEL="${2}"
	INITRD="${3}"
	APPEND="${4}"

	# syslinux << 3.36 lacks support to file/path
	if [ "${LIVE_BINARY_IMAGES}" != "net" ] && [ "`basename ${DESTDIR_INSTALL}`" != "binary" ]
	then
		DIRECTORY="`basename ${DESTDIR_INSTALL}`"
		KERNEL="${DIRECTORY}/${KERNEL}"
		INITRD="${DIRECTORY}/${INITRD}"
	fi

	# Boot in quiet mode
	if [ "${LIVE_DISTRIBUTION}" != "etch" ] && [ "${LABEL}" != "rescue" ] && [ "${LABEL}" != "rescuegui" ]
	then
		APPEND="${APPEND} quiet"
	fi

	LINUX_INSTALL="${LINUX_INSTALL}\nLABEL ${LABEL}\n"
	LINUX_INSTALL="${LINUX_INSTALL}\tkernel /${KERNEL}\n"
	LINUX_INSTALL="${LINUX_INSTALL}\tappend initrd=/${INITRD} ${APPEND} --\n"
}

case "${LH_INITRAMFS}" in
	casper)
		INITFS="casper"
		;;

	live-initramfs)
		INITFS="live"
		;;
esac

# Setting destination directory
case "${LIVE_BINARY_IMAGES}" in
	iso)
		case "${LH_INITRAMFS}" in
			casper)
				DESTDIR_LIVE="binary/casper"
				;;

			live-initramfs)
				DESTDIR_LIVE="binary/live"
				;;
		esac

		DESTDIR_INSTALL="binary/install"
		;;

	net)
		DESTDIR_LIVE="tftpboot"
		DESTDIR_INSTALL="tftpboot"
		;;

	tar|usb-hdd)
		case "${LH_INITRAMFS}" in
			casper)
				DESTDIR_LIVE="binary/casper"
				;;

			live-initramfs)
				DESTDIR_LIVE="binary/live"
				;;
		esac

		DESTDIR_INSTALL="binary/install"

		# syslinux << 3.36 lacks support for long file/path
		if [ "${LIVE_DISTRIBUTION}" = "etch" ]
		then
			DESTDIR_LIVE="binary"
			DESTDIR_INSTALL="binary"
		fi
		;;
esac

Check_multiarchitecture

# Creating directory
mkdir -p "${DESTDIR_LIVE}"

# Setting boot parameters
if [ -n "${LIVE_ENCRYPTION}" ]
then
	LIVE_BOOTAPPEND="${LIVE_BOOTAPPEND} encryption=${LIVE_ENCRYPTION}"
fi

if [ -n "${LIVE_USERNAME}" ]
then
	case "${LH_INITRAMFS}" in
		casper)
			LIVE_BOOTAPPEND="${LIVE_BOOTAPPEND} username=${LIVE_USERNAME}"
			;;

		live-initramfs)
			if [ "${LIVE_USERNAME}" != "user" ]
			then
				LIVE_BOOTAPPEND="${LIVE_BOOTAPPEND} username=${LIVE_USERNAME}"
			fi
			;;
	esac
fi

if [ -n "${LIVE_HOSTNAME}" ]
then
	case "${LH_INITRAMFS}" in
		casper)
			LIVE_BOOTAPPEND="${LIVE_BOOTAPPEND} hostname=${LIVE_HOSTNAME}"
			;;

		live-initramfs)
			if [ "${LIVE_HOSTNAME}" != "debian" ]
			then
				LIVE_BOOTAPPEND="${LIVE_BOOTAPPEND} hostname=${LIVE_HOSTNAME}"
			fi
			;;
	esac
fi

if [ "${LIVE_UNION_FILESYSTEM}" != "unionfs" ]
then
	LIVE_BOOTAPPEND="${LIVE_BOOTAPPEND} union=${LIVE_UNION_FILESYSTEM}"
fi

if [ "${LIVE_BINARY_IMAGES}" = "net" ]
then
	case "${LIVE_NET_FILESYSTEM}" in
		nfs)
			LIVE_BOOTAPPEND="${LIVE_BOOTAPPEND} netboot=nfs nfsroot=LIVE_NET_SERVER:LIVE_NET_PATH"
			;;

		cifs)
			LIVE_BOOTAPPEND="${LIVE_BOOTAPPEND} netboot=cifs nfsroot=//LIVE_NET_SERVERLIVE_NET_PATH"
			;;

		*)
			Echo_error "Unsupported net filesystem"
			exit 1
			;;
	esac

	if [ -n "${LIVE_NET_MOUNTOPTIONS}" ]
	then
		LIVE_BOOTAPPEND="${LIVE_BOOTAPPEND} nfsopts=${LIVE_NET_MOUNTOPTIONS}"
	fi
fi

LIVE_BOOTAPPEND="`echo ${LIVE_BOOTAPPEND} | sed -e 's/  //'`"

# Parameters are listed at: linux/Documentation/kernel-parameters.txt
FAILSAFE="noapic noapm nodma nomce nolapic nosmp vga=normal"

# Assembling kernel configuration

# Default entries
DEFAULT_FLAVOUR="`echo ${LIVE_LINUX_FLAVOURS} | awk '{ print $1 }'`"
DEFAULT_KERNEL="`basename chroot/boot/vmlinuz-*${DEFAULT_FLAVOUR}`"
DEFAULT_INITRD="initrd.img-`echo ${DEFAULT_KERNEL} | sed -e 's/vmlinuz-//'`"

Syslinux_live_entry "live" "${DEFAULT_KERNEL}" "${DEFAULT_INITRD}"
Syslinux_live_entry "live-failsafe" "${DEFAULT_KERNEL}" "${DEFAULT_INITRD}" "${FAILSAFE}"

if [ "`echo ${LIVE_LINUX_FLAVOURS} | wc -w`" -gt "1" ]
then
	for KERNEL in chroot/boot/vmlinuz-*
	do
		KERNEL_IMAGE="`basename ${KERNEL}`"
		KERNEL_VERSION="`echo ${KERNEL_IMAGE} | sed -e 's/vmlinuz-//'`"
		INITRD="initrd.img-${KERNEL_VERSION}"

		Syslinux_live_entry "live-${KERNEL_VERSION}" "${KERNEL_IMAGE}" "${INITRD}"
		Syslinux_live_entry "live-${KERNEL_VERSION}-failsafe" "${KERNEL_IMAGE}" "${INITRD}" "${FAILSAFE}"
	done
fi

LINUX_LIVE="`echo ${LINUX_LIVE} | sed -e 's/binary//g' -e 's#//#/#g'`"

# Assembling debian-installer configuration
if [ "${LIVE_DEBIAN_INSTALLER}" != "disabled" ]
then
	VMLINUZ_DI="vmlinuz"
	INITRD_DI="initrd.gz"
	APPEND_DI="vga=normal"

	VMLINUZ_GI="gtk/vmlinuz"
	INITRD_GI="gtk/initrd.gz"
	APPEND_GI="video=vesa:ywrap,mtrr vga=788"

	# Workaround for syslinux (<< 3.36) which doesn't support long file/path names
	if [ "${LIVE_DISTRIBUTION}" = "etch" ]
	then
		if [ "${LIVE_BINARY_IMAGES}" = "tar" ] || [ "${LIVE_BINARY_IMAGES}" = "usb-hdd" ]
		then
			VMLINUZ_DI="vmlinuz.di"
			INITRD_DI="initrddi.gz"

			VMLINUZ_GI="vmlinuz.gi"
			INITRD_GI="initrdgi.gz"
		fi
	fi

	Syslinux_install_entry "linux" "${VMLINUZ_DI}" "${INITRD_DI}" "${APPEND_DI}"
	Syslinux_install_entry "install" "${VMLINUZ_DI}" "${INITRD_DI}" "${APPEND_DI}"
	Syslinux_install_entry "installgui" "${VMLINUZ_GI}" "${INITRD_GI}" "${APPEND_GI}"
	Syslinux_install_entry "expert" "${VMLINUZ_DI}" "${INITRD_DI}" "priority=low ${APPEND_DI}"
	Syslinux_install_entry "expertgui" "${VMLINUZ_GI}" "${INITRD_GI}" "priority=low ${APPEND_GI}"
	Syslinux_install_entry "rescue" "${VMLINUZ_DI}" "${INITRD_DI}" "rescue/enable=true ${APPEND_DI}"
	Syslinux_install_entry "rescuegui" "${VMLINUZ_GI}" "${INITRD_GI}" "rescue/enable=true ${APPEND_GI}"
	Syslinux_install_entry "auto" "${VMLINUZ_DI}" "${INITRD_DI}" "auto=true priority=critical ${APPEND_DI}"
	Syslinux_install_entry "autogui" "${VMLINUZ_GI}" "${INITRD_GI}" "auto=true priority=critical ${APPEND_GI}"
fi

LINUX_INSTALL="`echo ${LINUX_INSTALL} | sed -e 's/binary//g' -e 's#//#/#g'`"

# Assembling memtest configuration
if [ -f "${DESTDIR_LIVE}"/memtest ]
then
	KERNEL_PATH="/`basename ${DESTDIR_LIVE}`/"

	# syslinux << 3.36 lacks support to file/path
	if [ "`basename ${DESTDIR_LIVE}`" = "binary" ]
	then
		KERNEL_PATH=""
	fi

	MEMTEST="LABEL memtest\n\tkernel ${KERNEL_PATH}memtest"
	MEMTEST="`echo ${MEMTEST} | sed -e 's#//#/#g'`"
fi

case "${LIVE_BINARY_IMAGES}" in
	iso)
		# Copying syslinux
		mkdir -p binary/isolinux

		case "${LIVE_CHROOT_BUILD}" in
			enabled)
				cp chroot/usr/lib/syslinux/isolinux.bin binary/isolinux
				;;

			disabled)
				cp /usr/lib/syslinux/isolinux.bin binary/isolinux
				;;
		esac

		cp -r "${TEMPLATES}"/* binary/isolinux
		mv binary/isolinux/syslinux.cfg binary/isolinux/isolinux.cfg

		# Copying local configuration file
		if [ -f config/binary_syslinux/syslinux.cfg ]
		then
			cp config/binary_syslinux/syslinux.cfg binary/isolinux/isolinux.cfg
		fi

		# Copying splash screen
		if [ -f config/binary_syslinux/splash.rle ]
		then
			LIVE_SYSLINUX_SPLASH="config/binary_syslinux/splash.rle"
		fi

		if [ -n "${LIVE_SYSLINUX_SPLASH}" ]
		then
			if [ "${LIVE_SYSLINUX_SPLASH}" = "none" ]
			then
				rm -f binary/isolinux/splash.rle
				sed -e "s/.*splash.*//" binary/isolinux/boot.txt
			else
				cp -f "${LIVE_SYSLINUX_SPLASH}" binary/isolinux/splash.rle
			fi
		fi

		# Configure syslinux templates
		sed -i -e "s@LINUX_LIVE@${LINUX_LIVE}@" -e "s@LINUX_INSTALL@${LINUX_INSTALL}@" -e "s@MEMTEST@${MEMTEST}@" binary/isolinux/isolinux.cfg
		sed -i -e "s#LIVE_BOOTAPPEND#${LIVE_BOOTAPPEND}#" binary/isolinux/isolinux.cfg
		sed -i -e "s/LIVE_DATE/`date +%Y%m%d`/" binary/isolinux/f1.txt
		sed -i -e "s/LIVE_VERSION/${VERSION}/" binary/isolinux/f10.txt

		# Working arround syslinux 8.3 limitation
		if [ "`echo ${LIVE_LINUX_FLAVOURS} | wc -w`" -gt "1" ]
		then
			NUMBER="0"

			# FIXME: This has a bug *iff* flavours = 686 686-bigmem (note the order).

			for FLAVOUR in ${LIVE_LINUX_FLAVOURS}
			do
				NUMBER="$(($NUMBER + 1))"

				mv "${DESTDIR_LIVE}"/vmlinuz-*-${FLAVOUR} "${DESTDIR_LIVE}"/vmlinuz${NUMBER}
				mv "${DESTDIR_LIVE}"/initrd.img-*-${FLAVOUR} "${DESTDIR_LIVE}"/initrd${NUMBER}.img
				sed -i -e "s/vmlinuz-.*-${FLAVOUR}$/vmlinuz${NUMBER}/g" -e "s/initrd.img-.*-${FLAVOUR} /initrd${NUMBER}.img /g" binary/isolinux/isolinux.cfg
			done
		else
			mv "${DESTDIR_LIVE}"/vmlinuz-*-${LIVE_LINUX_FLAVOURS} "${DESTDIR_LIVE}"/vmlinuz
			mv "${DESTDIR_LIVE}"/initrd.img-*-${LIVE_LINUX_FLAVOURS} "${DESTDIR_LIVE}"/initrd.img
			sed -i -e "s/vmlinuz-.*-${LIVE_LINUX_FLAVOURS}/vmlinuz/g" -e "s/initrd.img-.*-${LIVE_LINUX_FLAVOURS}/initrd.img/g" binary/isolinux/isolinux.cfg
		fi

		# Remove whitespaces
		sed -i -e 's/\ $//g' binary/isolinux/isolinux.cfg
		;;

	net)
		# Copying syslinux
		mkdir -p tftpboot

		case "${LIVE_CHROOT_BUILD}" in
			enabled)
				cp chroot/usr/lib/syslinux/pxelinux.0 tftpboot
				;;

			disabled)
				cp /usr/lib/syslinux/pxelinux.0 tftpboot
				;;
		esac

		mkdir -p tftpboot/pxelinux.cfg
		cp -r "${TEMPLATES}"/* tftpboot/pxelinux.cfg
		mv tftpboot/pxelinux.cfg/syslinux.cfg tftpboot/pxelinux.cfg/default

		# Copying local configuration file
		if [ -f config/binary_syslinux/syslinux.cfg ]
		then
			cp config/binary_syslinux/syslinux.cfg tftpboot/pxelinux.cfg/default
		fi

		#sed -i -e 's#splash.rle#pxelinux.cfg/splash.rle#' tftpboot/pxelinux.cfg/boot.txt

		# Copying splash screen
		if [ -f config/binary_syslinux/splash.rle ]
		then
			LIVE_SYSLINUX_SPLASH="config/binary_syslinux/splash.rle"
		fi

		if [ -n "${LIVE_SYSLINUX_SPLASH}" ]
		then
			if [ "${LIVE_SYSLINUX_SPLASH}" = "none" ]
			then
				rm -f tftpboot/pxelinux.cfg/splash.rle
				sed -e "s/.*splash.*//" tftpboot/pxelinux.cfg/boot.txt
			else
				cp -f "${LIVE_SYSLINUX_SPLASH}" tftpboot/pxelinux.cfg/splash.rle
			fi
		fi

		# Configure syslinux templates
		sed -i -e "s@LINUX_LIVE@${LINUX_LIVE}@" -e "s@LINUX_INSTALL@${LINUX_INSTALL}@" -e "s@MEMTEST@${MEMTEST}@" tftpboot/pxelinux.cfg/default
		sed -i -e "s#LIVE_BOOTAPPEND#${LIVE_BOOTAPPEND}#" -e "s/LIVE_NET_SERVER/${LIVE_NET_SERVER}/" -e "s#LIVE_NET_PATH#${LIVE_NET_PATH}#" tftpboot/pxelinux.cfg/default
		sed -i -e "s/LIVE_DATE/`date +%Y%m%d`/" tftpboot/pxelinux.cfg/f1.txt
		sed -i -e "s/LIVE_VERSION/${VERSION}/" tftpboot/pxelinux.cfg/f10.txt

		# Working arround syslinux 8.3 limitation
		if [ "`echo ${LIVE_LINUX_FLAVOURS} | wc -w`" -eq "1" ]
		then
			mv "${DESTDIR_LIVE}"/vmlinuz-*-${LIVE_LINUX_FLAVOURS} "${DESTDIR_LIVE}"/vmlinuz
			mv "${DESTDIR_LIVE}"/initrd.img-*-${LIVE_LINUX_FLAVOURS} "${DESTDIR_LIVE}"/initrd.img
			sed -i -e "s/vmlinuz-.*-${LIVE_LINUX_FLAVOURS}/vmlinuz/g" -e "s/initrd.img-.*-${LIVE_LINUX_FLAVOURS}/initrd.img/g" tftpboot/pxelinux.cfg/default
		fi

		# Remove whitespaces
		sed -i -e 's/\ $//g' tftpboot/pxelinux.cfg/default
		;;

	tar|usb-hdd)
		# Workaround for syslinux (<< 3.36) which doesn't support dedicated directory
		if [ "${LIVE_DISTRIBUTION}" = "etch" ]
		then
			DESTDIR="binary"
		else
			DESTDIR="binary/syslinux"
		fi

		# Copying syslinux
		mkdir -p "${DESTDIR}"

		case "${LIVE_CHROOT_BUILD}" in
			enabled)
				cp chroot/usr/lib/syslinux/isolinux.bin "${DESTDIR}"/syslinux.bin
				;;

			disabled)
				cp /usr/lib/syslinux/isolinux.bin "${DESTDIR}"/syslinux.bin
				;;
		esac

		cp -r "${TEMPLATES}"/* "${DESTDIR}"

		# Copying local configuration file
		if [ -f config/binary_syslinux/syslinux.cfg ]
		then
			cp config/binary_syslinux/syslinux.cfg "${DESTDIR}"/syslinux.cfg
		fi

		# Copying splash screen
		if [ -f config/binary_syslinux/splash.rle ]
		then
			LIVE_SYSLINUX_SPLASH="config/binary_syslinux/splash.rle"
		fi

		if [ -n "${LIVE_SYSLINUX_SPLASH}" ]
		then
			if [ "${LIVE_SYSLINUX_SPLASH}" = "none" ]
			then
				rm -f "${DESTDIR}"/splash.rle
				sed -e "s/.*splash.*//" "${DESTDIR}"/boot.txt
			else
				cp -f "${LIVE_SYSLINUX_SPLASH}" "${DESTDIR}"/splash.rle
			fi
		fi

		# Configure syslinux templates
		sed -i -e "s@LINUX_LIVE@${LINUX_LIVE}@" -e "s@LINUX_INSTALL@${LINUX_INSTALL}@" -e "s@MEMTEST@${MEMTEST}@" "${DESTDIR}"/syslinux.cfg
		sed -i -e "s#LIVE_BOOTAPPEND#${LIVE_BOOTAPPEND}#" "${DESTDIR}"/syslinux.cfg
		sed -i -e "s/LIVE_DATE/`date +%Y%m%d`/" "${DESTDIR}"/f1.txt
		sed -i -e "s/LIVE_VERSION/${VERSION}/" "${DESTDIR}"/f10.txt

		# Workaround for syslinux (<< 3.36) which doesn't support long file/path names
		if [ "`echo ${LIVE_LINUX_FLAVOURS} | wc -w`" -gt "1" ]
		then
			NUMBER="0"

			for FLAVOUR in ${LIVE_LINUX_FLAVOURS}
			do
				NUMBER="$(($NUMBER + 1))"
				mv "${DESTDIR_LIVE}"/vmlinuz-*-${FLAVOUR} "${DESTDIR_LIVE}"/vmlinuz${NUMBER}
				mv "${DESTDIR_LIVE}"/initrd.img-*-${FLAVOUR} "${DESTDIR_LIVE}"/initrd${NUMBER}.img
				sed -i -e "s/vmlinuz-.*-${FLAVOUR}$/vmlinuz${NUMBER}/g" -e "s/initrd.img-.*-${FLAVOUR} /initrd${NUMBER}.img /g" "${DESTDIR}"/syslinux.cfg
			done
		else
			mv "${DESTDIR_LIVE}"/vmlinuz-*-${LIVE_LINUX_FLAVOURS} "${DESTDIR_LIVE}"/vmlinuz
			mv "${DESTDIR_LIVE}"/initrd.img-*-${LIVE_LINUX_FLAVOURS} "${DESTDIR_LIVE}"/initrd.img
			sed -i -e "s/vmlinuz-.*-${LIVE_LINUX_FLAVOURS}/vmlinuz/g" -e "s/initrd.img-.*-${LIVE_LINUX_FLAVOURS}/initrd.img/g" "${DESTDIR}"/syslinux.cfg

			# Remove whitespaces
			sed -i -e 's/\ $//g' "${DESTDIR}"/syslinux.cfg
		fi
		;;
esac

# Saving cache
Save_cache cache/packages_binary

# Removing depends
Remove_package

# Creating stage file
Create_stagefile .stage/binary_syslinux