flatpak: init setup

Author: siddarthkay

Makefile

@@ -718,6 +718,49 @@ ifdef LINUX_GPG_PRIVATE_KEY_FILE
 	scripts/sign-linux-file.sh $(STATUS_CLIENT_TARBALL)
 endif
 
+# Flatpak build configuration
+STATUS_CLIENT_FLATPAK ?= pkg/Status.flatpak
+STATUS_CLIENT_FLATPAK_BUNDLE ?= pkg/app.status.desktop.flatpak
+FLATPAK_BUILD_DIR ?= tmp/flatpak-build
+FLATPAK_REPO_DIR ?= tmp/flatpak-repo
+FLATPAK_MANIFEST ?= app.status.desktop.yml
+
+$(STATUS_CLIENT_FLATPAK): override RESOURCES_LAYOUT := $(PRODUCTION_PARAMETERS)
+$(STATUS_CLIENT_FLATPAK): nim_status_client
+	echo -e $(BUILD_MSG) "Flatpak"
+	rm -rf $(FLATPAK_BUILD_DIR) $(FLATPAK_REPO_DIR)
+	mkdir -p pkg
+
+	# Build Flatpak using flatpak-builder
+	flatpak-builder --force-clean --disable-rofiles-fuse \
+		--repo=$(FLATPAK_REPO_DIR) \
+		$(FLATPAK_BUILD_DIR) \
+		$(FLATPAK_MANIFEST)
+
+	# Create single-file bundle
+	flatpak build-bundle $(FLATPAK_REPO_DIR) \
+		$(STATUS_CLIENT_FLATPAK_BUNDLE) \
+		app.status.desktop
+
+# if LINUX_GPG_PRIVATE_KEY_FILE is set, sign the Flatpak bundle
+ifdef LINUX_GPG_PRIVATE_KEY_FILE
+	scripts/sign-linux-file.sh $(STATUS_CLIENT_FLATPAK_BUNDLE)
+endif
+
+# Convenience target
+.PHONY: flatpak
+flatpak: $(STATUS_CLIENT_FLATPAK)
+
+# Target to build and install Flatpak locally for testing
+.PHONY: flatpak-install
+flatpak-install: $(STATUS_CLIENT_FLATPAK)
+	flatpak install --user -y $(STATUS_CLIENT_FLATPAK_BUNDLE)
+
+# Target to run Flatpak
+.PHONY: flatpak-run
+flatpak-run:
+	flatpak run app.status.desktop
+
 MACOS_OUTER_BUNDLE := tmp/macos/dist/Status.app
 MACOS_INNER_BUNDLE := $(MACOS_OUTER_BUNDLE)/Contents/Frameworks/QtWebEngineCore.framework/Versions/Current/Helpers/QtWebEngineProcess.app
 

app.status.desktop.appdata.xml

@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<component type="desktop-application">
+  <id>app.status.desktop</id>
+  <metadata_license>CC0-1.0</metadata_license>
+  <project_license>MPL-2.0</project_license>
+  <name>Status Desktop</name>
+  <summary>Desktop client for the Status Network</summary>
+  <description>
+    <p>
+      Status is a secure messaging app, crypto wallet, and Web3 browser built with state of the art technology.
+      It's an open source, Ethereum-based app that gives you the power to chat, transact and access a revolutionary
+      world of DApps on the decentralized web.
+    </p>
+    <p>Features:</p>
+    <ul>
+      <li>Private, encrypted messaging</li>
+      <li>Built-in Ethereum wallet</li>
+      <li>Web3 DApp browser</li>
+      <li>Decentralized network</li>
+      <li>Community-driven development</li>
+    </ul>
+  </description>
+  <launchable type="desktop-id">app.status.desktop.desktop</launchable>
+  <url type="homepage">https://status.im</url>
+  <url type="bugtracker">https://github.com/status-im/status-desktop/issues</url>
+  <url type="help">https://status.im/help</url>
+  <developer_name>Status Research &amp; Development GmbH</developer_name>
+  <screenshots>
+    <screenshot type="default">
+      <image>https://status.im/img/status-desktop-screenshot.png</image>
+    </screenshot>
+  </screenshots>
+  <content_rating type="oars-1.1">
+    <content_attribute id="social-chat">intense</content_attribute>
+    <content_attribute id="social-info">intense</content_attribute>
+    <content_attribute id="money-purchasing">intense</content_attribute>
+  </content_rating>
+  <releases>
+    <release version="0.0.0" date="2025-01-01"/>
+  </releases>
+</component>

