External update mechanism

src/main/java/module-info.java

@@ -6,6 +6,7 @@
 import org.cryptomator.integrations.keychain.KeychainAccessProvider;
 import org.cryptomator.integrations.tray.TrayIntegrationProvider;
 import org.cryptomator.integrations.uiappearance.UiAppearanceProvider;
+import org.cryptomator.integrations.update.UpdateService;
 
 
 module org.cryptomator.integrations.api {
@@ -20,6 +21,7 @@
 	exports org.cryptomator.integrations.tray;
 	exports org.cryptomator.integrations.uiappearance;
 	exports org.cryptomator.integrations.quickaccess;
+	exports org.cryptomator.integrations.update;
 
 	uses AutoStartProvider;
 	uses KeychainAccessProvider;
@@ -29,4 +31,5 @@
 	uses TrayMenuController;
 	uses UiAppearanceProvider;
 	uses QuickAccessService;
+	uses UpdateService;
 }

src/main/java/org/cryptomator/integrations/common/DistributionChannel.java

@@ -0,0 +1,41 @@
+package org.cryptomator.integrations.common;
+
+import org.jetbrains.annotations.ApiStatus;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Repeatable;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Documented
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ElementType.TYPE})
+@Repeatable(DistributionChannel.DistributionChannels.class)
+@ApiStatus.Experimental
+public @interface DistributionChannel {
+	Value value() default Value.UNKNOWN;
+
+	@Documented
+	@Retention(RetentionPolicy.RUNTIME)
+	@Target({ElementType.TYPE})
+	@interface DistributionChannels {
+		DistributionChannel[] value();
+	}
+
+	enum Value {
+		LINUX_APPIMAGE,
+		LINUX_AUR,
+		LINUX_FLATPAK,
+		LINUX_NIXOS,
+		LINUX_PPA,
+		MAC_BREW,
+		MAC_DMG,
+		WINDOWS_EXE,
+		WINDOWS_MSI,
+		WINDOWS_WINGET,
+		UNKNOWN;
+
+	}
+}

src/main/java/org/cryptomator/integrations/update/Progress.java

@@ -0,0 +1,32 @@
+package org.cryptomator.integrations.update;
+
+public class Progress {
+	private final long nOps;
+	private final long oP;
+	private final long status;
+	private final long progress;
+	private final String error;
+	private final String errorMessage;
+
+	public Progress(long nOps, long oP, long status, long progress, String error, String errorMessage) {
+		this.nOps = nOps;
+		this.oP = oP;
+		this.status = status;
+		this.progress = progress;
+		this.error = error;
+		this.errorMessage = errorMessage;
+	}
+
+	public long getOP() { return oP; }
+	public long getNOps() {
+		return nOps;
+	}
+	public long getStatus() {
+		return status;
+	}
+	public long getProgress() {
+		return progress;
+	}
+	public String getError() { return error; }
+	public String getErrorMessage() { return errorMessage; }
+}

src/main/java/org/cryptomator/integrations/update/ProgressListener.java

@@ -0,0 +1,6 @@
+package org.cryptomator.integrations.update;
+
+@FunctionalInterface
+public interface ProgressListener {
+	void onProgress(Progress progress);
+}

src/main/java/org/cryptomator/integrations/update/SpawnExited.java

@@ -0,0 +1,14 @@
+package org.cryptomator.integrations.update;
+
+public class SpawnExited {
+	private final long pid;
+	private final long exitStatus;
+
+	public SpawnExited(long pid, long exitStatus) {
+		this.pid = pid;
+		this.exitStatus = exitStatus;
+	}
+
+	public long getPid() {  return pid; }
+	public long getExitStatus() { return exitStatus; }
+}

src/main/java/org/cryptomator/integrations/update/SpawnExitedListener.java

@@ -0,0 +1,6 @@
+package org.cryptomator.integrations.update;
+
+@FunctionalInterface
+public interface SpawnExitedListener {
+	void onSpawnExited(SpawnExited spawnExited);
+}

src/main/java/org/cryptomator/integrations/update/SpawnStarted.java

@@ -0,0 +1,14 @@
+package org.cryptomator.integrations.update;
+
+public class SpawnStarted {
+	private final long pid;
+	private final long relPid;
+
+	public SpawnStarted(long pid, long relPid) {
+		this.pid = pid;
+		this.relPid = relPid;
+	}
+
+	public long getPid() {  return pid; }
+	public long getRelPid() { return relPid; }
+}

src/main/java/org/cryptomator/integrations/update/SpawnStartedListener.java

@@ -0,0 +1,6 @@
+package org.cryptomator.integrations.update;
+
+@FunctionalInterface
+public interface SpawnStartedListener {
+	void onSpawnStarted(SpawnStarted spawnStarted);
+}

src/main/java/org/cryptomator/integrations/update/UpdateAvailable.java

