Flatpak Update Mechanism

pom.xml

@@ -40,9 +40,10 @@
 
 		<!-- runtime dependencies -->
 
-		<api.version>1.6.0</api.version>
+		<api.version>1.7.0-SNAPSHOT</api.version>
 		<secret-service.version>2.0.1-alpha</secret-service.version>
 		<kdewallet.version>1.4.0</kdewallet.version>
+		<flatpakupdateportal.version>1.0.0</flatpakupdateportal.version>
 		<slf4j.version>2.0.17</slf4j.version>
 		<appindicator.version>1.4.2</appindicator.version>
 
@@ -88,6 +89,11 @@
 			<artifactId>libappindicator-gtk3-java-minimal</artifactId>
 			<version>${appindicator.version}</version>
 		</dependency>
+		<dependency>
+			<groupId>org.purejava</groupId>
+			<artifactId>flatpak-update-portal</artifactId>
+			<version>${flatpakupdateportal.version}</version>
+		</dependency>
 		<dependency>
 			<groupId>org.junit.jupiter</groupId>
 			<artifactId>junit-jupiter</artifactId>

src/main/java/module-info.java

@@ -3,20 +3,23 @@
 import org.cryptomator.integrations.quickaccess.QuickAccessService;
 import org.cryptomator.integrations.revealpath.RevealPathService;
 import org.cryptomator.integrations.tray.TrayMenuController;
+import org.cryptomator.integrations.update.UpdateService;
 import org.cryptomator.linux.autostart.FreedesktopAutoStartService;
-import org.cryptomator.linux.keychain.KDEWalletKeychainAccess;
 import org.cryptomator.linux.keychain.GnomeKeyringKeychainAccess;
+import org.cryptomator.linux.keychain.KDEWalletKeychainAccess;
 import org.cryptomator.linux.quickaccess.DolphinPlaces;
 import org.cryptomator.linux.quickaccess.NautilusBookmarks;
 import org.cryptomator.linux.revealpath.DBusSendRevealPathService;
 import org.cryptomator.linux.tray.AppindicatorTrayMenuController;
+import org.cryptomator.linux.update.FlatpakUpdater;
 
 module org.cryptomator.integrations.linux {
 	requires org.cryptomator.integrations.api;
 	requires org.slf4j;
 	requires org.freedesktop.dbus;
 	requires org.purejava.appindicator;
 	requires org.purejava.kwallet;
+	requires org.purejava.portal;
 	requires de.swiesend.secretservice;
 	requires java.xml;
 
@@ -25,8 +28,10 @@
 	provides RevealPathService with DBusSendRevealPathService;
 	provides TrayMenuController with AppindicatorTrayMenuController;
 	provides QuickAccessService with NautilusBookmarks, DolphinPlaces;
+	provides UpdateService with FlatpakUpdater;
 
 	opens org.cryptomator.linux.tray to org.cryptomator.integrations.api;
 	opens org.cryptomator.linux.quickaccess to org.cryptomator.integrations.api;
 	opens org.cryptomator.linux.autostart to org.cryptomator.integrations.api;
+	opens org.cryptomator.linux.update to org.cryptomator.integrations.api;
 }

src/main/java/org/cryptomator/linux/update/FlatpakUpdater.java

