merge exec.so and localefix.so into a single common library (#137)

Author: Samueru-sama

useful-tools/demo/gtk3-demo-appimage.sh

@@ -6,11 +6,12 @@ set -eux
 
 ARCH="$(uname -m)"
 SHARUN="https://raw.githubusercontent.com/pkgforge-dev/Anylinux-AppImages/refs/heads/main/useful-tools/quick-sharun.sh"
-URUNTIME="https://raw.githubusercontent.com/pkgforge-dev/Anylinux-AppImages/refs/heads/main/useful-tools/uruntime2appimage.sh"
 EXTRA_PACKAGES="https://raw.githubusercontent.com/pkgforge-dev/Anylinux-AppImages/refs/heads/main/useful-tools/get-debloated-pkgs.sh"
 
 export ICON=DUMMY
+export ANYLINUX_LIB=1
 export DESKTOP=DUMMY
+export OUTPATH=./dist
 export OUTNAME=gtk3-demo-"$ARCH".AppImage
 
 pacman -Syu --noconfirm \
@@ -43,10 +44,5 @@ wget --retry-connrefused --tries=30 "$SHARUN" -O ./quick-sharun
 chmod +x ./quick-sharun
 ./quick-sharun /usr/bin/gtk3-demo
 
-wget --retry-connrefused --tries=30 "$URUNTIME" -O ./uruntime2appimage
-chmod +x ./uruntime2appimage
-./uruntime2appimage
-mkdir -p ./dist
-mv -v ./*.AppImage ./dist
+./quick-sharun --make-appimage
 
-echo "All Done!"

useful-tools/demo/gtk4-demo-appimage.sh

@@ -6,12 +6,13 @@ set -eux
 
 ARCH="$(uname -m)"
 SHARUN="https://raw.githubusercontent.com/pkgforge-dev/Anylinux-AppImages/refs/heads/main/useful-tools/quick-sharun.sh"
-URUNTIME="https://raw.githubusercontent.com/pkgforge-dev/Anylinux-AppImages/refs/heads/main/useful-tools/uruntime2appimage.sh"
 EXTRA_PACKAGES="https://raw.githubusercontent.com/pkgforge-dev/Anylinux-AppImages/refs/heads/main/useful-tools/get-debloated-pkgs.sh"
 
 export DEPLOY_OPENGL=1
+export ANYLINUX_LIB=1
 export ICON=DUMMY
 export DESKTOP=DUMMY
+export OUTPATH=./dist
 export OUTNAME=gtk4-demo-"$ARCH".AppImage
 
 pacman -Syu --noconfirm \
@@ -44,10 +45,5 @@ wget --retry-connrefused --tries=30 "$SHARUN" -O ./quick-sharun
 chmod +x ./quick-sharun
 ./quick-sharun /usr/bin/gtk4-demo
 
-wget --retry-connrefused --tries=30 "$URUNTIME" -O ./uruntime2appimage
-chmod +x ./uruntime2appimage
-./uruntime2appimage
-mkdir -p ./dist
-mv -v ./*.AppImage ./dist
+./quick-sharun --make-appimage
 
-echo "All Done!"

useful-tools/demo/vkcube-glxgears-appimage.sh

@@ -6,13 +6,14 @@ set -eux
 
 ARCH="$(uname -m)"
 SHARUN="https://raw.githubusercontent.com/pkgforge-dev/Anylinux-AppImages/refs/heads/main/useful-tools/quick-sharun.sh"
-URUNTIME="https://raw.githubusercontent.com/pkgforge-dev/Anylinux-AppImages/refs/heads/main/useful-tools/uruntime2appimage.sh"
 EXTRA_PACKAGES="https://raw.githubusercontent.com/pkgforge-dev/Anylinux-AppImages/refs/heads/main/useful-tools/get-debloated-pkgs.sh"
 
 export DEPLOY_OPENGL=1
 export DEPLOY_VULKAN=1
+export ANYLINUX_LIB=1
 export ICON=DUMMY
 export DESKTOP=DUMMY
+export OUTPATH=./dist
 export OUTNAME=vkcube+glxgears-demo-"$ARCH".AppImage
 
 pacman -Syu --noconfirm \
@@ -44,10 +45,5 @@ wget --retry-connrefused --tries=30 "$SHARUN" -O ./quick-sharun
 chmod +x ./quick-sharun
 ./quick-sharun /usr/bin/vkcube /usr/bin/glxgears
 
-wget --retry-connrefused --tries=30 "$URUNTIME" -O ./uruntime2appimage
-chmod +x ./uruntime2appimage
-./uruntime2appimage
-mkdir -p ./dist
-mv -v ./*.AppImage ./dist
+./quick-sharun --make-appimage
 
-echo "All Done!"

useful-tools/lib/exec.c useful-tools/lib/anylinux.cuseful-tools/lib/exec.c renamed to useful-tools/lib/anylinux.c

@@ -8,6 +8,13 @@
  * mode is used, where for example the HOME var from the portable .home dir would
  * be inherited by other processes launched by the appimage in portable mode
  * causing them to start using the fake .home dir instead of the real home
+ *
+ * It also sets LC_ALL=C if it detects the application will fail to switch locale
+ * While we normally bundle locales with quick-sharun and apps have working
+ * language interface, we do not bundle the libc locale because glibc
+ * has issues when LOCPATH is used This means some applications like dolphin-emu
+ * crash when glibc cannot switch locale even though the application itself can
+ * This library checks that and forces the C locale instead to prevent crashes
 */
 
 #ifndef _GNU_SOURCE
@@ -22,20 +29,36 @@
 #include <unistd.h>
 #include <fcntl.h>
 #include <errno.h>
+#include <locale.h>
 
 typedef int (*execve_func_t)(const char *filename, char *const argv[], char *const envp[]);
 
+#define LOG(fmt, ...) fprintf(stderr, " [anylinux.so] LOCALEFIX >> " fmt "\n", ##__VA_ARGS__)
+
+__attribute__((constructor))
+static void locale_fix_init(void) {
+	if (!setlocale(LC_ALL, "")) {
+		LOG("Failed to set locale, falling back to C locale.");
+		if (!setlocale(LC_ALL, "C")) {
+			LOG("Failed to setlocale(LC_ALL, \"C\"): %s", strerror(errno));
+		}
+		if (setenv("LC_ALL", "C", 1) != 0) {
+			LOG("Failed to setenv(LC_ALL, \"C\"): %s", strerror(errno));
+		}
+	}
+}
+
 #define VISIBLE __attribute__ ((visibility ("default")))
 
 // print to stderr when APPIMAGE_EXEC_DEBUG=1
 static int appimage_exec_debug_enabled(void) {
-	const char *v = getenv("APPIMAGE_EXEC_DEBUG");
+	const char *v = getenv("ANYLINUX_LIB_DEBUG");
 	return v && strcmp(v, "1") == 0;
 }
 
 #define DEBUG_PRINT(...) do \
 	if (appimage_exec_debug_enabled()) \
-		fprintf(stderr, "APPIMAGE_EXEC>> " __VA_ARGS__); \
+		fprintf(stderr, " [anylinux.so] >> " __VA_ARGS__); \
 	while (0)
 
 // problematic vars to check
@@ -185,8 +208,19 @@ static int exec_common(execve_func_t function, const char *filename, char* const
 			DEBUG_PRINT("Error creating cleaned environment; using original env\n");
 			env = envp;
 		}
-	} else
-		DEBUG_PRINT("Internal process; leaving environment unchanged\n");
+	} else {
+		const char *basename = strrchr(filename, '/');
+		basename = basename ? basename + 1 : filename;
+		if (strcmp(basename, "xdg-open") == 0 || strcmp(basename, "gio-launch-desktop") == 0) {
+			DEBUG_PRINT("Internal process detected (%s); cleaning environment anyway since this is needed\n", basename);
+			env = create_cleaned_env(envp);
+			if (!env) {
+				DEBUG_PRINT("Error creating cleaned environment; using original env\n");
+				env = envp;
+			}
+		} else
+			DEBUG_PRINT("Internal process; leaving environment unchanged\n");
+	}
 
 	DEBUG_PRINT("Calling exec for %s\n", filename);
 	int ret = function(filename, argv, env);