@@ -0,0 +1,23 @@
+package org.cryptomator.integrations.update;
+
+public class UpdateAvailable {
+	private final String runningCommit;
+	private final String localCommit;
+	private final String remoteCommit;
+
+	public UpdateAvailable(String runningCommit, String localCommit, String remoteCommit) {
+		this.runningCommit = runningCommit;
+		this.localCommit = localCommit;
+		this.remoteCommit = remoteCommit;
+	}
+
+	public String getRunningCommit() {
+		return runningCommit;
+	}
+	public String getLocalCommit() {
+		return localCommit;
+	}
+	public String getRemoteCommit() {
+		return remoteCommit;
+	}
+}

src/main/java/org/cryptomator/integrations/update/UpdateAvailableListener.java

@@ -0,0 +1,6 @@
+package org.cryptomator.integrations.update;
+
+@FunctionalInterface
+public interface UpdateAvailableListener {
+	void onUpdateAvailable(UpdateAvailable updateAvailable);
+}

src/main/java/org/cryptomator/integrations/update/UpdateFailedException.java

@@ -0,0 +1,12 @@
+package org.cryptomator.integrations.update;
+
+public class UpdateFailedException extends Exception {
+
+	public UpdateFailedException(String message) {
+		super(message);
+	}
+
+	public UpdateFailedException(String message, Throwable cause) {
+		super(message, cause);
+	}
+}

src/main/java/org/cryptomator/integrations/update/UpdateService.java

@@ -0,0 +1,119 @@
+package org.cryptomator.integrations.update;
+
+import org.cryptomator.integrations.common.DistributionChannel;
+import org.cryptomator.integrations.common.IntegrationsLoader;
+
+import java.util.stream.Stream;
+
+/**
+ * This is the interface used by Cryptomator to provide a way to update Cryptomator in a convinient way.
+ * It's idependent of the supported platforms and package distribution channels.
+ */
+public interface UpdateService {
+
+	static Stream<UpdateService> get() {
+		return IntegrationsLoader.loadAll(UpdateService.class).filter(UpdateService::isSupported);
+	}
+
+	/**
+	 * @return <code>true</code> if this UppdateService can update the app.
+	 * @implSpec This method must not throw any exceptions and should fail fast
+	 * returning <code>false</code> if it's not possible to use this UppdateService
+	 */
+	boolean isSupported();
+
+	/**
+	 * Retrieve an object to check for the latest release published on the given channel.
+	 *
+	 * @param channel The DistributionChannel.Value to check.
+	 * @return        An object that is capable of checking asynchronously for the latest release.
+	 */
+	Object getLatestReleaseChecker(DistributionChannel.Value channel);
+
+	/**
+	 * Trigger updating the app.
+	 *
+	 * @throws UpdateFailedException If the udpate wasn't successful or was cancelled.
+	 */
+	void triggerUpdate() throws UpdateFailedException;
+
+	/**
+	 * Start a new instance of the application.
+	 *
+	 * @return The PID of the new process.
+	 */
+	long spawnApp();
+
+	/**
+	 * A flag indicating whether elevated permissions or sudo is required during update
+	 * (so the user can be prepared for a corresponding prompt)
+	 *
+	 * @return <code>true</code> if elevated permissions are required, <code>false</code> otherwise.
+	 */
+	boolean doesRequireElevatedPermissions();
+
+	/**
+	 * Get a meaningful description of the update available to display it in the app
+	 * like "Update via apt"
+	 *
+	 * @return The text to describes the update.
+	 */
+	String getDisplayName();
+
+	/**
+	 * Register a listener to receive update available events.
+	 *
+	 * @param listener The listener to register.
+	 */
+	void addUpdateAvailableListener(UpdateAvailableListener listener);
+
+	/**
+	 * Unregister a previously registered update available listener.
+	 *
+	 * @param listener The listener to unregister.
+	 */
+	void removeUpdateAvailableListener(UpdateAvailableListener listener);
+
+	/**
+	 * Register a listener to receive update progress events.
+	 *
+	 * @param listener The listener to register.
+	 */
+	void addProgressListener(ProgressListener listener);
+
+	/**
+	 * Unregister a previously registered update progress listener.
+	 *
+	 * @param listener The listener to unregister.
+	 */
+	void removeProgressListener(ProgressListener listener);
+
+	/**
+	 * Register a listener to receive an event containing the pid of a spawned process.
+	 *
+	 * @param listener The listener to register.
+	 */
+	void addSpawnStartedListener(SpawnStartedListener listener);
+
+	/**
+	 * Unregister a previously registered spawned process listener.
+	 *
+	 * @param listener The listener to unregister.
+	 */
+	void removeSpawnStartedListener(SpawnStartedListener listener);
+
+	/**
+	 * Register a listener to receive an event containing the pid
+	 * and exit status of a process that exits.
+	 *
+	 * @param listener The listener to register.
+	 */
+	void addSpawnExitedListener(SpawnExitedListener listener);
+
+	/**
+	 * Unregister a previously registered process exits listener.
+	 *
+	 * @param listener The listener to unregister.
+	 */
+	void removeSpawnExitedListener(SpawnExitedListener listener);
+}