app.status.desktop.yml

@@ -0,0 +1,108 @@
+app-id: app.status.desktop
+runtime: org.kde.Platform
+runtime-version: '6.8'
+sdk: org.kde.Sdk
+command: nim_status_client_wrapped
+finish-args:
+  # X11 + XShm access
+  - --share=ipc
+  - --socket=x11
+  # Wayland access
+  - --socket=wayland
+  # Network access
+  - --share=network
+  # Sound access
+  - --socket=pulseaudio
+  # GPU acceleration
+  - --device=dri
+  # Smart card access
+  - --device=all
+  # File system access
+  - --filesystem=xdg-download
+  - --filesystem=xdg-documents
+  - --filesystem=xdg-pictures
+  - --filesystem=xdg-videos
+  # D-Bus access
+  - --socket=session-bus
+  - --socket=system-bus
+  # Notifications
+  - --talk-name=org.freedesktop.Notifications
+  # Allow access to status-im directories
+  - --filesystem=~/.status-im:create
+  # Prevent theme issues
+  - --env=XCURSOR_PATH=/run/host/user-share/icons:/run/host/share/icons
+  # Qt platform
+  - --env=QT_QPA_PLATFORM=xcb
+
+modules:
+  # pcsc-lite (smartcard support - runtime dependency)
+  - name: pcsc-lite
+    config-opts:
+      - --disable-libsystemd
+      - --disable-serial
+      - --disable-polkit
+      - --enable-ipcdir=/tmp/pcscd/run
+    sources:
+      - type: archive
+        url: https://pcsclite.apdu.fr/files/pcsc-lite-2.2.3.tar.xz
+        sha256: cab1e62755713f62ce1b567954dbb0e9a7e668ffbc3bbad3ce85c53f8f4e00a4
+
+  # GStreamer plugins (additional plugins beyond what KDE runtime provides)
+  - name: gst-plugins-ugly
+    buildsystem: meson
+    sources:
+      - type: archive
+        url: https://gstreamer.freedesktop.org/src/gst-plugins-ugly/gst-plugins-ugly-1.24.0.tar.xz
+        sha256: c5d1cbdf71ab0c675bca236f70edfa1feb3f813fd4bfff563308f466d8805ca5
+
+  # fcitx5-qt (input method support)
+  - name: fcitx5-qt
+    buildsystem: cmake-ninja
+    config-opts:
+      - -DCMAKE_BUILD_TYPE=Release
+      - -DCMAKE_INSTALL_PREFIX=/app
+      - -DCMAKE_INSTALL_LIBDIR=/app/lib
+      - -DBUILD_ONLY_PLUGIN=ON
+      - -DENABLE_QT4=OFF
+      - -DENABLE_QT5=OFF
+      - -DENABLE_QT6=ON
+      # Override Qt6 plugin install path to be inside /app
+      - -DCMAKE_INSTALL_QT6PLUGINDIR=/app/lib/qt6/plugins
+    sources:
+      - type: git
+        url: https://github.com/fcitx/fcitx5-qt.git
+        tag: 5.1.8
+        commit: cdd0efe6724dbc7f6cbb8a8c02812e26e80d88d4
+
+  # Main application - packages pre-built binaries from CI build
+  - name: status-desktop
+    buildsystem: simple
+    build-commands:
+      # Install pre-built binary
+      - install -Dm755 bin/nim_status_client /app/bin/nim_status_client
+      # Install StatusQ libraries
+      - install -Dm755 bin/StatusQ/*.so /app/lib/
+      # Install resources
+      - install -Dm644 resources.rcc /app/share/status-desktop/resources.rcc
+      # Install desktop file
+      - install -Dm644 nim-status.desktop /app/share/applications/app.status.desktop.desktop
+      # Update desktop file
+      - sed -i 's/^Exec=nim_status_client/Exec=nim_status_client/' /app/share/applications/app.status.desktop.desktop
+      - sed -i 's/^Icon=status/Icon=app.status.desktop/' /app/share/applications/app.status.desktop.desktop
+      # Install icon (512x512 png)
+      - install -Dm644 status-512.png /app/share/icons/hicolor/512x512/apps/app.status.desktop.png
+      # Install appdata
+      - install -Dm644 app.status.desktop.appdata.xml /app/share/metainfo/app.status.desktop.appdata.xml
+      # Copy fcitx5 plugin
+      - mkdir -p /app/lib/qt6/plugins/platforminputcontexts
+      - cp /app/lib/qt6/plugins/platforminputcontexts/libfcitx5platforminputcontextplugin.so /app/lib/qt6/plugins/platforminputcontexts/ || true
+      # Create wrapper script to set up environment
+      - install -Dm755 flatpak-wrapper.sh /app/bin/nim_status_client_wrapped
+    sources:
+      # Use local directory with pre-built binaries
+      - type: dir
+        path: .
+      # Wrapper script
+      - type: file
+        path: flatpak-wrapper.sh
+

ci/Dockerfile

@@ -69,6 +69,7 @@ RUN apt update -yq && apt install -yq software-properties-common \
  && apt update -yq && apt full-upgrade -yq && apt install -yq --no-install-recommends --fix-missing  \
     gnupg2 openssh-client ca-certificates locales sudo jq curl wget fuse s3cmd file unzip llvm tk-dev xz-utils \
     git make build-essential pkg-config extra-cmake-modules \
+    flatpak flatpak-builder elfutils appstream \
     libgl1-mesa-dev libsm6 libice6 libfontconfig1 libdbus-1-3 libssl-dev libz-dev \
     zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev unixodbc-dev libpq-dev \
     libncurses5-dev libncursesw5-dev libnss3 \
@@ -158,6 +159,11 @@ RUN sudo groupadd -g 1001 jenkins \
 USER jenkins
 ENV HOME="/home/jenkins"
 
+# Setup Flatpak for jenkins user
+RUN flatpak remote-add --user --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo \
+ && flatpak install --user -y flathub org.kde.Platform//6.8 \
+ && flatpak install --user -y flathub org.kde.Sdk//6.8
+
 # Rust is needed for nwaku builds
 RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
 ENV PATH="${HOME}/.cargo/bin:${PATH}"

ci/Jenkinsfile.linux

@@ -10,11 +10,11 @@ pipeline {
     /* Image with Ubuntu 22.04 and QT 6.9.2 */
     docker {
       label 'linuxcontainer'
-      image 'harbor.status.im/status-im/status-desktop-build:1.0.5-qt6.9.2'
-      /* allows jenkins use cat and mounts '/dev/fuse' for linuxdeployqt */
+      image 'harbor.status.im/status-im/status-desktop-build:1.0.7-qt6.9.2'
+      /* allows jenkins use cat and mounts '/dev/fuse' for linuxdeployqt and flatpak-builder */
+      /* flatpak-builder requires --privileged to mount /proc inside bwrap sandbox */
       args '--entrypoint="" ' +
-           '--cap-add=SYS_ADMIN ' +
-           '--security-opt=apparmor:unconfined ' +
+           '--privileged ' +
            '--device=/dev/fuse ' +
            '--volume=/nix:/nix ' +
            '--volume=/etc/nix:/etc/nix '
@@ -57,7 +57,7 @@ pipeline {
   options {
     timestamps()
     /* Prevent Jenkins jobs from running forever */
-    timeout(time: 30, unit: 'MINUTES')
+    timeout(time: 45, unit: 'MINUTES')
     /* manage how many builds we keep */
     buildDiscarder(logRotator(
       numToKeepStr: '10',
@@ -87,8 +87,14 @@ pipeline {
     VERSION = sh(script: "./scripts/version.sh", returnStdout: true).trim()
     /* Control output the filename */
     APP_TYPE = "${utils.getAppType() + (params.USE_NWAKU ? '-experimental' : '')}"
+    /* AppImage/Tarball output files */
     STATUS_CLIENT_APPIMAGE = "pkg/${utils.pkgFilename(ext: 'AppImage', arch: getArch(), version: env.VERSION, type: env.APP_TYPE)}"
     STATUS_CLIENT_TARBALL = "pkg/${utils.pkgFilename(ext: 'tar.gz', arch: getArch(), version: env.VERSION, type: env.APP_TYPE)}"
+    /* Flatpak output files */
+    STATUS_CLIENT_FLATPAK = "pkg/${utils.pkgFilename(ext: 'flatpak', arch: getArch(), version: env.VERSION, type: env.APP_TYPE)}"
+    /* Flatpak build directories */
+    FLATPAK_BUILD_DIR = "${env.WORKSPACE_TMP}/flatpak-build"
+    FLATPAK_REPO_DIR = "${env.WORKSPACE_TMP}/flatpak-repo"
     /* prevent sharing cache dir across different jobs */
     GO_GENERATE_FAST_DIR = "${env.WORKSPACE_TMP}/go-generate-fast"
     SENTRY_PRODUCTION = "${utils.isReleaseBuild() ? 'true' : 'false'}"
@@ -128,27 +134,47 @@ pipeline {
     }
 
     stage('Package') {
-      steps { script {
-        linux.bundle('tgz-linux')
-      } }
+      parallel {
+        stage('Tarball') {
+          steps { script {
+            linux.bundle('tgz-linux')
+          } }
+        }
+        stage('Flatpak') {
+          steps { script {
+            sh 'scripts/build-flatpak.sh'
+          } }
+        }
+      }
     }
 
     stage('Parallel Upload') {
       parallel {
-        stage('Upload') {
+        stage('Upload Tarball') {
           steps { script {
             env.PKG_URL = s5cmd.upload(env.STATUS_CLIENT_TARBALL)
-            jenkins.setBuildDesc(AppImage: env.PKG_URL)
+          } }
+        }
+        stage('Upload Flatpak') {
+          steps { script {
+            env.FLATPAK_URL = s5cmd.upload(env.STATUS_CLIENT_FLATPAK)
           } }
         }
         stage('Archive') {
           steps { script {
             archiveArtifacts("${env.STATUS_CLIENT_TARBALL}*")
+            archiveArtifacts("${env.STATUS_CLIENT_FLATPAK}*")
           } }
         }
       }
     }
 
+    stage('Post Upload') {
+      steps { script {
+        jenkins.setBuildDesc(Tarball: env.PKG_URL, Flatpak: env.FLATPAK_URL)
+      } }
+    }
+
     stage('E2E') {
       when { expression { utils.isPRBuild() && !(params.USE_NWAKU ?: false) } }
       steps { script {
@@ -166,10 +192,7 @@ pipeline {
   post {
     success { script { github.notifyPR(true) } }
     failure { script { github.notifyPR(false) } }
-    cleanup {
-      cleanWs(disableDeferredWipeout: true)
-      dir(env.WORKSPACE_TMP) { deleteDir() }
-    }
+    cleanup { cleanWs(disableDeferredWipeout: true) }
   }
 }
 

flatpak-wrapper.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+# Flatpak wrapper script for Status Desktop
+
+# Start pcscd daemon for smartcard support
+PCSCD_RUN_DIR="/tmp/pcscd/run"
+mkdir -p "${PCSCD_RUN_DIR}"
+if [ -x /app/bin/pcscd ]; then
+  /app/bin/pcscd -f &
+fi
+
+# Execute the actual application
+exec /app/bin/nim_status_client "$@"

pcscd-launcher.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+# Launcher for pcscd daemon in Flatpak environment
+
+PCSCD_RUN_DIR="/tmp/pcscd/run"
+rm -rf "${PCSCD_RUN_DIR}"
+mkdir -p "${PCSCD_RUN_DIR}"
+
+export PCSC_DRIVERS_DIR="/app/lib/pcsc/drivers"
+export PCSCLITE_CONFIG_DIR="/app/etc/reader.conf.d"
+
+exec /app/bin/pcscd -f "$@"