@@ -0,0 +1,140 @@
+package org.cryptomator.linux.update;
+
+import org.cryptomator.integrations.common.CheckAvailability;
+import org.cryptomator.integrations.common.DisplayName;
+import org.cryptomator.integrations.common.OperatingSystem;
+import org.cryptomator.integrations.common.Priority;
+import org.cryptomator.integrations.update.Progress;
+import org.cryptomator.integrations.update.ProgressListener;
+import org.cryptomator.integrations.update.UpdateFailedException;
+import org.cryptomator.integrations.update.UpdateService;
+import org.freedesktop.dbus.FileDescriptor;
+import org.freedesktop.dbus.exceptions.DBusException;
+import org.freedesktop.dbus.types.UInt32;
+import org.freedesktop.dbus.types.Variant;
+import org.purejava.portal.Flatpak;
+import org.purejava.portal.FlatpakSpawnFlag;
+import org.purejava.portal.UpdatePortal;
+import org.purejava.portal.Util;
+import org.purejava.portal.rest.UpdateCheckerTask;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+import java.util.concurrent.CopyOnWriteArrayList;
+
+@Priority(1000)
+@CheckAvailability
+@DisplayName("Update via Flatpak update")
+@OperatingSystem(OperatingSystem.Value.LINUX)
+public class FlatpakUpdater implements UpdateService, AutoCloseable {
+
+	private static final Logger LOG = LoggerFactory.getLogger(FlatpakUpdater.class);
+	private static final String APP_NAME = "org.cryptomator.Cryptomator";
+
+	private final List<ProgressListener> progressListeners = new CopyOnWriteArrayList<>();
+
+	private final UpdatePortal portal;
+	private Flatpak.UpdateMonitor updateMonitor;
+
+	public FlatpakUpdater() {
+		this.portal = new UpdatePortal();
+		portal.CreateUpdateMonitor(UpdatePortal.OPTIONS_DUMMY);
+	}
+
+	@Override
+	public boolean isSupported() {
+		return portal.isAvailable();
+	}
+
+	@Override
+	public UpdateCheckerTask getLatestReleaseChecker() {
+		portal.setUpdateCheckerTaskFor(APP_NAME);
+		return portal.getUpdateCheckerTaskFor(APP_NAME);
+	}
+
+	@Override
+	public void triggerUpdate() throws UpdateFailedException {
+		var monitor = getUpdateMonitor();
+		portal.updateApp("x11:0", monitor, UpdatePortal.OPTIONS_DUMMY);
+	}
+
+	@Override
+	public long spawnApp() {
+		var cwdPath = Util.stringToByteList(System.getProperty("user.dir"));
+		List<List<Byte>> argv = List.of(
+				Util.stringToByteList(APP_NAME));
+		Map<UInt32, FileDescriptor> fds = Collections.emptyMap();
+		Map<String, String> envs = Map.of();
+		UInt32 flags = new UInt32(FlatpakSpawnFlag.LATEST_VERSION.getValue());
+		Map<String, Variant<?>> options = UpdatePortal.OPTIONS_DUMMY;
+
+		return spawnApp(cwdPath, argv, fds, envs, flags, options).longValue();
+	}
+
+	@Override
+	public boolean doesRequireElevatedPermissions() {
+		return false;
+	}
+
+	@Override
+	public void close() throws Exception {
+		try {
+			if (null != updateMonitor) {
+				portal.cancelUpdateMonitor(updateMonitor);
+			}
+			portal.close();
+		} catch (Exception e) {
+			LOG.error(e.toString(), e.getCause());
+		}
+	}
+
+	private synchronized Flatpak.UpdateMonitor getUpdateMonitor() {
+		if (updateMonitor == null) {
+			var updateMonitorPath = portal.CreateUpdateMonitor(UpdatePortal.OPTIONS_DUMMY);
+			if (updateMonitorPath != null) {
+				LOG.debug("UpdateMonitor successful created at {}", updateMonitorPath);
+				updateMonitor = portal.getUpdateMonitor(updateMonitorPath.toString());
+				try {
+					portal.getDBusConnection().addSigHandler(Flatpak.UpdateMonitor.Progress.class, signal -> {
+						notifyOnUpdateProceeds(signal);
+					});
+				} catch (DBusException e) {
+					LOG.error(e.toString(), e.getCause());
+				}
+			} else {
+				LOG.error("Failed to create UpdateMonitor on DBus");
+			}
+		}
+		return updateMonitor;
+	}
+
+	@Override
+	public void addProgressListener(ProgressListener listener) {
+		progressListeners.add(listener);
+	}
+
+	@Override
+	public void removeProgressListener(ProgressListener listener) {
+		progressListeners.remove(listener);
+	}
+
+	private void notifyOnUpdateProceeds(Flatpak.UpdateMonitor.Progress signal) {
+		long status = ((UInt32) signal.info.get("status").getValue()).longValue();
+		long progress = 0;
+		Variant<?> progressVariant = signal.info.get("progress");
+		if (null != progressVariant) {
+			progress = ((UInt32) progressVariant.getValue()).longValue();
+		}
+		Progress p = new Progress(status, progress);
+		for (ProgressListener listener : progressListeners) {
+			listener.onProgress(p);
+		}
+	}
+
+	private UInt32 spawnApp(List<Byte> cwdPath, List<List<Byte>> argv, Map<UInt32, FileDescriptor> fds, Map<String, String> envs, UInt32 flags, Map<String, Variant<?>> options) {
+		return portal.Spawn(cwdPath, argv, fds, envs, flags, options);
+	}
+}

src/main/resources/META-INF/services/org.cryptomator.integrations.update.UpdateService

@@ -0,0 +1 @@
+org.cryptomator.linux.update.FlatpakUpdater