useful-tools/lib/localefix.c

@@ -21,10 +21,8 @@ SHARUN_LINK=${SHARUN_LINK:-https://github.com/VHSgunzo/sharun/releases/latest/do
 HOOKSRC=${HOOKSRC:-https://raw.githubusercontent.com/pkgforge-dev/Anylinux-AppImages/refs/heads/main/useful-tools/hooks}
 LD_PRELOAD_OPEN=${LD_PRELOAD_OPEN:-https://github.com/VHSgunzo/pathmap.git}
 
-EXEC_WRAPPER=${EXEC_WRAPPER:-0}
-EXEC_WRAPPER_SOURCE=${EXEC_WRAPPER_SOURCE:-https://raw.githubusercontent.com/pkgforge-dev/Anylinux-AppImages/refs/heads/main/useful-tools/lib/exec.c}
-LOCALE_FIX=${LOCALE_FIX:-0}
-LOCALE_FIX_SOURCE=${LOCALE_FIX_SOURCE:-https://raw.githubusercontent.com/pkgforge-dev/Anylinux-AppImages/refs/heads/main/useful-tools/lib/localefix.c}
+ANYLINUX_LIB=${ANYLINUX_LIB:-0}
+ANYLINUX_LIB_SOURCE=${ANYLINUX_LIB_SOURCE:-https://raw.githubusercontent.com/pkgforge-dev/Anylinux-AppImages/refs/heads/main/useful-tools/lib/anylinux.c}
 NOTIFY_SOURCE=${NOTIFY_SOURCE:-https://raw.githubusercontent.com/pkgforge-dev/Anylinux-AppImages/refs/heads/main/useful-tools/bin/notify}
 APPRUN_SOURCE=${APPRUN_SOURCE:-https://raw.githubusercontent.com/pkgforge-dev/Anylinux-AppImages/refs/heads/main/useful-tools/bin/AppRun-generic}
 URUNTIME2APPIMAGE_SOURCE=${URUNTIME2APPIMAGE_SOURCE:-https://raw.githubusercontent.com/pkgforge-dev/Anylinux-AppImages/refs/heads/main/useful-tools/uruntime2appimage.sh}
@@ -49,6 +47,11 @@ DEPENDENCIES="
 	tr
 "
 
+# keep this for backwards compat until all existing scripts have been updated
+if [ "$EXEC_WRAPPER" = 1 ] || [ "$LOCALE_FIX" = 1 ]; then
+	ANYLINUX_LIB=1
+fi
+
 # check if the _tmp_* vars have not be declared already
 # likely to happen if this script run more than once
 PATH_MAPPING_SCRIPT="$APPDIR"/bin/path-mapping-hardcoded.src.hook
@@ -165,10 +168,8 @@ _help_msg() {
 	  LIB_DIR          Set source library directory if autodetection fails.
 	  NO_STRIP         Disable stripping binaries and libraries if set.
 	  APPDIR           Destination AppDir (default: ./AppDir).
-	  EXEC_WRAPPER     Preloads a library that unsets environment variables known to cause
-	                   problems to child processes. Not needed if the app will just use
-	                   xdg-open to spawn child proceeses since in that case sharun has
-	                   a wrapper for xdg-open that handles that.
+	  ANYLINUX_LIB     Preloads a library that unsets environment variables known to cause
+	                   problems to child processes. Set to 0 to disable.
 
 	  PATH_MAPPING    Configures and preloads pathmap.
 	                  Set this variable if the application is hardcoded to look
@@ -202,11 +203,8 @@ _sanity_check() {
 		fi
 	done
 
-	if [ "$EXEC_WRAPPER" = 1 ] && ! command -v cc 1>/dev/null; then
-		_err_msg "ERROR: Using EXEC_WRAPPER requires cc"
-		exit 1
-	elif [ "$LOCALE_FIX" = 1 ] && ! command -v cc 1>/dev/null; then
-		_err_msg "ERROR: Using LOCALE_FIX requires cc"
+	if [ "$ANYLINUX_LIB" = 1 ] && ! command -v cc 1>/dev/null; then
+		_err_msg "ERROR: Using ANYLINUX_LIB requires cc"
 		exit 1
 	elif [ "$DEPLOY_PYTHON" = 1 ] && [ "$DEPLOY_SYS_PYTHON" = 1 ]; then
 		_err_msg "ERROR: DEPLOY_PYTHON and DEPLOY_SYS_PYTHON cannot be both enabled!"
@@ -796,17 +794,18 @@ _handle_bins_scripts() {
 
 }
 
-_add_exec_wrapper() {
-	if [ "$EXEC_WRAPPER" != 1 ]; then
+_add_anylinux_lib() {
+	if [ "$ANYLINUX_LIB" != 1 ]; then
 		return 0
 	fi
 
-	_echo "* Building exec.so..."
-	_download "$TMPDIR"/exec.c "$EXEC_WRAPPER_SOURCE"
-	cc -shared -fPIC "$TMPDIR"/exec.c -o "$APPDIR"/lib/exec.so
-	echo "exec.so" >> "$APPDIR"/.preload
+	_echo "* Building anylinux.so..."
+	_download "$APPDIR"/.anylinux.c "$ANYLINUX_LIB_SOURCE"
+	cc -shared -fPIC "$APPDIR"/.anylinux.c -o "$APPDIR"/lib/anylinux.so
+	echo "anylinux.so" >> "$APPDIR"/.preload
 
-	# remove xdg-open wrapper not needed when exec.so is in use
+	# remove xdg-open wrapper not needed when the lib is in use
+	# we still need to have a wrapper for gio-launch-desktop though
 	if [ -f "$APPDIR"/bin/gio-launch-desktop ]; then
 		rm -f "$APPDIR"/bin/gio-launch-desktop
 		cat <<-'EOF' > "$APPDIR"/bin/gio-launch-desktop
@@ -817,17 +816,7 @@ _add_exec_wrapper() {
 		chmod +x "$APPDIR"/bin/gio-launch-desktop
 	fi
 	rm -f "$APPDIR"/bin/xdg-open
-	_echo "* EXEC_WRAPPER successfully added!"
-}
-
-_add_locale_fix() {
-	if [ "$LOCALE_FIX"  = 1 ] && [ ! -f "$APPDIR"/lib/localefix.so ]; then
-		_echo "* Building localefix.so..."
-		_download "$TMPDIR"/localefix.c "$LOCALE_FIX_SOURCE"
-		cc -shared -fPIC "$TMPDIR"/localefix.c -o "$APPDIR"/lib/localefix.so
-		echo "localefix.so" >> "$APPDIR"/.preload
-		_echo "* LOCALE_FIX successfully added!"
-	fi
+	_echo "* anylinux.so successfully added!"
 }
 
 _map_paths_ld_preload_open() {
@@ -1295,8 +1284,7 @@ echo ""
 _deploy_icon_and_desktop
 _map_paths_ld_preload_open
 _map_paths_binary_patch
-_add_exec_wrapper
-_add_locale_fix
+_add_anylinux_lib
 _deploy_datadir
 _deploy_locale
 _check_window_class