build-linuxdeployimg-gtk4.sh

#!/usr/bin/env bash
#
# Create a AppImage for the given MXL product.
#
set -eo pipefail
set -x

check_arguments() {
	local BUILD_TYPE="$1"
	local BINARY="$2"
	local BUILD_DIR="$3"
	local PKG_DIR="$4"
	local RESULT_DIR="$5"
	local USAGE="Usage: $0 <build-type> <binary> <build-directory> <pkgdir> <result-directory>"

	if [ -z ${BUILD_TYPE} ]; then
		printf "\n${USAGE}\n\n"
		exit 1
	fi
	if [ -z ${BINARY} ]; then
		printf "\n${USAGE}\n\n"
		exit 1
	fi
	if [ -z ${BUILD_DIR} ]; then
		printf "\n${USAGE}\n\n"
		exit 1
	fi
	if [ -z ${PKG_DIR} ]; then
		printf "\n${USAGE}\n\n"
		exit 1
	fi
	if [ -z ${RESULT_DIR} ]; then
		printf "\n${USAGE}\n\n"
		exit 1
	fi
}

extract_debug_and_strip() {
	local FILENAME="$1"
	local DEBUG_FILENAME="$2"

	echo "stripping ${FILENAME}, putting debug info into ${DEBUG_FILENAME}"
	objcopy --only-keep-debug "${FILENAME}" "${DEBUG_FILENAME}"
	strip --strip-debug --strip-unneeded "${FILENAME}"
	objcopy --add-gnu-debuglink="${DEBUG_FILENAME}" "${FILENAME}"
	chmod -x "${DEBUG_FILENAME}"
}

