of-builder.sh

#!/usr/bin/env bash

## of-builder.sh v1.44 (21st September 2024)
##  Builds kernels, modules and images.

if [ $# -lt 5 ]; then
	echo "Usage: $0 <distro> <codename> <apt> <kernel> <output>"
	echo
	echo "  distro   : Distribution name, eg. \"debian\" or \"ubuntu\"."
	echo "  codename : Release codename, eg. \"bullseye\" or \"bionic\"."
	echo "  apt      : An HTTP(S) URL link to the apt source for your chosen distribution."
	echo "  kernel   : An HTTPS URL link to the kernel source in .tar.xz format."
	echo "  output   : Local path for output."
	echo
	exit 1
fi

## Configurable Bits

OURKERNVER="op"
GITREPOURL="https://github.com/birdslikewires"
GITREPOKER="openframe-kernel"
GITREPOLIN="openframe-linux"
COREDIVIDER=1
WEBUSER="www-data"

## Everything Else

THISSCRIPTPATH="$(cd "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P)"
STARTTIME=`date +'%Y-%m-%d-%H%M'`
IDISTNAME="$1"
ICODENAME="$2"
IDOWNLURL="$3"
KBRANCH="$4\."
OUTPUTPATH="$5"
GITKERNELOWNER=$(stat -c '%U' $THISSCRIPTPATH/../$GITREPOKER)
GITLINUXOOWNER=$(stat -c '%U' $THISSCRIPTPATH/../$GITREPOLIN)
GITKERNELUPDATED=0
GITLINUXOUPDATED=0


# Use the URL we're given for the kernel, or figure out the latest archive of that branch to download.
KDOWNLOAD=""
if [[ "$KBRANCH" =~ "https://" ]]; then
	KDOWNLOAD="$KBRANCH"
else
	KARCHIVES=`curl --silent https://www.kernel.org/index.html`
	KDOWNLOAD=`echo "$KARCHIVES" | grep -v "*-rc*" | grep ".xz" | grep -m 1 "linux-$KBRANCH" | awk -F\" {'print $2'}`
fi

if [[ "$KDOWNLOAD" = "" ]]; then
	echo "`date  +'%Y-%m-%d %H:%M:%S'`: Kernel branch $KBRANCH was not found as stable or longterm on the kernel.org homepage."
	exit 1
fi

# Check whether I've been removed from my repo or not. Die if I have.
if [[ ! -d "$THISSCRIPTPATH/../$GITREPOLIN" ]]; then
	echo "`date  +'%Y-%m-%d %H:%M:%S'`: You seem to be running me outside of my repo. I'm not much use without the rest of $GITREPOURL/$GITREPOLIN."
	exit 1
fi

# Check whether we've got the kernel repo available, otherwise kernel builds will obviously fail.
if [[ ! -d "$THISSCRIPTPATH/../$GITREPOKER" ]]; then
	echo "`date  +'%Y-%m-%d %H:%M:%S'`: You're going to need $GITREPOURL/$GITREPOKER as well. Cloning..."
	git clone "$GITREPOURL/$GITREPOKER" "$THISSCRIPTPATH/../$GITREPOKER"
fi

sync
sleep 2

KFILENAME=`echo "$KDOWNLOAD" | sed 's:.*/::'`
KLATESTMAJVER=`echo "$KFILENAME" | awk -F\- {'print $2'} | awk -F\. {'print $1'}`
KLATESTMIDVER=`echo "$KFILENAME" | awk -F\- {'print $2'} | awk -F\. {'print $2'}`
KLATESTMINVER=`echo "$KFILENAME" | awk -F\- {'print $2'} | awk -F\. {'print $3'}`
KOURNAME="$KLATESTMAJVER.$KLATESTMIDVER.$KLATESTMINVER$OURKERNVER"
KOURBUILD="linux-$KLATESTMAJVER.$KLATESTMIDVER.$KLATESTMINVER"

KDLPATH="$OUTPUTPATH/openframe/kernel/$KLATESTMAJVER.$KLATESTMIDVER/$KOURNAME"
[ -d $KDLPATH ] && [ $GITKERNELUPDATED -eq 0 ] && KBUILDIT=0 || KBUILDIT=1

