Linux: Update Deployment

Author: HTRamsey

cmake/CustomOptions.cmake

@@ -69,7 +69,13 @@ set(QGC_MACOS_ENTITLEMENTS_PATH "${CMAKE_SOURCE_DIR}/deploy/macos/qgroundcontrol
 # option(QGC_MACOS_UNIVERSAL_BUILD "Build MacOS Universal Build (arm64;x86_64)" ON) # MACOS
 
 # Linux
-set(QGC_APPIMAGE_ICON_PATH "${CMAKE_SOURCE_DIR}/resources/icons/qgroundcontrol.png" CACHE FILEPATH "AppImage Icon Path")
+option(QGC_CREATE_APPIMAGE "Build an AppImage after build" ON)
+set(QGC_APPIMAGE_ICON_256_PATH "${CMAKE_SOURCE_DIR}/deploy/linux/QGroundControl_256.png" CACHE FILEPATH "AppImage Icon 256x256 Path")
+set(QGC_APPIMAGE_ICON_SCALABLE_PATH "${CMAKE_SOURCE_DIR}/deploy/linux/QGroundControl.svg" CACHE FILEPATH "AppImage Icon SVG Path")
+set(QGC_APPIMAGE_APPRUN_PATH "${CMAKE_SOURCE_DIR}/deploy/linux/AppRun" CACHE FILEPATH "AppImage AppRun Path")
+set(QGC_APPIMAGE_DESKTOP_ENTRY_PATH "${CMAKE_SOURCE_DIR}/deploy/linux/org.mavlink.qgroundcontrol.desktop.in" CACHE FILEPATH "AppImage Desktop Entry Path")
+set(QGC_APPIMAGE_METADATA_PATH "${CMAKE_SOURCE_DIR}/deploy/linux/org.mavlink.qgroundcontrol.appdata.xml.in" CACHE FILEPATH "AppImage Metadata Path")
+set(QGC_APPIMAGE_APPDATA_DEVELOPER "qgroundcontrol" CACHE STRING "AppImage Metadata Developer")
 
 # Windows
 set(QGC_WINDOWS_INSTALL_HEADER_PATH "${CMAKE_SOURCE_DIR}/deploy/windows/installheader.bmp" CACHE FILEPATH "Windows Install Header Path")

cmake/install/CreateAppImage.cmake

@@ -1,43 +1,70 @@
-message(STATUS "Creating AppImage")
-# TODO: https://github.com/AppImageCommunity/AppImageUpdate
+# TODO: # go-appimage, updateinformation w/ GitHub Releases, signing
+
+message(STATUS "QGC: Creating AppImage")
 
 set(APPDIR_PATH "${CMAKE_BINARY_DIR}/AppDir")
-set(APPIMAGETOOL_PATH "${CMAKE_BINARY_DIR}/appimagetool-x86_64.AppImage")
-set(LD_PATH "${CMAKE_BINARY_DIR}/linuxdeploy-${CMAKE_SYSTEM_PROCESSOR}.AppImage")
-# set(LD_APPIMAGEPLUGIN_PATH "${CMAKE_BINARY_DIR}/linuxdeploy-plugin-appimage-${CMAKE_SYSTEM_PROCESSOR}.AppImage")
-# set(LD_QTPLUGIN_PATH "${CMAKE_BINARY_DIR}/linuxdeploy-plugin-qt-${CMAKE_SYSTEM_PROCESSOR}.AppImage")
-# set(LD_GSTPLUGIN_PATH "${CMAKE_BINARY_DIR}/linuxdeploy-plugin-gstreamer.sh")
-
-if(NOT EXISTS "${APPIMAGETOOL_PATH}")
-    file(DOWNLOAD https://github.com/AppImage/appimagetool/releases/download/continuous/appimagetool-${CMAKE_SYSTEM_PROCESSOR}.AppImage "${APPIMAGETOOL_PATH}")
-    # file(DOWNLOAD https://github.com/probonopd/go-appimage/releases/download/832/appimagetool-823-${CMAKE_SYSTEM_PROCESSOR}.AppImage "${APPIMAGETOOL_PATH}") # TODO: Use Continuous Release
-    execute_process(COMMAND chmod a+x "${APPIMAGETOOL_PATH}")
-endif()
-if(NOT EXISTS "${LD_PATH}")
-    file(DOWNLOAD https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-${CMAKE_SYSTEM_PROCESSOR}.AppImage "${LD_PATH}")
-    execute_process(COMMAND chmod a+x "${LD_PATH}")
+set(APPIMAGE_PATH "${CMAKE_BINARY_DIR}/${CMAKE_PROJECT_NAME}-${CMAKE_SYSTEM_PROCESSOR}.AppImage")
+
+#===========================================================================#
+# Download Tools
+
+function(download_tool VAR URL)
+    cmake_path(GET URL FILENAME _name)
+    set(_dest "${CMAKE_BINARY_DIR}/tools/${_name}")
+    if(NOT EXISTS "${_dest}")
+        file(MAKE_DIRECTORY "${CMAKE_BINARY_DIR}/tools")
+        message(STATUS "QGC: Downloading ${_name} to ${_dest}")
+        file(DOWNLOAD "${URL}" "${_dest}" STATUS _status)
+        list(GET _status 0 _result)
+        if(NOT _result EQUAL 0)
+            message(FATAL_ERROR "Failed to download ${URL} to ${_dest}: ${_status}")
+        endif()
+        file(CHMOD "${_dest}" FILE_PERMISSIONS OWNER_READ OWNER_WRITE OWNER_EXECUTE GROUP_READ GROUP_EXECUTE WORLD_READ WORLD_EXECUTE)
+    endif()
+    set(${VAR}_PATH "${_dest}" PARENT_SCOPE)
+endfunction()
+
+download_tool(LINUXDEPLOY   https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-${CMAKE_SYSTEM_PROCESSOR}.AppImage)
+download_tool(APPIMAGETOOL  https://github.com/AppImage/appimagetool/releases/download/continuous/appimagetool-${CMAKE_SYSTEM_PROCESSOR}.AppImage)
+if(CMAKE_SYSTEM_PROCESSOR MATCHES "x86_64")
+    download_tool(APPIMAGELINT  https://github.com/TheAssassin/appimagelint/releases/download/continuous/appimagelint-${CMAKE_SYSTEM_PROCESSOR}.AppImage)
 endif()
-# if(NOT EXISTS "${LD_APPIMAGEPLUGIN_PATH}")
-#     file(DOWNLOAD https://github.com/linuxdeploy/linuxdeploy-plugin-appimage/releases/download/continuous/linuxdeploy-plugin-appimage-${CMAKE_SYSTEM_PROCESSOR}.AppImage "${LD_APPIMAGEPLUGIN_PATH}")
-#     execute_process(COMMAND chmod a+x "${LD_APPIMAGEPLUGIN_PATH}")
-# endif()
-# if(NOT EXISTS "${LD_QTPLUGIN_PATH}")
-#     file(DOWNLOAD https://github.com/linuxdeploy/linuxdeploy-plugin-qt/releases/download/continuous/linuxdeploy-plugin-qt-${CMAKE_SYSTEM_PROCESSOR}.AppImage "${LD_QTPLUGIN_PATH}")
-#     execute_process(COMMAND chmod a+x "${LD_QTPLUGIN_PATH}")
-# endif()
-# if(NOT EXISTS "${LD_GSTPLUGIN_PATH}")
-#     file(DOWNLOAD https://raw.githubusercontent.com/linuxdeploy/linuxdeploy-plugin-gstreamer/master/linuxdeploy-plugin-gstreamer.sh "${LD_GSTPLUGIN_PATH}")
-#     execute_process(COMMAND chmod a+x "${LD_GSTPLUGIN_PATH}")
-# endif()
-
-execute_process(COMMAND ${LD_PATH}
-    --appdir ${APPDIR_PATH}
-    --executable ${APPDIR_PATH}/usr/bin/QGroundControl
-    --desktop-file ${APPDIR_PATH}/usr/share/applications/org.mavlink.qgroundcontrol.desktop
-    --custom-apprun ${CMAKE_BINARY_DIR}/AppRun)
-    # --plugin qt --plugin gstreamer
-    # --exclude-library "libgst*"
+
+#===========================================================================#
+# Bundle the runtime
+
+execute_process(
+    COMMAND "${LINUXDEPLOY_PATH}"
+            --appdir "${APPDIR_PATH}"
+            --executable "${APPDIR_PATH}/usr/bin/${CMAKE_PROJECT_NAME}"
+            --desktop-file "${APPDIR_PATH}/usr/share/applications/${QGC_PACKAGE_NAME}.desktop"
+            --custom-apprun "${CMAKE_BINARY_DIR}/AppRun"
+            --icon-file "${APPDIR_PATH}/usr/share/icons/hicolor/256x256/apps/${CMAKE_PROJECT_NAME}.png"
+    COMMAND_ECHO STDOUT
+    COMMAND_ERROR_IS_FATAL ANY
+)
+
+#===========================================================================#
+# Build the final AppImage
 
 set(ENV{ARCH} ${CMAKE_SYSTEM_PROCESSOR})
-# set(ENV{VERSION} 5.0)
-execute_process(COMMAND ${APPIMAGETOOL_PATH} ${APPDIR_PATH})
+set(ENV{VERSION} ${CMAKE_PROJECT_VERSION})
+execute_process(
+    COMMAND "${APPIMAGETOOL_PATH}" "${APPDIR_PATH}" "${APPIMAGE_PATH}"
+    COMMAND_ECHO STDOUT
+    COMMAND_ERROR_IS_FATAL ANY
+)
+
+#===========================================================================#
+# Lint
+
+if(EXISTS "${APPIMAGELINT_PATH}")
+    execute_process(
+        COMMAND "${APPIMAGELINT_PATH}" "${APPIMAGE_PATH}"
+        RESULT_VARIABLE LINT_RESULT
+        COMMAND_ECHO STDOUT
+    )
+    if(NOT LINT_RESULT EQUAL 0)
+        message(WARNING "QGC: appimagelint reported problems; see log above")
+    endif()
+endif()

cmake/install/Install.cmake

@@ -38,33 +38,43 @@ if(ANDROID)
     # cmake_print_variables(QGC_ANDROID_DEPLOY_FILE)
 elseif(LINUX)
     configure_file(
-        ${CMAKE_SOURCE_DIR}/deploy/linux/org.mavlink.qgroundcontrol.desktop.in
-        ${CMAKE_BINARY_DIR}/org.mavlink.qgroundcontrol.desktop
+        "${QGC_APPIMAGE_DESKTOP_ENTRY_PATH}"
+        "${CMAKE_BINARY_DIR}/${QGC_PACKAGE_NAME}.desktop"
         @ONLY
     )
     install(
-        FILES ${CMAKE_BINARY_DIR}/org.mavlink.qgroundcontrol.desktop
-        DESTINATION ${CMAKE_INSTALL_DATADIR}/applications
+        FILES "${CMAKE_BINARY_DIR}/${QGC_PACKAGE_NAME}.desktop"
+        DESTINATION "${CMAKE_INSTALL_DATADIR}/applications"
     )
     install(
-        FILES ${QGC_APPIMAGE_ICON_PATH}
-        DESTINATION ${CMAKE_INSTALL_DATADIR}/icons/hicolor/128x128/apps/
+        FILES "${QGC_APPIMAGE_ICON_256_PATH}"
+        DESTINATION "${CMAKE_INSTALL_DATADIR}/icons/hicolor/256x256/apps/"
         RENAME ${CMAKE_PROJECT_NAME}.png
     )
+    install(
+        FILES "${QGC_APPIMAGE_ICON_SCALABLE_PATH}"
+        DESTINATION "${CMAKE_INSTALL_DATADIR}/icons/hicolor/scalable/apps/"
+        RENAME ${CMAKE_PROJECT_NAME}.svg
+    )
     configure_file(
-        ${CMAKE_SOURCE_DIR}/deploy/linux/org.mavlink.qgroundcontrol.metainfo.xml.in
-        ${CMAKE_BINARY_DIR}/metainfo/org.mavlink.qgroundcontrol.metainfo.xml
+        "${QGC_APPIMAGE_METADATA_PATH}"
+        "${CMAKE_BINARY_DIR}/${QGC_PACKAGE_NAME}.appdata.xml"
         @ONLY
     )
     install(
-        FILES ${CMAKE_BINARY_DIR}/metainfo/org.mavlink.qgroundcontrol.metainfo.xml
-        DESTINATION ${CMAKE_INSTALL_DATADIR}/metainfo/
+        PROGRAMS "${CMAKE_BINARY_DIR}/${QGC_PACKAGE_NAME}.appdata.xml"
+        DESTINATION "${CMAKE_INSTALL_DATADIR}/metainfo/"
     )
     install(
-        FILES ${CMAKE_SOURCE_DIR}/deploy/linux/AppRun
-        DESTINATION ${CMAKE_BINARY_DIR}
+        FILES "${QGC_APPIMAGE_APPRUN_PATH}"
+        DESTINATION "${CMAKE_BINARY_DIR}/"
     )
-    install(CODE "set(CMAKE_SYSTEM_PROCESSOR \"${CMAKE_SYSTEM_PROCESSOR}\")")
+    install(CODE "
+        set(CMAKE_PROJECT_NAME ${CMAKE_PROJECT_NAME})
+        set(CMAKE_PROJECT_VERSION ${CMAKE_PROJECT_VERSION})
+        set(QGC_PACKAGE_NAME ${QGC_PACKAGE_NAME})
+        set(CMAKE_SYSTEM_PROCESSOR ${CMAKE_SYSTEM_PROCESSOR})
+    ")
     install(SCRIPT "${CMAKE_SOURCE_DIR}/cmake/install/CreateAppImage.cmake")
 elseif(WIN32)
     install(CODE "set(CMAKE_PROJECT_NAME ${CMAKE_PROJECT_NAME})")

custom-example/cmake/CustomOverrides.cmake

@@ -1,7 +1,10 @@
 set(QGC_APP_NAME "Custom-QGroundControl" CACHE STRING "App Name" FORCE)
 
 set(QGC_MACOS_ICON_PATH "${CMAKE_SOURCE_DIR}/custom/res" CACHE PATH "MacOS Icon Path" FORCE)
-set(QGC_APPIMAGE_ICON_PATH "${CMAKE_SOURCE_DIR}/custom/res/icons/custom_qgroundcontrol.png" CACHE FILEPATH "AppImage Icon Path" FORCE)
+
+if(EXISTS "${CMAKE_SOURCE_DIR}/custom/res/icons/custom_qgroundcontrol.svg")
+    set(QGC_APPIMAGE_ICON_SCALABLE_PATH "${CMAKE_SOURCE_DIR}/custom/res/icons/custom_qgroundcontrol.svg" CACHE FILEPATH "AppImage Icon SVG Path" FORCE)
+endif()
 
 if(EXISTS ${CMAKE_SOURCE_DIR}/custom/deploy/windows/installheader.bmp)
     set(QGC_WINDOWS_INSTALL_HEADER_PATH "${CMAKE_SOURCE_DIR}/custom/deploy/windows/installheader.bmp" CACHE FILEPATH "Windows Install Header Path" FORCE)

custom-example/res/icons/custom_qgroundcontrol.svg

@@ -0,0 +1,105 @@
+#!/bin/sh
+
+HERE="$(dirname "$(readlink -f "${0}")")"
+
+MAIN=$(grep -r "^Exec=.*" "$HERE"/*.desktop | head -n 1 | cut -d "=" -f 2 | cut -d " " -f 1)
+
+############################################################################################
+# Use bundled paths
+############################################################################################
+
+export PATH="${HERE}"/usr/bin/:"${HERE}"/usr/sbin/:"${HERE}"/usr/games/:"${HERE}"/bin/:"${HERE}"/sbin/:"${PATH}"
+export XDG_DATA_DIRS="${HERE}"/usr/share/:"${XDG_DATA_DIRS}"
+
+############################################################################################
+# Use bundled Python
+############################################################################################
+
+export PYTHONHOME="${HERE}"/usr/
+
+############################################################################################
+# Use bundled Tcl/Tk
+############################################################################################
+
+if [ -e "${HERE}"/usr/share/tcltk/tcl8.6 ] ; then
+  export TCL_LIBRARY="${HERE}"/usr/share/tcltk/tcl8.6:$TCL_LIBRARY:$TK_LIBRARY
+  export TK_LIBRARY="${HERE}"/usr/share/tcltk/tk8.6:$TK_LIBRARY:$TCL_LIBRARY
+fi
+
+############################################################################################
+# Make it look more native on Gtk+ based systems
+############################################################################################
+
+case "${XDG_CURRENT_DESKTOP}" in
+    *GNOME*|*gnome*)
+        export QT_QPA_PLATFORMTHEME=gtk2
+esac
+
+############################################################################################
+# If .ui files are in the AppDir, then chances are that we need to cd into usr/
+# because we may have had to patch the absolute paths away in the binary
+############################################################################################
+
+UIFILES=$(find "$HERE" -name "*.ui")
+if [ ! -z "$UIFILES" ] ; then
+  cd "$HERE/usr"
+fi
+
+############################################################################################
+# Use bundled GStreamer
+# NOTE: May need to remove libgstvaapi.so
+############################################################################################
+
+if [ ! -z $(find "${HERE}" -name "libgstcoreelements.so" -type f) ] ; then
+  export GST_PLUGIN_PATH=$(dirname $(readlink -f $(find "${HERE}" -name "libgstcoreelements.so" -type f | head -n 1)))
+  export GST_PLUGIN_SCANNER=$(find "${HERE}" -name "gst-plugin-scanner" -type f | head -n 1)
+  export GST_PLUGIN_SYSTEM_PATH=$GST_PLUGIN_PATH
+  env | grep GST
+fi
+
+############################################################################################
+# Run experimental bundle that bundles everything if a private ld-linux-x86-64.so.2 is there
+# This allows the bundle to run even on older systems than the one it was built on
+############################################################################################
+
+cd "$HERE/usr" # Not all applications will need this; TODO: Make this opt-in
+
+# Try to find a binary with the same name as the AppImage or the symlink through which
+# it was invoked, without any suffix
+if [ -z "$ARGV0" ] ; then
+  # AppRun is being executed outside of an AppImage
+  ARGV0="$0"
+fi
+BINARY_NAME=$(basename "$ARGV0")
+if [ "$BINARY_NAME" = "AppRun" ] ; then
+  unset BINARY_NAME
+fi
+
+BINARY_NAME="${BINARY_NAME%.*}" # remove everything after the last "."
+MAIN_BIN=$(find "$HERE/usr/bin" -name "$BINARY_NAME" | head -n 1)
+
+# Fall back to finding the main binary based on the Exec= line in the desktop file
+if [ -z "$MAIN_BIN" ] ; then
+  MAIN_BIN=$(find "$HERE/usr/bin" -name "$MAIN" | head -n 1)
+fi
+
+LD_LINUX=$(find "$HERE" -name 'ld-*.so.*' | head -n 1)
+
+if [ -e "$LD_LINUX" ] ; then
+  export GCONV_PATH="$HERE/usr/lib/gconv"
+  export FONTCONFIG_FILE="$HERE/etc/fonts/fonts.conf"
+  export GTK_PATH=$(find "$HERE/lib" -name gtk-* -type d)
+  export GTK_THEME=Default # This one should be bundled so that it can work on systems without Gtk
+  export GDK_PIXBUF_MODULEDIR=$(find "$HERE" -name loaders -type d -path '*gdk-pixbuf*')
+  export GDK_PIXBUF_MODULE_FILE=$(find "$HERE" -name loaders.cache -type f -path '*gdk-pixbuf*') # Patched to contain no paths
+  export XDG_DATA_DIRS="${HERE}"/usr/share/:"${XDG_DATA_DIRS}"
+  export PERLLIB="${HERE}"/usr/share/perl5/:"${HERE}"/usr/lib/perl5/:"${PERLLIB}"
+  export GSETTINGS_SCHEMA_DIR="${HERE}"/usr/share/glib-2.0/runtime-schemas/:"${HERE}"/usr/share/glib-2.0/schemas/:"${GSETTINGS_SCHEMA_DIR}"
+  export QT_PLUGIN_PATH="$(readlink -f "$(dirname "$(find "${HERE}" -type d -path '*/plugins/platforms' 2>/dev/null)" 2>/dev/null)" 2>/dev/null)"
+  case $line in
+    "ld-linux"*) exec "${LD_LINUX}" --inhibit-cache "${MAIN_BIN}" "$@" ;;
+    *) exec "${LD_LINUX}" "${MAIN_BIN}" "$@" ;;
+  esac
+else
+  exec "${MAIN_BIN}" "$@"
+fi