Feature/flatpak update portal #117
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,202 @@ | ||
| 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.UpdateFailedException; | ||
| import org.cryptomator.integrations.update.UpdateMechanism; | ||
| import org.cryptomator.integrations.update.UpdateProcess; | ||
| 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.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.Collections; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.concurrent.CopyOnWriteArrayList; | ||
| import java.util.concurrent.CountDownLatch; | ||
| import java.util.concurrent.TimeUnit; | ||
| import java.util.concurrent.atomic.AtomicBoolean; | ||
|
|
||
| @Priority(1000) | ||
| @CheckAvailability | ||
| @DisplayName("Update via Flatpak update") | ||
| @OperatingSystem(OperatingSystem.Value.LINUX) | ||
| public class FlatpakUpdater implements UpdateMechanism { | ||
|
|
||
| private static final Logger LOG = LoggerFactory.getLogger(FlatpakUpdater.class); | ||
| private static final String APP_NAME = "org.cryptomator.Cryptomator"; | ||
|
|
||
| private final UpdatePortal portal; | ||
|
|
||
| public FlatpakUpdater() { | ||
| this.portal = new UpdatePortal(); | ||
| portal.CreateUpdateMonitor(UpdatePortal.OPTIONS_DUMMY); | ||
| } | ||
|
|
||
| @CheckAvailability | ||
| public boolean isSupported() { | ||
| return portal.isAvailable(); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean isUpdateAvailable(String installedVersion) { | ||
| var cdl = new CountDownLatch(1); | ||
| portal.setUpdateCheckerTaskFor(APP_NAME); | ||
| var checkTask = portal.getUpdateCheckerTaskFor(APP_NAME); | ||
| var updateAvailable = new AtomicBoolean(false); | ||
| checkTask.setOnSucceeded(updateVersion -> { | ||
| updateAvailable.set(UpdateMechanism.isUpdateAvailable(updateVersion, installedVersion)); | ||
| cdl.countDown(); | ||
| }); | ||
| checkTask.setOnFailed(error -> { | ||
| LOG.warn("Error while checking for updates.", error); | ||
| cdl.countDown(); | ||
| }); | ||
| try { | ||
| cdl.await(); | ||
| return updateAvailable.get(); | ||
| } catch (InterruptedException e) { | ||
| checkTask.cancel(); | ||
| Thread.currentThread().interrupt(); | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public UpdateProcess prepareUpdate() throws UpdateFailedException { | ||
| var monitorPath = portal.CreateUpdateMonitor(UpdatePortal.OPTIONS_DUMMY); | ||
| if (monitorPath == null) { | ||
| throw new UpdateFailedException("Failed to create UpdateMonitor on DBus"); | ||
| } | ||
|
|
||
| return new FlatpakUpdateProcess(portal.getUpdateMonitor(monitorPath.toString())); | ||
| } | ||
|
|
||
| private class FlatpakUpdateProcess implements UpdateProcess { | ||
|
|
||
| private final CountDownLatch latch = new CountDownLatch(1); | ||
| private final Flatpak.UpdateMonitor monitor; | ||
| private volatile double progress = 0.0; | ||
| private volatile UpdateFailedException error; | ||
| private AutoCloseable signalHandler; | ||
|
|
||
| private FlatpakUpdateProcess(Flatpak.UpdateMonitor monitor) { | ||
| this.monitor = monitor; | ||
| startUpdate(); | ||
| } | ||
|
|
||
| private void startUpdate() { | ||
| try { | ||
| this.signalHandler = portal.getDBusConnection().addSigHandler(Flatpak.UpdateMonitor.Progress.class, this::handleProgressSignal); | ||
| } catch (DBusException e) { | ||
| LOG.error("DBus error", e); | ||
| latch.countDown(); | ||
| } | ||
| portal.updateApp("x11:0", monitor, UpdatePortal.OPTIONS_DUMMY); | ||
| } | ||
|
|
||
| private void handleProgressSignal(Flatpak.UpdateMonitor.Progress signal) { | ||
| int status = ((UInt32) signal.info.get("status").getValue()).intValue(); | ||
| switch (status) { | ||
| case 0 -> { // In progress | ||
| Variant<?> progressVariant = signal.info.get("progress"); | ||
| if (progressVariant != null) { | ||
| progress = ((UInt32) progressVariant.getValue()).doubleValue() / 100.0; // progress reported as int in range [0, 100] | ||
| } | ||
| } | ||
| case 1 -> { // No update available | ||
| error = new UpdateFailedException("No update available"); | ||
| latch.countDown(); | ||
| } | ||
| case 2 -> { // Update complete | ||
| progress = 1.0; | ||
| latch.countDown(); | ||
| } | ||
| case 3 -> { // Update failed | ||
| error = new UpdateFailedException("Update preparation failed"); | ||
| latch.countDown(); | ||
| } | ||
| default -> { | ||
| error = new UpdateFailedException("Unknown update status " + status); | ||
| latch.countDown(); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private void stopReceivingSignals() { | ||
| if (signalHandler != null) { | ||
| try { | ||
| signalHandler.close(); | ||
| } catch (Exception e) { | ||
| LOG.error("Failed to close signal handler", e); | ||
| } | ||
| signalHandler = null; | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public double preparationProgress() { | ||
| return progress; | ||
| } | ||
|
|
||
| @Override | ||
| public void cancel() { | ||
| portal.cancelUpdateMonitor(monitor); | ||
| stopReceivingSignals(); | ||
| portal.close(); // TODO: is this right? belongs to parent class. update can not be retried afterwards. or should each process have its own portal instance? | ||
| error = new UpdateFailedException("Update cancelled by user"); | ||
| } | ||
|
Comment on lines
+154
to
+158
There was a problem hiding this comment. 🛠️ Refactor suggestion Portal lifecycle & resource leak
🤖 Prompt for AI Agents |
||
|
|
||
| @Override | ||
| public void await() throws InterruptedException { | ||
| latch.await(); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean await(long timeout, TimeUnit unit) throws InterruptedException { | ||
| return latch.await(timeout, unit); | ||
| } | ||
|
|
||
| private boolean isDone() { | ||
| try { | ||
| return latch.await(0, TimeUnit.MILLISECONDS); | ||
| } catch (InterruptedException e) { | ||
| Thread.currentThread().interrupt(); | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public ProcessHandle applyUpdate() throws IllegalStateException, IOException { | ||
| if (!isDone()) { | ||
| throw new IllegalStateException("Update preparation is not complete"); | ||
| } | ||
| stopReceivingSignals(); | ||
| if (error != null) { | ||
| throw error; | ||
| } | ||
|
|
||
| // spawn new Cryptomator process: | ||
| 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; | ||
| var pid = portal.Spawn(cwdPath, argv, fds, envs, flags, options).longValue(); | ||
| return ProcessHandle.of(pid).orElseThrow(); | ||
| } | ||
| } | ||
|
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| org.cryptomator.linux.update.FlatpakUpdater |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Remove unnecessary monitor creation in constructor.
The constructor creates an update monitor but doesn't check or use the result. This monitor should be created lazily when first needed via
getUpdateMonitor().public FlatpakUpdater() { this.portal = new UpdatePortal(); - portal.CreateUpdateMonitor(UpdatePortal.OPTIONS_DUMMY); }📝 Committable suggestion
🤖 Prompt for AI Agents