KCONFIGFILE=`ls $THISSCRIPTPATH/../$GITREPOKER/configs | grep "$KLATESTMAJVER.$KLATESTMIDVER"`
if [[ $KCONFIGFILE == "" ]]; then
	echo
	echo "`date  +'%Y-%m-%d %H:%M:%S'`: Build aborted, no config file found for this kernel."
	exit 1
fi

if [[ "$KBUILDIT" == 0 ]]; then
	KSTALE=$(find "$KDLPATH" -maxdepth 0 -mtime +30)
	if [ "$KSTALE" != "" ]; then
		echo "`date  +'%Y-%m-%d %H:%M:%S'`: Kernel $KOURNAME has gone stale. Time to bake a new one!"
		/bin/mv "$KDLPATH" "$KDLPATH-$(date  -d "30 days ago" +'%Y-%m-%d')"
		KBUILDIT=1
	fi
fi

IDLPATH="$OUTPUTPATH/openframe/images/${IDISTNAME,,}/${ICODENAME,,}/$KLATESTMAJVER.$KLATESTMIDVER/$KOURNAME"
[ -d $IDLPATH ] && [ $GITLINUXOUPDATED -eq 0 ] && IBUILDIT=0 || IBUILDIT=1

if [[ "$IBUILDIT" == 0 ]]; then
	ISTALE=$(find "$IDLPATH" -maxdepth 0 -mtime +30)
	if [ "$ISTALE" != "" ]; then
		echo "`date  +'%Y-%m-%d %H:%M:%S'`: Image ${IDISTNAME^} ${ICODENAME^} $KOURNAME has gone stale. Time to bake a new one!"
		/bin/mv "$IDLPATH" "$IDLPATH-$(date  -d "30 days ago" +'%Y-%m-%d')"
		IBUILDIT=1
	fi
fi

## Work To Do!