main() {
	local BUILD_TYPE="$1"
	local BINARY="$2"
	local BUILD_DIR="$3"
	local PKG_DIR="$4"
	local RESULT_DIR=""
	RESULT_DIR="$(set -e;pwd)/$5"
	local SRC_DIR=""
	SRC_DIR="$(set -e;pwd)"
	local SCRIPT_DIR=""
	SCRIPT_DIR="$(set -e;dirname $0)"
	SCRIPT_DIR="$(set -e;realpath ${SCRIPT_DIR})"

	check_arguments "${BUILD_TYPE}" "${BINARY}" "${BUILD_DIR}" "${PKG_DIR}" "${RESULT_DIR}"

	. ${SRC_DIR}/.build-env
	${SCRIPT_DIR}/check-build-env.sh

	local VERSION_PREFIX=""
	if [ "${BUILD_TYPE}" != "release" ]; then
		VERSION_PREFIX="debug-"
		sed -i 's#Name=\(.*\)#Name=\1 debug#' ${BUILD_DIR}/${PKG_DIR}/usr/share/applications/${APP_ID}.desktop
	fi

	local VERSION=""
	VERSION="${VERSION_PREFIX}$(set -e;cargo version-util get-version)"

	local PACKAGE_NAME="${PACKAGE}-${VERSION}-$(set -e;uname)-$(set -e;arch)"

	cargo install --version 0.1.3 sancus

	local TRIPLET="$(set -e;${SCRIPT_DIR}/get-vcpkg-triplet.py)"

	mkdir -p vcpkg_installed/${TRIPLET}/lib/gtk-4.0
	pushd "${BUILD_DIR}"


	local CENTOS7_LIBS=""
	if [[ $(set -e;lsb_release -sir) == CentOS\ 7* ]]; then
		# These libraries must be deployed manually for centos7 because of too old system library versions
		CENTOS7_LIBS="--library ../vcpkg_installed/${TRIPLET}/lib/libfribidi.so.0 \
					  --library ../vcpkg_installed/${TRIPLET}/lib/libz.so.1 \
					  --library ../vcpkg_installed/${TRIPLET}/lib/libfontconfig.so.1 \
					  --library ../vcpkg_installed/${TRIPLET}/lib/libfreetype.so.6"

		# On Ubuntu 16.04.2 LTS libwayland-client.so.0 is too old for the version required by GTK 4.16
		CENTOS7_LIBS="${CENTOS7_LIBS} --library /usr/local/lib64/libwayland-client.so.0"
	fi

	LD_LIBRARY_PATH="${VCPKG_INSTALL_LIB_PATH}${LD_LIBRARY_PATH:+:${LD_LIBRARY_PATH}}" NO_STRIP=1 DEPLOY_GTK_VERSION="4" GSTREAMER_INCLUDE_BAD_PLUGINS="1" GSTREAMER_PLUGINS_DIR="${VCPKG_INSTALL_PLUGINS_PATH}/gstreamer" GSTREAMER_HELPERS_DIR="${VCPKG_INSTALL_PATH}/tools/gstreamer" DEBUG="1" LD_GTK_LIBRARY_PATH="${VCPKG_INSTALL_LIB_PATH}" linuxdeploy \
		--verbosity=0 --appdir ${PKG_DIR} --plugin gstreamer --plugin gtk \
		--library ../vcpkg_installed/${TRIPLET}/lib/libharfbuzz.so.0 \
		--library ../vcpkg_installed/${TRIPLET}/lib/librsvg-*.so \
		${CENTOS7_LIBS} \
		${ADDITIONAL_LINUXDEPLOY_ARGS} \
		--executable ${PKG_DIR}/usr/bin/${BINARY} \
		--desktop-file ${PKG_DIR}/usr/share/applications/${APP_ID}.desktop

	# Remove some libraries/files manually...
	# The linuxdeploy --exclude-library argument does not work for plugins like linuxdeploy-plugin-gtk.

	# libGLESv2 is linked to libglapi.so which is already excluded by the official exclusion list.
	# https://github.com/AppImageCommunity/pkg2appimage/blob/master/excludelist
	echo "Remove libGLESv2 that should be provided by proprietary drivers"
	rm -f ${PKG_DIR}/usr/lib/libGLESv2.so.2

	# libva* libraries should be used from the system
	echo "Remove libva* libraries"
	rm -f ${PKG_DIR}/usr/lib/libva.so.2
	rm -f ${PKG_DIR}/usr/lib/libva-x11.so.2
	rm -f ${PKG_DIR}/usr/lib/libva-wayland.so.2
	rm -f ${PKG_DIR}/usr/lib/libva-drm.so.2

	pushd ${PKG_DIR}
	echo "Fix Gdk-Pixbuf plugin libpixbufloader-svg.so"
	local LIBPIXBUFLOADER="usr/lib/libpixbufloader-svg.so"
    if [ -f ${LIBPIXBUFLOADER} ]; then
        local LINK=""
        LINK="$(set -e;readlink -m ${LIBPIXBUFLOADER})"
        rm -f ${LIBPIXBUFLOADER}
        ln -rs ${LINK} ${LIBPIXBUFLOADER}

		local LINK_DIR=""
		LINK_DIR="$(set -e;dirname ${LINK})"
		local LINK_REL_PATH=""
		LINK_REL_PATH="$(set -e;realpath --relative-to=${LINK_DIR} usr/lib)"
		echo /opt/linuxdeploy/usr/bin/patchelf --force-rpath --set-rpath '$ORIGIN'/${LINK_REL_PATH} ${LINK}
		/opt/linuxdeploy/usr/bin/patchelf --force-rpath --set-rpath '$ORIGIN'/${LINK_REL_PATH} ${LINK}
    fi

	echo "Update the Gdk-Pixbuf loaders.cache"
	local GDK_PIXBUF_BINARY_VERSION=""
	GDK_PIXBUF_BINARY_VERSION="$(pkg-config gdk-pixbuf-2.0 --variable=gdk_pixbuf_binary_version)"
	if [ "${GDK_PIXBUF_BINARY_VERSION}" != "" ]; then
		local PKG_DIR_FULL=""
		PKG_DIR_FULL="$(set -e;pwd)"

		local GDK_PIXBUF_QUERY_LOADERS="${SRC_DIR}/vcpkg_installed/${MXL_VCPKG_TRIPLET}/tools/gdk-pixbuf/gdk-pixbuf-query-loaders"
		local GDK_PIXBUF_LOADER_DIR="${PKG_DIR_FULL}/usr/lib/gdk-pixbuf-2.0/${GDK_PIXBUF_BINARY_VERSION}"

		export GDK_PIXBUF_MODULEDIR="${GDK_PIXBUF_LOADER_DIR}/loaders"
		export GDK_PIXBUF_MODULE_FILE="${GDK_PIXBUF_LOADER_DIR}/loaders.cache"
		# Set LD_LIBRARY_PATH to find all dependencies of the GdkPixbuf plugins:
		LD_LIBRARY_PATH="${VCPKG_INSTALL_LIB_PATH}${LD_LIBRARY_PATH:+:${LD_LIBRARY_PATH}}" ${GDK_PIXBUF_QUERY_LOADERS} --update-cache

		# Check that the loaders.cache contains at least one plugin
		if [ "$(set -e;cat ${GDK_PIXBUF_MODULE_FILE} | grep -v "^#" | wc -l)" == "0" ]; then
			echo "ERROR: file ${GDK_PIXBUF_MODULE_FILE} contains no plugin"
			exit 1
		fi

		# Make gdk-pixbuf directory relative in loaders.cache
		sed -i "s|${PKG_DIR_FULL}/usr/||g" ${GDK_PIXBUF_MODULE_FILE}
	fi

	echo "Fix apprun-hooks"
	for HOOK in $(ls apprun-hooks/*); do
		sed -i 's#pkgconfig/..##g' ${HOOK}
		sed -i "s#${SRC_DIR}/vcpkg_installed/$(set -e;${SCRIPT_DIR}/get-vcpkg-triplet.py)/##g" ${HOOK}
	done

	local SOURCES_FIX_DIR=""
	local SOURCES_FIX_DIR=".${SRC_DIR}/vcpkg_installed/$(set -e;${SCRIPT_DIR}/get-vcpkg-triplet.py)"
	if [ -d ${SOURCES_FIX_DIR} ]; then
		rsync -a ${SOURCES_FIX_DIR}/* usr
		local SOURCES_BASE_DIR=""
		SOURCES_BASE_DIR="$(set -e;echo ${SOURCES_FIX_DIR} | cut -d "/" -f2)"
		rm -rf ${SOURCES_BASE_DIR}
	fi

	# Run binary directly:
	sed -i "s#AppRun.wrapped#usr/bin/${BINARY}#g" AppRun
	rm AppRun.wrapped
	popd

	# Set APPDIR variable for apprun-hooks:
	sed -i 's#source "$this_dir"/apprun-hooks/"linuxdeploy-plugin-gstreamer.sh"#APPDIR=$this_dir\nsource "$this_dir"/apprun-hooks/"linuxdeploy-plugin-gstreamer.sh"#g' ${PKG_DIR}/AppRun

	# Disable GTK_THEME variable, because it destroys the System theming and breaks icon presentation:
	sed -i 's%export GTK_THEME="$APPIMAGE_GTK_THEME"%#export GTK_THEME="$APPIMAGE_GTK_THEME"%g' ${PKG_DIR}/apprun-hooks/linuxdeploy-plugin-gtk.sh

	mkdir -p "${RESULT_DIR}"

	# Extract debug information and stripping libraries and binary files:
	# Note: do not strip gstreamer binaries like gst-inspect - they will be corrupted and crash (mime-type: application/x-executable)
	local BUILD_DIR_ABS=${PWD}
	pushd ${PKG_DIR}
	find . -type f -exec file --mime-type "{}" \; > "${BUILD_DIR_ABS}/pkg_file_list.txt"
	local DEBUG_FILENAMES=""
	for FILE_NAME in $(cat "${BUILD_DIR_ABS}/pkg_file_list.txt" | grep ": application/x-sharedlib" | awk -F': application/x-sharedlib' '{print $1}'); do
		local DEBUG_FILENAME="${FILE_NAME}.debug"
		extract_debug_and_strip "${FILE_NAME}" "${DEBUG_FILENAME}"
		DEBUG_FILENAMES="${DEBUG_FILENAMES} ${DEBUG_FILENAME}"
	done
	tar -cJf "${RESULT_DIR}/${PACKAGE_NAME}.debuginfo.tar.xz" ${DEBUG_FILENAMES}
	rm ${DEBUG_FILENAMES}
	popd

	sancus create --package-name ${PACKAGE} --project-path ${SRC_DIR} --package-path ${PKG_DIR} \
		--result-path ${LICENSES_DIR} --additional-third-party-licenses ${LICENSES_DIR}/${BINARY}_third_party_licenses.json \
		${ADDITIONAL_SANCUS_ARGS} 2>&1 | tee ${RESULT_DIR}/sancus.log

	pushd ${PKG_DIR}
	tar -cJf "${RESULT_DIR}/${PACKAGE_NAME}.tar.xz" *
	popd

	popd
}

main "$1" "$2" "$3" "$4" "$5" "$6"