cleanup() {
	echo -n "`date  +'%Y-%m-%d %H:%M:%S'`: Cleaning up..."
	rm -rf ./$KOURBUILD*
	rm -rf ./*.deb
	rm -rf ./*.img*
	rm -rf ./tmp
	echo " done."
}

if [[ "$KBUILDIT" == 0 ]]; then

	echo "`date  +'%Y-%m-%d %H:%M:%S'`: Kernel $KOURNAME has already been processed."

else

	echo "`date  +'%Y-%m-%d %H:%M:%S'`: Building $KOURNAME kernel..."
	echo

	if [ ! -f "$KFILENAME" ]; then
		echo -n "`date  +'%Y-%m-%d %H:%M:%S'`: Downloading $KFILENAME..."
		wget --quiet "$KDOWNLOAD"
		echo " done."
	else
		echo "`date  +'%Y-%m-%d %H:%M:%S'`: Kernel archive $KFILENAME found."
	fi

	if [ ! -f "$KFILENAME" ]; then
		echo "`date  +'%Y-%m-%d %H:%M:%S'`: Download appears to have failed."
		exit 1
	fi

	if [ -d "$KOURBUILD" ]; then
		echo -n "`date  +'%Y-%m-%d %H:%M:%S'`: Removing previous build cruft..."
		rm -rf "$KOURBUILD"
		rm -rf *.deb
		rm -rf ./tmp/*
		echo " done."
	fi

	echo -n "`date  +'%Y-%m-%d %H:%M:%S'`: Decompressing $KFILENAME..."
	tar xJf $KFILENAME
	echo " done."

	echo "`date  +'%Y-%m-%d %H:%M:%S'`: Applying OpenFrame kernel patches..."
	for p in `ls $THISSCRIPTPATH/../$GITREPOKER/patches/$KLATESTMAJVER.$KLATESTMIDVER`; do
		patch -f -p1 -d "$KOURBUILD" < "$THISSCRIPTPATH/../$GITREPOKER/patches/$KLATESTMAJVER.$KLATESTMIDVER/$p"
	done
	echo

	# This checks through the exit codes so far and kills us if any have been greater than zero.
	RCS=${PIPESTATUS[*]}; RC=0; for i in ${RCS}; do RC=$(($i > $RC ? $i : $RC)); done
	if [[ $RC -gt 0 ]]; then
		echo -n "`date  +'%Y-%m-%d %H:%M:%S'`: Build failed, check the log."
		cleanup
		exit $RC
	fi

	echo -n "`date  +'%Y-%m-%d %H:%M:%S'`: Applying extraversion to makefile..."
	KMAKEFILE=`cat "$KOURBUILD/Makefile"`
	if [[ ! "$KMAKEFILE" =~ "EXTRAVERSION = $OURKERNVER" ]]; then
		sed -i "s/EXTRAVERSION =/EXTRAVERSION = $OURKERNVER/g" "$KOURBUILD/Makefile"
	fi
	echo " done."

	echo "`date  +'%Y-%m-%d %H:%M:%S'`: Updating config file with new defaults..."
	cp "$THISSCRIPTPATH/../$GITREPOKER/configs/$KCONFIGFILE" "$KOURBUILD/.config"
	cd "$KOURBUILD"
	make olddefconfig

	echo
	echo "Go! Go! Go!"
	echo
	make -j$((`nproc`/$COREDIVIDER)) deb-pkg

	RCS=${PIPESTATUS[*]}; RC=0; for i in ${RCS}; do RC=$(($i > $RC ? $i : $RC)); done
	if [[ $RC -gt 0 ]]; then
		echo
		echo "`date  +'%Y-%m-%d %H:%M:%S'`: Build failed, check the log."
		cd ..
		cleanup
		exit $RC
	fi

	echo
	echo "`date  +'%Y-%m-%d %H:%M:%S'`: Kernel $KOURNAME build succeeded!"
	echo

	if [ -d $KDLPATH ]; then
		echo -n "`date  +'%Y-%m-%d %H:%M:%S'`: Removing outdated $KOURNAME kernel..."
		rm -rf $KDLPATH
		echo " done."
	fi

	mkdir -p $KDLPATH
	cd ..
	echo -n "`date  +'%Y-%m-%d %H:%M:%S'`: Moving kernel $KOURNAME packages..."
	mv *.deb $KDLPATH
	echo " done."
	echo -n "`date  +'%Y-%m-%d %H:%M:%S'`: Copying kernel $KOURNAME config file..."
	cp "$KOURBUILD/.config" "$KDLPATH/$KOURNAME.config"
	echo " done."
	echo -n "`date  +'%Y-%m-%d %H:%M:%S'`: Copying kernel $KOURNAME patches..."
	cp -R "$THISSCRIPTPATH/../$GITREPOKER/patches/$KLATESTMAJVER.$KLATESTMIDVER" "$KDLPATH/patches"
	echo " done."
	echo
	cleanup
	echo
	echo "`date  +'%Y-%m-%d %H:%M:%S'`: Kernel compiled, packages ready."
	echo
	echo

fi

if [ -f $KDLPATH/modules-$KOURNAME.tgz ]; then

	echo "`date  +'%Y-%m-%d %H:%M:%S'`: Modules for kernel $KOURNAME have already been processed."

else

	echo "`date  +'%Y-%m-%d %H:%M:%S'`: Building $KOURNAME kernel companion modules..."

	[ ! -d /lib/modules/$KOURNAME ] && dpkg -i $KDLPATH/linux-headers*

	if [[ "$KLATESTMAJVER" -lt 4 ]]; then

		## RTL8821CU Wireless Support
		[ -d rtl8821cu_wlan ] && rm -rf rtl8821cu_wlan
		git clone https://github.com/andydvsn/rtl8821cu_wlan.git
		mkdir -p lib/modules/$KOURNAME/kernel/drivers/net/wireless
		sed -i 's/KVER  := $(shell uname -r)/KVER  := '$KOURNAME'/g' "./rtl8821cu_wlan/Makefile"
		cd rtl8821cu_wlan
		make -j`nproc`
		cd ..
		cp rtl8821cu_wlan/rtl8821cu.ko lib/modules/$KOURNAME/kernel/drivers/net/wireless
		rm -rf rtl8821cu_wlan

		## RTL8821CU Bluetooth Support
		[ -d rtl8821cu_bt ] && rm -rf rtl8821cu_bt
		git clone https://github.com/andydvsn/rtl8821cu_bt.git
		mkdir -p lib/modules/$KOURNAME/kernel/drivers/bluetooth
		cd rtl8821cu_bt/bluetooth_usb_driver
		make -C /lib/modules/$KOURNAME/build M=`pwd` modules
		cd ../..
		cp rtl8821cu_bt/bluetooth_usb_driver/rtk_btusb.ko lib/modules/$KOURNAME/kernel/drivers/bluetooth
		rm -rf rtl8821cu_bt

	fi

	## Crystal HD Driver
	# [ -d crystalhd ] && rm -rf crystalhd
	# git clone https://github.com/birdslikewires/crystalhd.git
	# mkdir -p etc/udev/rules.d
	# mkdir -p lib/udev/rules.d
	# mkdir -p lib/modules/$KOURNAME/kernel/drivers/video/broadcom
	# cd crystalhd/driver/linux
	# autoconf
	# ./configure
	# make -C /lib/modules/$KOURNAME/build M=`pwd`
	# cd ../../..
	# cp crystalhd/driver/linux/20-crystalhd.rules etc/udev/rules.d
	# cp crystalhd/driver/linux/20-crystalhd.rules lib/udev/rules.d
	# cp crystalhd/driver/linux/crystalhd.ko lib/modules/$KOURNAME/kernel/drivers/video/broadcom
	# rm -rf crystalhd

	## Firmware Hub Module
	[ -d fh ] && rm -rf fh
	git clone https://github.com/andydvsn/fh.git
	mkdir -p lib/modules/$KOURNAME/extra
	cd fh
	make -C /lib/modules/$KOURNAME/build M=`pwd` modules
	cd ..
	cp fh/fh.ko lib/modules/$KOURNAME/extra
	rm -rf fh

	echo
	echo "`date  +'%Y-%m-%d %H:%M:%S'`: Companion modules done, but check the log above. Compressing and moving..."
	#tar zcvf modules-$KOURNAME.tgz etc lib
	tar zcvf modules-$KOURNAME.tgz lib
	rm -rf lib
	mv modules-$KOURNAME.tgz $KDLPATH

	echo
	cleanup
	echo
	echo "`date  +'%Y-%m-%d %H:%M:%S'`: Companion modules ready."
	echo
	echo

fi

if [[ "$IBUILDIT" == 0 ]]; then

	echo "`date  +'%Y-%m-%d %H:%M:%S'`: Image for kernel $KOURNAME has already been processed."

else

	echo "`date  +'%Y-%m-%d %H:%M:%S'`: Building ${IDISTNAME^} ${ICODENAME^} $KOURNAME image..."
	echo

	rm -rf ./*.img*

	$THISSCRIPTPATH/of-imgcreate.sh "$(echo ${ICODENAME,,} | head -c 3)" ext2 1 uni 43 "${IDISTNAME,,} ${ICODENAME,,}" "$THISSCRIPTPATH/../$GITREPOLIN/overlay-${IDISTNAME,,}-${ICODENAME,,}" "$KDLPATH" "$IDOWNLURL"

	# This checks through the exit codes so far and kills us if any have been greater than zero.
	RCS=${PIPESTATUS[*]}; RC=0; for i in ${RCS}; do RC=$(($i > $RC ? $i : $RC)); done
	if [[ $RC -gt 0 ]]; then
		echo -n "`date  +'%Y-%m-%d %H:%M:%S'`: Build failed, check the log."
		cleanup
		exit $RC
	fi

	echo -n "`date  +'%Y-%m-%d %H:%M:%S'`: Compressing and checkumming..."
	IBUILTIT=`ls | grep -m 1 .img`
	gzip $IBUILTIT
	md5sum $IBUILTIT.gz > $IBUILTIT.gz.md5
	echo " done."

	if [ -d $IDLPATH ]; then
		echo -n "`date  +'%Y-%m-%d %H:%M:%S'`: Removing outdated ${IDISTNAME^} ${ICODENAME^} $KOURNAME image..."
		rm -rf $IDLPATH
		echo " done."
	fi

	echo -n "`date  +'%Y-%m-%d %H:%M:%S'`: Moving to webserver..."
	mkdir -p $IDLPATH
	mv ./*.img* $IDLPATH
	chown -R $WEBUSER: $IDLPATH
	chmod 775 $IDLPATH
	chmod 664 $IDLPATH/*
	rm "$OUTPUTPATH/openframe/images/${IDISTNAME,,}/${ICODENAME,,}/latest" 2>/dev/null
	ln -s "$IDLPATH" "$OUTPUTPATH/openframe/images/${IDISTNAME,,}/${ICODENAME,,}/latest"
	echo " done."
	echo
	echo "`date  +'%Y-%m-%d %H:%M:%S'`: Image build completed."
	echo
	echo

fi

cleanup

exit 0