From ba627d0d6021217ece6eddb6ab889a5ee3c936d8 Mon Sep 17 00:00:00 2001 From: Rexbas Date: Sun, 19 Feb 2023 16:29:06 +0100 Subject: [PATCH 01/29] Add a scheduled service to auto unlock vaults that were missing at startup --- .../cryptomator/ui/fxapp/AutoUnlocker.java | 67 +++++++++++++++++-- .../cryptomator/ui/fxapp/FxApplication.java | 4 +- 2 files changed, 62 insertions(+), 9 deletions(-) diff --git a/src/main/java/org/cryptomator/ui/fxapp/AutoUnlocker.java b/src/main/java/org/cryptomator/ui/fxapp/AutoUnlocker.java index 973d919fc..410910e47 100644 --- a/src/main/java/org/cryptomator/ui/fxapp/AutoUnlocker.java +++ b/src/main/java/org/cryptomator/ui/fxapp/AutoUnlocker.java @@ -1,30 +1,83 @@ package org.cryptomator.ui.fxapp; import org.cryptomator.common.vaults.Vault; +import org.cryptomator.common.vaults.VaultListManager; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import javax.inject.Inject; import javafx.collections.ObservableList; +import java.util.Arrays; import java.util.concurrent.CompletableFuture; import java.util.concurrent.CompletionStage; +import java.util.concurrent.ScheduledExecutorService; +import java.util.concurrent.ScheduledFuture; +import java.util.concurrent.TimeUnit; +import java.util.stream.Stream; @FxApplicationScoped public class AutoUnlocker { + private static final Logger LOG = LoggerFactory.getLogger(AutoUnlocker.class); + private final ObservableList vaults; private final FxApplicationWindows appWindows; + private final ScheduledExecutorService scheduler; + private ScheduledFuture future; + private boolean isPeriodicCheckActive = false; @Inject - public AutoUnlocker(ObservableList vaults, FxApplicationWindows appWindows) { + public AutoUnlocker(ObservableList vaults, FxApplicationWindows appWindows, ScheduledExecutorService scheduler) { this.vaults = vaults; this.appWindows = appWindows; + this.scheduler = scheduler; } - public void unlock() { - vaults.stream().filter(Vault::isLocked) // - .filter(v -> v.getVaultSettings().unlockAfterStartup().get()) // - .>reduce(CompletableFuture.completedFuture(null), // - (unlockFlow, v) -> unlockFlow.handle((voit, ex) -> appWindows.startUnlockWorkflow(v, null)).thenCompose(stage -> stage), //we don't care here about the exception, logged elsewhere - (unlockChain1, unlockChain2) -> unlockChain1.handle((voit, ex) -> unlockChain2).thenCompose(stage -> stage)); + public void unlockAll() { + unlock(vaults.stream().filter(v -> v.getVaultSettings().unlockAfterStartup().get())); } + public void unlock(Stream vaultStream) { + vaultStream.filter(Vault::isLocked) + .>reduce(CompletableFuture.completedFuture(null), + (unlockFlow, v) -> unlockFlow.handle((voit, ex) -> appWindows.startUnlockWorkflow(v, null)).thenCompose(stage -> stage), // we don't care here about the exception, logged elsewhere + (unlockChain1, unlockChain2) -> unlockChain1.handle((voit, ex) -> unlockChain2).thenCompose(stage -> stage)); + } + + public void startMissingVaultsChecker() { + if (!isPeriodicCheckActive && getMissingAutoUnlockVaults().count() > 0) { + LOG.info("Found MISSING vaults, starting periodic check"); + future = scheduler.scheduleWithFixedDelay(this::tick, 0, 1, TimeUnit.SECONDS); + isPeriodicCheckActive = true; + } + } + + private void tick() { + // Find the vaults that are missing but have an existing directory + Vault[] vaultArray = getMissingAutoUnlockVaults().filter(v -> v.getPath().toFile().isDirectory()).toArray(Vault[]::new); + if (vaultArray.length > 0) { + + // Redetermine vault states + for (Vault v : vaultArray) { + LOG.info("Found vault directory for '{}'", v.getDisplayName()); + VaultListManager.redetermineVaultState(v); + } + + // Unlock the vaults that were previously missing + unlock(Arrays.stream(vaultArray)); + } + + // Stop checking if there are no more missing vaults + if (getMissingAutoUnlockVaults().count() == 0) { + LOG.info("No more MISSING vaults, stopping periodic check"); + isPeriodicCheckActive = false; + future.cancel(false); + } + } + + private Stream getMissingAutoUnlockVaults() { + return vaults.stream() + .filter(Vault::isMissing) + .filter(v -> v.getVaultSettings().unlockAfterStartup().get()); + } } diff --git a/src/main/java/org/cryptomator/ui/fxapp/FxApplication.java b/src/main/java/org/cryptomator/ui/fxapp/FxApplication.java index 3ddb7cba6..850d2a91e 100644 --- a/src/main/java/org/cryptomator/ui/fxapp/FxApplication.java +++ b/src/main/java/org/cryptomator/ui/fxapp/FxApplication.java @@ -68,7 +68,7 @@ public class FxApplication { }); launchEventHandler.startHandlingLaunchEvents(); - autoUnlocker.unlock(); + autoUnlocker.unlockAll(); + autoUnlocker.startMissingVaultsChecker(); } - } From 72fd38baf15808537e3ef2931d626fef9950019c Mon Sep 17 00:00:00 2001 From: Rexbas Date: Sat, 6 May 2023 15:40:24 +0200 Subject: [PATCH 02/29] Add timeout to periodic missing vaults check --- .../org/cryptomator/ui/fxapp/AutoUnlocker.java | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/src/main/java/org/cryptomator/ui/fxapp/AutoUnlocker.java b/src/main/java/org/cryptomator/ui/fxapp/AutoUnlocker.java index 410910e47..79b440782 100644 --- a/src/main/java/org/cryptomator/ui/fxapp/AutoUnlocker.java +++ b/src/main/java/org/cryptomator/ui/fxapp/AutoUnlocker.java @@ -23,7 +23,8 @@ public class AutoUnlocker { private final ObservableList vaults; private final FxApplicationWindows appWindows; private final ScheduledExecutorService scheduler; - private ScheduledFuture future; + private ScheduledFuture checkFuture; + private ScheduledFuture timeoutFuture; private boolean isPeriodicCheckActive = false; @Inject @@ -47,12 +48,13 @@ public class AutoUnlocker { public void startMissingVaultsChecker() { if (!isPeriodicCheckActive && getMissingAutoUnlockVaults().count() > 0) { LOG.info("Found MISSING vaults, starting periodic check"); - future = scheduler.scheduleWithFixedDelay(this::tick, 0, 1, TimeUnit.SECONDS); + checkFuture = scheduler.scheduleWithFixedDelay(this::check, 0, 1, TimeUnit.SECONDS); + timeoutFuture = scheduler.schedule(this::timeout, 2, TimeUnit.MINUTES); isPeriodicCheckActive = true; } } - private void tick() { + private void check() { // Find the vaults that are missing but have an existing directory Vault[] vaultArray = getMissingAutoUnlockVaults().filter(v -> v.getPath().toFile().isDirectory()).toArray(Vault[]::new); if (vaultArray.length > 0) { @@ -71,10 +73,17 @@ public class AutoUnlocker { if (getMissingAutoUnlockVaults().count() == 0) { LOG.info("No more MISSING vaults, stopping periodic check"); isPeriodicCheckActive = false; - future.cancel(false); + checkFuture.cancel(false); + timeoutFuture.cancel(false); } } + private void timeout() { + LOG.info("MISSING vaults periodic check timed out"); + isPeriodicCheckActive = false; + checkFuture.cancel(false); + } + private Stream getMissingAutoUnlockVaults() { return vaults.stream() .filter(Vault::isMissing) From 1253b7db2b3056427a70a448ca5abcebc35740d7 Mon Sep 17 00:00:00 2001 From: Rexbas Date: Thu, 11 May 2023 20:43:23 +0200 Subject: [PATCH 03/29] Make unlock method private and simplify missing vaults unlocker --- .../cryptomator/ui/fxapp/AutoUnlocker.java | 52 +++++++------------ .../cryptomator/ui/fxapp/FxApplication.java | 3 +- 2 files changed, 20 insertions(+), 35 deletions(-) diff --git a/src/main/java/org/cryptomator/ui/fxapp/AutoUnlocker.java b/src/main/java/org/cryptomator/ui/fxapp/AutoUnlocker.java index 79b440782..a4754fd29 100644 --- a/src/main/java/org/cryptomator/ui/fxapp/AutoUnlocker.java +++ b/src/main/java/org/cryptomator/ui/fxapp/AutoUnlocker.java @@ -7,7 +7,7 @@ import org.slf4j.LoggerFactory; import javax.inject.Inject; import javafx.collections.ObservableList; -import java.util.Arrays; +import java.util.List; import java.util.concurrent.CompletableFuture; import java.util.concurrent.CompletionStage; import java.util.concurrent.ScheduledExecutorService; @@ -23,9 +23,8 @@ public class AutoUnlocker { private final ObservableList vaults; private final FxApplicationWindows appWindows; private final ScheduledExecutorService scheduler; - private ScheduledFuture checkFuture; + private ScheduledFuture unlockMissingFuture; private ScheduledFuture timeoutFuture; - private boolean isPeriodicCheckActive = false; @Inject public AutoUnlocker(ObservableList vaults, FxApplicationWindows appWindows, ScheduledExecutorService scheduler) { @@ -34,54 +33,41 @@ public class AutoUnlocker { this.scheduler = scheduler; } - public void unlockAll() { + public void tryUnlockForTimespan(int timespan) { + // Unlock all available auto unlock vaults unlock(vaults.stream().filter(v -> v.getVaultSettings().unlockAfterStartup().get())); + + // Start a temporary service if there are missing auto unlock vaults + if (getMissingAutoUnlockVaults().findAny().isPresent()) { + LOG.info("Found MISSING vaults, starting periodic check"); + unlockMissingFuture = scheduler.scheduleWithFixedDelay(this::unlockMissing, 0, 1, TimeUnit.SECONDS); + timeoutFuture = scheduler.schedule(this::timeout, timespan, TimeUnit.MINUTES); + } } - public void unlock(Stream vaultStream) { + private void unlock(Stream vaultStream) { vaultStream.filter(Vault::isLocked) .>reduce(CompletableFuture.completedFuture(null), (unlockFlow, v) -> unlockFlow.handle((voit, ex) -> appWindows.startUnlockWorkflow(v, null)).thenCompose(stage -> stage), // we don't care here about the exception, logged elsewhere (unlockChain1, unlockChain2) -> unlockChain1.handle((voit, ex) -> unlockChain2).thenCompose(stage -> stage)); } - public void startMissingVaultsChecker() { - if (!isPeriodicCheckActive && getMissingAutoUnlockVaults().count() > 0) { - LOG.info("Found MISSING vaults, starting periodic check"); - checkFuture = scheduler.scheduleWithFixedDelay(this::check, 0, 1, TimeUnit.SECONDS); - timeoutFuture = scheduler.schedule(this::timeout, 2, TimeUnit.MINUTES); - isPeriodicCheckActive = true; - } - } - - private void check() { - // Find the vaults that are missing but have an existing directory - Vault[] vaultArray = getMissingAutoUnlockVaults().filter(v -> v.getPath().toFile().isDirectory()).toArray(Vault[]::new); - if (vaultArray.length > 0) { - - // Redetermine vault states - for (Vault v : vaultArray) { - LOG.info("Found vault directory for '{}'", v.getDisplayName()); - VaultListManager.redetermineVaultState(v); - } - - // Unlock the vaults that were previously missing - unlock(Arrays.stream(vaultArray)); - } + private void unlockMissing() { + List missingAutoUnlockVaults = getMissingAutoUnlockVaults().toList(); + missingAutoUnlockVaults.forEach(VaultListManager::redetermineVaultState); + unlock(missingAutoUnlockVaults.stream()); // Stop checking if there are no more missing vaults - if (getMissingAutoUnlockVaults().count() == 0) { + if (getMissingAutoUnlockVaults().findAny().isEmpty()) { LOG.info("No more MISSING vaults, stopping periodic check"); - isPeriodicCheckActive = false; - checkFuture.cancel(false); + unlockMissingFuture.cancel(false); timeoutFuture.cancel(false); } } private void timeout() { LOG.info("MISSING vaults periodic check timed out"); - isPeriodicCheckActive = false; - checkFuture.cancel(false); + unlockMissingFuture.cancel(false); } private Stream getMissingAutoUnlockVaults() { diff --git a/src/main/java/org/cryptomator/ui/fxapp/FxApplication.java b/src/main/java/org/cryptomator/ui/fxapp/FxApplication.java index 850d2a91e..736b793d2 100644 --- a/src/main/java/org/cryptomator/ui/fxapp/FxApplication.java +++ b/src/main/java/org/cryptomator/ui/fxapp/FxApplication.java @@ -68,7 +68,6 @@ public class FxApplication { }); launchEventHandler.startHandlingLaunchEvents(); - autoUnlocker.unlockAll(); - autoUnlocker.startMissingVaultsChecker(); + autoUnlocker.tryUnlockForTimespan(2); } } From 32d7189a12817a72b9bade58bd79484197852ddc Mon Sep 17 00:00:00 2001 From: Rexbas Date: Fri, 12 May 2023 21:52:30 +0200 Subject: [PATCH 04/29] Add time unit parameter --- src/main/java/org/cryptomator/ui/fxapp/AutoUnlocker.java | 4 ++-- src/main/java/org/cryptomator/ui/fxapp/FxApplication.java | 3 ++- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/src/main/java/org/cryptomator/ui/fxapp/AutoUnlocker.java b/src/main/java/org/cryptomator/ui/fxapp/AutoUnlocker.java index a4754fd29..bf40971c6 100644 --- a/src/main/java/org/cryptomator/ui/fxapp/AutoUnlocker.java +++ b/src/main/java/org/cryptomator/ui/fxapp/AutoUnlocker.java @@ -33,7 +33,7 @@ public class AutoUnlocker { this.scheduler = scheduler; } - public void tryUnlockForTimespan(int timespan) { + public void tryUnlockForTimespan(int timespan, TimeUnit timeUnit) { // Unlock all available auto unlock vaults unlock(vaults.stream().filter(v -> v.getVaultSettings().unlockAfterStartup().get())); @@ -41,7 +41,7 @@ public class AutoUnlocker { if (getMissingAutoUnlockVaults().findAny().isPresent()) { LOG.info("Found MISSING vaults, starting periodic check"); unlockMissingFuture = scheduler.scheduleWithFixedDelay(this::unlockMissing, 0, 1, TimeUnit.SECONDS); - timeoutFuture = scheduler.schedule(this::timeout, timespan, TimeUnit.MINUTES); + timeoutFuture = scheduler.schedule(this::timeout, timespan, timeUnit); } } diff --git a/src/main/java/org/cryptomator/ui/fxapp/FxApplication.java b/src/main/java/org/cryptomator/ui/fxapp/FxApplication.java index 736b793d2..cfc7ba62b 100644 --- a/src/main/java/org/cryptomator/ui/fxapp/FxApplication.java +++ b/src/main/java/org/cryptomator/ui/fxapp/FxApplication.java @@ -9,6 +9,7 @@ import org.slf4j.LoggerFactory; import javax.inject.Inject; import javax.inject.Named; import javafx.application.Platform; +import java.util.concurrent.TimeUnit; @FxApplicationScoped public class FxApplication { @@ -68,6 +69,6 @@ public class FxApplication { }); launchEventHandler.startHandlingLaunchEvents(); - autoUnlocker.tryUnlockForTimespan(2); + autoUnlocker.tryUnlockForTimespan(2, TimeUnit.MINUTES); } } From 5b6d09308b5a1ff4e513aeaf086096bc43f9f058 Mon Sep 17 00:00:00 2001 From: Armin Schrenk Date: Tue, 16 May 2023 17:05:54 +0200 Subject: [PATCH 05/29] Create SPI for cloud location presets --- src/main/java/module-info.java | 16 +++ .../DropboxMacLocationPresetsProvider.java | 27 +++++ ...DropboxWindowsLocationPresetsProvider.java | 27 +++++ ...GoogleDriveMacLocationPresetsProvider.java | 27 +++++ ...leDriveWindowsLocationPresetsProvider.java | 27 +++++ .../ICloudMacLocationPresetsProvider.java | 26 +++++ .../ICloudWindowsLocationPresetsProvider.java | 26 +++++ .../locationpresets/LocationPreset.java | 9 ++ .../LocationPresetsProvider.java | 20 ++++ .../MegaLocationPresetsProvider.java | 28 +++++ .../OneDriveMacLocationPresetsProvider.java | 27 +++++ ...neDriveWindowsLocationPresetsProvider.java | 107 ++++++++++++++++++ .../PCloudLocationPresetsProvider.java | 29 +++++ 13 files changed, 396 insertions(+) create mode 100644 src/main/java/org/cryptomator/common/locationpresets/DropboxMacLocationPresetsProvider.java create mode 100644 src/main/java/org/cryptomator/common/locationpresets/DropboxWindowsLocationPresetsProvider.java create mode 100644 src/main/java/org/cryptomator/common/locationpresets/GoogleDriveMacLocationPresetsProvider.java create mode 100644 src/main/java/org/cryptomator/common/locationpresets/GoogleDriveWindowsLocationPresetsProvider.java create mode 100644 src/main/java/org/cryptomator/common/locationpresets/ICloudMacLocationPresetsProvider.java create mode 100644 src/main/java/org/cryptomator/common/locationpresets/ICloudWindowsLocationPresetsProvider.java create mode 100644 src/main/java/org/cryptomator/common/locationpresets/LocationPreset.java create mode 100644 src/main/java/org/cryptomator/common/locationpresets/LocationPresetsProvider.java create mode 100644 src/main/java/org/cryptomator/common/locationpresets/MegaLocationPresetsProvider.java create mode 100644 src/main/java/org/cryptomator/common/locationpresets/OneDriveMacLocationPresetsProvider.java create mode 100644 src/main/java/org/cryptomator/common/locationpresets/OneDriveWindowsLocationPresetsProvider.java create mode 100644 src/main/java/org/cryptomator/common/locationpresets/PCloudLocationPresetsProvider.java diff --git a/src/main/java/module-info.java b/src/main/java/module-info.java index a4a71a2cc..b24f2b841 100644 --- a/src/main/java/module-info.java +++ b/src/main/java/module-info.java @@ -1,4 +1,15 @@ import ch.qos.logback.classic.spi.Configurator; +import org.cryptomator.common.locationpresets.DropboxMacLocationPresetsProvider; +import org.cryptomator.common.locationpresets.DropboxWindowsLocationPresetsProvider; +import org.cryptomator.common.locationpresets.GoogleDriveMacLocationPresetsProvider; +import org.cryptomator.common.locationpresets.GoogleDriveWindowsLocationPresetsProvider; +import org.cryptomator.common.locationpresets.ICloudMacLocationPresetsProvider; +import org.cryptomator.common.locationpresets.ICloudWindowsLocationPresetsProvider; +import org.cryptomator.common.locationpresets.LocationPresetsProvider; +import org.cryptomator.common.locationpresets.MegaLocationPresetsProvider; +import org.cryptomator.common.locationpresets.OneDriveMacLocationPresetsProvider; +import org.cryptomator.common.locationpresets.OneDriveWindowsLocationPresetsProvider; +import org.cryptomator.common.locationpresets.PCloudLocationPresetsProvider; import org.cryptomator.integrations.tray.TrayMenuController; import org.cryptomator.logging.LogbackConfiguratorFactory; import org.cryptomator.ui.traymenu.AwtTrayMenuController; @@ -39,4 +50,9 @@ open module org.cryptomator.desktop { provides TrayMenuController with AwtTrayMenuController; provides Configurator with LogbackConfiguratorFactory; + provides LocationPresetsProvider with DropboxMacLocationPresetsProvider, // + DropboxWindowsLocationPresetsProvider, ICloudMacLocationPresetsProvider, // + ICloudWindowsLocationPresetsProvider, GoogleDriveWindowsLocationPresetsProvider, // + GoogleDriveMacLocationPresetsProvider, PCloudLocationPresetsProvider, // + MegaLocationPresetsProvider, OneDriveMacLocationPresetsProvider, OneDriveWindowsLocationPresetsProvider; } \ No newline at end of file diff --git a/src/main/java/org/cryptomator/common/locationpresets/DropboxMacLocationPresetsProvider.java b/src/main/java/org/cryptomator/common/locationpresets/DropboxMacLocationPresetsProvider.java new file mode 100644 index 000000000..6da4ccbea --- /dev/null +++ b/src/main/java/org/cryptomator/common/locationpresets/DropboxMacLocationPresetsProvider.java @@ -0,0 +1,27 @@ +package org.cryptomator.common.locationpresets; + +import org.cryptomator.integrations.common.CheckAvailability; +import org.cryptomator.integrations.common.OperatingSystem; + +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.stream.Stream; + +import static org.cryptomator.integrations.common.OperatingSystem.Value.MAC; + +@OperatingSystem(MAC) +public final class DropboxMacLocationPresetsProvider implements LocationPresetsProvider { + + private static final Path LOCATION = LocationPresetsProvider.resolveLocation("~/Library/CloudStorage/Dropbox"); + + + @CheckAvailability + public static boolean isPresent() { + return Files.isDirectory(LOCATION); + } + + @Override + public Stream getLocations() { + return Stream.of(new LocationPreset("Dropbox", LOCATION)); + } +} diff --git a/src/main/java/org/cryptomator/common/locationpresets/DropboxWindowsLocationPresetsProvider.java b/src/main/java/org/cryptomator/common/locationpresets/DropboxWindowsLocationPresetsProvider.java new file mode 100644 index 000000000..132cf008e --- /dev/null +++ b/src/main/java/org/cryptomator/common/locationpresets/DropboxWindowsLocationPresetsProvider.java @@ -0,0 +1,27 @@ +package org.cryptomator.common.locationpresets; + +import org.cryptomator.integrations.common.CheckAvailability; +import org.cryptomator.integrations.common.OperatingSystem; + +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.stream.Stream; + +import static org.cryptomator.integrations.common.OperatingSystem.Value.WINDOWS; + +@OperatingSystem(WINDOWS) +public final class DropboxWindowsLocationPresetsProvider implements LocationPresetsProvider { + + private static final Path LOCATION = LocationPresetsProvider.resolveLocation("~/Dropbox"); + + + @CheckAvailability + public static boolean isPresent() { + return Files.isDirectory(LOCATION); + } + + @Override + public Stream getLocations() { + return Stream.of(new LocationPreset("Dropbox", LOCATION)); + } +} diff --git a/src/main/java/org/cryptomator/common/locationpresets/GoogleDriveMacLocationPresetsProvider.java b/src/main/java/org/cryptomator/common/locationpresets/GoogleDriveMacLocationPresetsProvider.java new file mode 100644 index 000000000..1e1b7763a --- /dev/null +++ b/src/main/java/org/cryptomator/common/locationpresets/GoogleDriveMacLocationPresetsProvider.java @@ -0,0 +1,27 @@ +package org.cryptomator.common.locationpresets; + +import org.cryptomator.integrations.common.CheckAvailability; +import org.cryptomator.integrations.common.OperatingSystem; + +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.stream.Stream; + +import static org.cryptomator.integrations.common.OperatingSystem.Value.MAC; + +@OperatingSystem(MAC) +public final class GoogleDriveMacLocationPresetsProvider implements LocationPresetsProvider { + + private static final Path LOCATION = LocationPresetsProvider.resolveLocation("~/Google Drive"); + + + @CheckAvailability + public static boolean isPresent() { + return Files.isDirectory(LOCATION); + } + + @Override + public Stream getLocations() { + return Stream.of(new LocationPreset("Google Drive", LOCATION)); + } +} diff --git a/src/main/java/org/cryptomator/common/locationpresets/GoogleDriveWindowsLocationPresetsProvider.java b/src/main/java/org/cryptomator/common/locationpresets/GoogleDriveWindowsLocationPresetsProvider.java new file mode 100644 index 000000000..b99e4383a --- /dev/null +++ b/src/main/java/org/cryptomator/common/locationpresets/GoogleDriveWindowsLocationPresetsProvider.java @@ -0,0 +1,27 @@ +package org.cryptomator.common.locationpresets; + +import org.cryptomator.integrations.common.CheckAvailability; +import org.cryptomator.integrations.common.OperatingSystem; + +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.stream.Stream; + +import static org.cryptomator.integrations.common.OperatingSystem.Value.WINDOWS; + +@OperatingSystem(WINDOWS) +public final class GoogleDriveWindowsLocationPresetsProvider implements LocationPresetsProvider { + + private static final Path LOCATION = LocationPresetsProvider.resolveLocation("~/Google Drive/My Drive"); + + + @CheckAvailability + public static boolean isPresent() { + return Files.isDirectory(LOCATION); + } + + @Override + public Stream getLocations() { + return Stream.of(new LocationPreset("Google Drive", LOCATION)); + } +} diff --git a/src/main/java/org/cryptomator/common/locationpresets/ICloudMacLocationPresetsProvider.java b/src/main/java/org/cryptomator/common/locationpresets/ICloudMacLocationPresetsProvider.java new file mode 100644 index 000000000..2d94c1bde --- /dev/null +++ b/src/main/java/org/cryptomator/common/locationpresets/ICloudMacLocationPresetsProvider.java @@ -0,0 +1,26 @@ +package org.cryptomator.common.locationpresets; + +import org.cryptomator.integrations.common.CheckAvailability; +import org.cryptomator.integrations.common.OperatingSystem; + +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.stream.Stream; + +import static org.cryptomator.integrations.common.OperatingSystem.Value.MAC; + +@OperatingSystem(MAC) +public final class ICloudMacLocationPresetsProvider implements LocationPresetsProvider { + + private static final Path LOCATION = LocationPresetsProvider.resolveLocation("~/Library/Mobile Documents/com~apple~CloudDocs"); + + @CheckAvailability + public static boolean isPresent() { + return Files.isDirectory(LOCATION); + } + + @Override + public Stream getLocations() { + return Stream.of(new LocationPreset("iCloud Drive", LOCATION)); + } +} diff --git a/src/main/java/org/cryptomator/common/locationpresets/ICloudWindowsLocationPresetsProvider.java b/src/main/java/org/cryptomator/common/locationpresets/ICloudWindowsLocationPresetsProvider.java new file mode 100644 index 000000000..2a786fad7 --- /dev/null +++ b/src/main/java/org/cryptomator/common/locationpresets/ICloudWindowsLocationPresetsProvider.java @@ -0,0 +1,26 @@ +package org.cryptomator.common.locationpresets; + +import org.cryptomator.integrations.common.CheckAvailability; +import org.cryptomator.integrations.common.OperatingSystem; + +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.stream.Stream; + +import static org.cryptomator.integrations.common.OperatingSystem.Value.WINDOWS; + +@OperatingSystem(WINDOWS) +public final class ICloudWindowsLocationPresetsProvider implements LocationPresetsProvider { + + private static final Path LOCATION = LocationPresetsProvider.resolveLocation("~/iCloudDrive"); + + @CheckAvailability + public static boolean isPresent() { + return Files.isDirectory(LOCATION); + } + + @Override + public Stream getLocations() { + return Stream.of(new LocationPreset("iCloud Drive", LOCATION)); + } +} diff --git a/src/main/java/org/cryptomator/common/locationpresets/LocationPreset.java b/src/main/java/org/cryptomator/common/locationpresets/LocationPreset.java new file mode 100644 index 000000000..5ba49eb9b --- /dev/null +++ b/src/main/java/org/cryptomator/common/locationpresets/LocationPreset.java @@ -0,0 +1,9 @@ +package org.cryptomator.common.locationpresets; + +import java.nio.file.Path; + +public record LocationPreset(String name, Path path) { + + + +} diff --git a/src/main/java/org/cryptomator/common/locationpresets/LocationPresetsProvider.java b/src/main/java/org/cryptomator/common/locationpresets/LocationPresetsProvider.java new file mode 100644 index 000000000..c48a45655 --- /dev/null +++ b/src/main/java/org/cryptomator/common/locationpresets/LocationPresetsProvider.java @@ -0,0 +1,20 @@ +package org.cryptomator.common.locationpresets; + +import java.nio.file.Path; +import java.util.stream.Stream; + +public interface LocationPresetsProvider { + + String USER_HOME = System.getProperty("user.home"); + + Stream getLocations(); + + static Path resolveLocation(String p) { + if (p.startsWith("~/")) { + return Path.of(USER_HOME, p.substring(2)); + } else { + return Path.of(p); + } + } + +} diff --git a/src/main/java/org/cryptomator/common/locationpresets/MegaLocationPresetsProvider.java b/src/main/java/org/cryptomator/common/locationpresets/MegaLocationPresetsProvider.java new file mode 100644 index 000000000..bba1f42da --- /dev/null +++ b/src/main/java/org/cryptomator/common/locationpresets/MegaLocationPresetsProvider.java @@ -0,0 +1,28 @@ +package org.cryptomator.common.locationpresets; + +import org.cryptomator.integrations.common.CheckAvailability; +import org.cryptomator.integrations.common.OperatingSystem; + +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.stream.Stream; + +import static org.cryptomator.integrations.common.OperatingSystem.Value.MAC; +import static org.cryptomator.integrations.common.OperatingSystem.Value.WINDOWS; + +@OperatingSystem(WINDOWS) +@OperatingSystem(MAC) +public final class MegaLocationPresetsProvider implements LocationPresetsProvider { + + private static final Path LOCATION = LocationPresetsProvider.resolveLocation("~/MEGA"); + + @CheckAvailability + public static boolean isPresent() { + return Files.isDirectory(LOCATION); + } + + @Override + public Stream getLocations() { + return Stream.of(new LocationPreset("MEGA", LOCATION)); + } +} diff --git a/src/main/java/org/cryptomator/common/locationpresets/OneDriveMacLocationPresetsProvider.java b/src/main/java/org/cryptomator/common/locationpresets/OneDriveMacLocationPresetsProvider.java new file mode 100644 index 000000000..e6f73a39e --- /dev/null +++ b/src/main/java/org/cryptomator/common/locationpresets/OneDriveMacLocationPresetsProvider.java @@ -0,0 +1,27 @@ +package org.cryptomator.common.locationpresets; + +import org.cryptomator.integrations.common.CheckAvailability; +import org.cryptomator.integrations.common.OperatingSystem; + +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.stream.Stream; + +import static org.cryptomator.integrations.common.OperatingSystem.Value.MAC; + +@OperatingSystem(MAC) +public final class OneDriveMacLocationPresetsProvider implements LocationPresetsProvider { + + + private static final Path LOCATION = LocationPresetsProvider.resolveLocation("~/OneDrive"); + + @CheckAvailability + public static boolean isPresent() { + return Files.isDirectory(LOCATION); + } + + @Override + public Stream getLocations() { + return Stream.of(new LocationPreset("OneDrive", LOCATION)); + } +} diff --git a/src/main/java/org/cryptomator/common/locationpresets/OneDriveWindowsLocationPresetsProvider.java b/src/main/java/org/cryptomator/common/locationpresets/OneDriveWindowsLocationPresetsProvider.java new file mode 100644 index 000000000..07e253fb0 --- /dev/null +++ b/src/main/java/org/cryptomator/common/locationpresets/OneDriveWindowsLocationPresetsProvider.java @@ -0,0 +1,107 @@ +package org.cryptomator.common.locationpresets; + +import org.cryptomator.integrations.common.OperatingSystem; +import org.jetbrains.annotations.Blocking; + +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.List; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.TimeoutException; +import java.util.function.Predicate; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +import static org.cryptomator.integrations.common.OperatingSystem.Value.WINDOWS; + +@OperatingSystem(WINDOWS) +public final class OneDriveWindowsLocationPresetsProvider implements LocationPresetsProvider { + + private static final String REGSTR_TOKEN = "REG_SZ"; + private static final String REG_ONEDRIVE_ACCOUNTS = "HKEY_CURRENT_USER\\Software\\Microsoft\\OneDrive\\Accounts\\"; + + @Override + public Stream getLocations() { + try { + + var accounts = queryRegistry(REG_ONEDRIVE_ACCOUNTS, List.of(), l -> l.startsWith(REG_ONEDRIVE_ACCOUNTS)).toList(); + var cloudLocations = new ArrayList(); + for (var account : accounts) { + var path = queryRegistry(REG_ONEDRIVE_ACCOUNTS + account, List.of("/v", "UserFolder"), l -> l.contains("UserFolder")).map(result -> result.substring(result.indexOf(REGSTR_TOKEN) + REGSTR_TOKEN.length()).trim()) // + .map(Path::of) // + .findFirst().orElseThrow(); + var name = "OneDrive"; //we assume personal oneDrive account by default + if (!account.equals("Personal")) { + name = queryRegistry(REG_ONEDRIVE_ACCOUNTS + account, List.of("/v", "DisplayName"), l -> l.contains("DisplayName")).map(result -> result.substring(result.indexOf(REGSTR_TOKEN) + REGSTR_TOKEN.length()).trim()) // + .map("OneDrive - "::concat).findFirst().orElseThrow(); + } + cloudLocations.add(new LocationPreset(name, path)); + } + return cloudLocations.stream(); + } catch (RuntimeException e) { + return Stream.of(); + } + } + + private Stream queryRegistry(String keyname, List moreArgs, Predicate outputFilter) { + var args = new ArrayList(); + args.add("reg"); + args.add("query"); + args.add(keyname); + args.addAll(moreArgs); + try { + ProcessBuilder command = new ProcessBuilder(args); + Process p = command.start(); + waitForSuccess(p, 3, "`reg query`"); + return p.inputReader(StandardCharsets.UTF_8).lines().filter(outputFilter); + } catch (TimeoutException | IOException | CommandFailedException e) { + throw new RuntimeException("FAIL"); + } catch (InterruptedException e) { + Thread.currentThread().interrupt(); + throw new RuntimeException("FAIL"); + } + } + + + /** + * Waits {@code timeoutSeconds} seconds for {@code process} to finish with exit code {@code 0}. + * + * @param process The process to wait for + * @param timeoutSeconds How long to wait (in seconds) + * @param cmdDescription A short description of the process used to generate log and exception messages + * @throws TimeoutException Thrown when the process doesn't finish in time + * @throws InterruptedException Thrown when the thread is interrupted while waiting for the process to finish + * @throws CommandFailedException Thrown when the process exit code is non-zero + */ + @Blocking + static void waitForSuccess(Process process, int timeoutSeconds, String cmdDescription) throws TimeoutException, InterruptedException, CommandFailedException { + boolean exited = process.waitFor(timeoutSeconds, TimeUnit.SECONDS); + if (!exited) { + throw new TimeoutException(cmdDescription + " timed out after " + timeoutSeconds + "s"); + } + if (process.exitValue() != 0) { + @SuppressWarnings("resource") var stdout = process.inputReader(StandardCharsets.UTF_8).lines().collect(Collectors.joining("\n")); + @SuppressWarnings("resource") var stderr = process.errorReader(StandardCharsets.UTF_8).lines().collect(Collectors.joining("\n")); + throw new CommandFailedException(cmdDescription, process.exitValue(), stdout, stderr); + } + } + + static class CommandFailedException extends Exception { + + int exitCode; + String stdout; + String stderr; + + private CommandFailedException(String cmdDescription, int exitCode, String stdout, String stderr) { + super(cmdDescription + " returned with non-zero exit code " + exitCode); + this.exitCode = exitCode; + this.stdout = stdout; + this.stderr = stderr; + } + + } + + +} diff --git a/src/main/java/org/cryptomator/common/locationpresets/PCloudLocationPresetsProvider.java b/src/main/java/org/cryptomator/common/locationpresets/PCloudLocationPresetsProvider.java new file mode 100644 index 000000000..969385b5a --- /dev/null +++ b/src/main/java/org/cryptomator/common/locationpresets/PCloudLocationPresetsProvider.java @@ -0,0 +1,29 @@ +package org.cryptomator.common.locationpresets; + +import org.cryptomator.integrations.common.CheckAvailability; +import org.cryptomator.integrations.common.OperatingSystem; + +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.stream.Stream; + +import static org.cryptomator.integrations.common.OperatingSystem.Value.MAC; +import static org.cryptomator.integrations.common.OperatingSystem.Value.WINDOWS; + +@OperatingSystem(WINDOWS) +@OperatingSystem(MAC) +public final class PCloudLocationPresetsProvider implements LocationPresetsProvider { + + + private static final Path LOCATION = LocationPresetsProvider.resolveLocation("~/pCloudDrive"); + + @CheckAvailability + public static boolean isPresent() { + return Files.isDirectory(LOCATION); + } + + @Override + public Stream getLocations() { + return Stream.of(new LocationPreset("pCloud", LOCATION)); + } +} From e345e6415fde27d3c7f27256af333782ba65326f Mon Sep 17 00:00:00 2001 From: Armin Schrenk Date: Wed, 17 May 2023 14:17:28 +0200 Subject: [PATCH 06/29] use @CheckAvailability annotation correctly --- .../locationpresets/DropboxMacLocationPresetsProvider.java | 1 + .../locationpresets/DropboxWindowsLocationPresetsProvider.java | 1 + .../locationpresets/GoogleDriveMacLocationPresetsProvider.java | 3 ++- .../GoogleDriveWindowsLocationPresetsProvider.java | 3 ++- .../locationpresets/ICloudMacLocationPresetsProvider.java | 1 + .../locationpresets/ICloudWindowsLocationPresetsProvider.java | 1 + .../common/locationpresets/MegaLocationPresetsProvider.java | 1 + .../locationpresets/OneDriveMacLocationPresetsProvider.java | 1 + .../common/locationpresets/PCloudLocationPresetsProvider.java | 1 + 9 files changed, 11 insertions(+), 2 deletions(-) diff --git a/src/main/java/org/cryptomator/common/locationpresets/DropboxMacLocationPresetsProvider.java b/src/main/java/org/cryptomator/common/locationpresets/DropboxMacLocationPresetsProvider.java index 6da4ccbea..9a8bb683d 100644 --- a/src/main/java/org/cryptomator/common/locationpresets/DropboxMacLocationPresetsProvider.java +++ b/src/main/java/org/cryptomator/common/locationpresets/DropboxMacLocationPresetsProvider.java @@ -10,6 +10,7 @@ import java.util.stream.Stream; import static org.cryptomator.integrations.common.OperatingSystem.Value.MAC; @OperatingSystem(MAC) +@CheckAvailability public final class DropboxMacLocationPresetsProvider implements LocationPresetsProvider { private static final Path LOCATION = LocationPresetsProvider.resolveLocation("~/Library/CloudStorage/Dropbox"); diff --git a/src/main/java/org/cryptomator/common/locationpresets/DropboxWindowsLocationPresetsProvider.java b/src/main/java/org/cryptomator/common/locationpresets/DropboxWindowsLocationPresetsProvider.java index 132cf008e..4e0365275 100644 --- a/src/main/java/org/cryptomator/common/locationpresets/DropboxWindowsLocationPresetsProvider.java +++ b/src/main/java/org/cryptomator/common/locationpresets/DropboxWindowsLocationPresetsProvider.java @@ -10,6 +10,7 @@ import java.util.stream.Stream; import static org.cryptomator.integrations.common.OperatingSystem.Value.WINDOWS; @OperatingSystem(WINDOWS) +@CheckAvailability public final class DropboxWindowsLocationPresetsProvider implements LocationPresetsProvider { private static final Path LOCATION = LocationPresetsProvider.resolveLocation("~/Dropbox"); diff --git a/src/main/java/org/cryptomator/common/locationpresets/GoogleDriveMacLocationPresetsProvider.java b/src/main/java/org/cryptomator/common/locationpresets/GoogleDriveMacLocationPresetsProvider.java index 1e1b7763a..6c0bee8fc 100644 --- a/src/main/java/org/cryptomator/common/locationpresets/GoogleDriveMacLocationPresetsProvider.java +++ b/src/main/java/org/cryptomator/common/locationpresets/GoogleDriveMacLocationPresetsProvider.java @@ -10,9 +10,10 @@ import java.util.stream.Stream; import static org.cryptomator.integrations.common.OperatingSystem.Value.MAC; @OperatingSystem(MAC) +@CheckAvailability public final class GoogleDriveMacLocationPresetsProvider implements LocationPresetsProvider { - private static final Path LOCATION = LocationPresetsProvider.resolveLocation("~/Google Drive"); + private static final Path LOCATION = LocationPresetsProvider.resolveLocation("~/Google Drive/My Drive"); @CheckAvailability diff --git a/src/main/java/org/cryptomator/common/locationpresets/GoogleDriveWindowsLocationPresetsProvider.java b/src/main/java/org/cryptomator/common/locationpresets/GoogleDriveWindowsLocationPresetsProvider.java index b99e4383a..bc84bdee3 100644 --- a/src/main/java/org/cryptomator/common/locationpresets/GoogleDriveWindowsLocationPresetsProvider.java +++ b/src/main/java/org/cryptomator/common/locationpresets/GoogleDriveWindowsLocationPresetsProvider.java @@ -10,9 +10,10 @@ import java.util.stream.Stream; import static org.cryptomator.integrations.common.OperatingSystem.Value.WINDOWS; @OperatingSystem(WINDOWS) +@CheckAvailability public final class GoogleDriveWindowsLocationPresetsProvider implements LocationPresetsProvider { - private static final Path LOCATION = LocationPresetsProvider.resolveLocation("~/Google Drive/My Drive"); + private static final Path LOCATION = LocationPresetsProvider.resolveLocation("~/Google Drive"); @CheckAvailability diff --git a/src/main/java/org/cryptomator/common/locationpresets/ICloudMacLocationPresetsProvider.java b/src/main/java/org/cryptomator/common/locationpresets/ICloudMacLocationPresetsProvider.java index 2d94c1bde..9138610b5 100644 --- a/src/main/java/org/cryptomator/common/locationpresets/ICloudMacLocationPresetsProvider.java +++ b/src/main/java/org/cryptomator/common/locationpresets/ICloudMacLocationPresetsProvider.java @@ -10,6 +10,7 @@ import java.util.stream.Stream; import static org.cryptomator.integrations.common.OperatingSystem.Value.MAC; @OperatingSystem(MAC) +@CheckAvailability public final class ICloudMacLocationPresetsProvider implements LocationPresetsProvider { private static final Path LOCATION = LocationPresetsProvider.resolveLocation("~/Library/Mobile Documents/com~apple~CloudDocs"); diff --git a/src/main/java/org/cryptomator/common/locationpresets/ICloudWindowsLocationPresetsProvider.java b/src/main/java/org/cryptomator/common/locationpresets/ICloudWindowsLocationPresetsProvider.java index 2a786fad7..f19333066 100644 --- a/src/main/java/org/cryptomator/common/locationpresets/ICloudWindowsLocationPresetsProvider.java +++ b/src/main/java/org/cryptomator/common/locationpresets/ICloudWindowsLocationPresetsProvider.java @@ -10,6 +10,7 @@ import java.util.stream.Stream; import static org.cryptomator.integrations.common.OperatingSystem.Value.WINDOWS; @OperatingSystem(WINDOWS) +@CheckAvailability public final class ICloudWindowsLocationPresetsProvider implements LocationPresetsProvider { private static final Path LOCATION = LocationPresetsProvider.resolveLocation("~/iCloudDrive"); diff --git a/src/main/java/org/cryptomator/common/locationpresets/MegaLocationPresetsProvider.java b/src/main/java/org/cryptomator/common/locationpresets/MegaLocationPresetsProvider.java index bba1f42da..f11b3d2bb 100644 --- a/src/main/java/org/cryptomator/common/locationpresets/MegaLocationPresetsProvider.java +++ b/src/main/java/org/cryptomator/common/locationpresets/MegaLocationPresetsProvider.java @@ -12,6 +12,7 @@ import static org.cryptomator.integrations.common.OperatingSystem.Value.WINDOWS; @OperatingSystem(WINDOWS) @OperatingSystem(MAC) +@CheckAvailability public final class MegaLocationPresetsProvider implements LocationPresetsProvider { private static final Path LOCATION = LocationPresetsProvider.resolveLocation("~/MEGA"); diff --git a/src/main/java/org/cryptomator/common/locationpresets/OneDriveMacLocationPresetsProvider.java b/src/main/java/org/cryptomator/common/locationpresets/OneDriveMacLocationPresetsProvider.java index e6f73a39e..62ecae18d 100644 --- a/src/main/java/org/cryptomator/common/locationpresets/OneDriveMacLocationPresetsProvider.java +++ b/src/main/java/org/cryptomator/common/locationpresets/OneDriveMacLocationPresetsProvider.java @@ -10,6 +10,7 @@ import java.util.stream.Stream; import static org.cryptomator.integrations.common.OperatingSystem.Value.MAC; @OperatingSystem(MAC) +@CheckAvailability public final class OneDriveMacLocationPresetsProvider implements LocationPresetsProvider { diff --git a/src/main/java/org/cryptomator/common/locationpresets/PCloudLocationPresetsProvider.java b/src/main/java/org/cryptomator/common/locationpresets/PCloudLocationPresetsProvider.java index 969385b5a..05e2867ce 100644 --- a/src/main/java/org/cryptomator/common/locationpresets/PCloudLocationPresetsProvider.java +++ b/src/main/java/org/cryptomator/common/locationpresets/PCloudLocationPresetsProvider.java @@ -12,6 +12,7 @@ import static org.cryptomator.integrations.common.OperatingSystem.Value.WINDOWS; @OperatingSystem(WINDOWS) @OperatingSystem(MAC) +@CheckAvailability public final class PCloudLocationPresetsProvider implements LocationPresetsProvider { From a3492b9ea3e3d701c02e4d370ad54138c108cd8e Mon Sep 17 00:00:00 2001 From: Armin Schrenk Date: Wed, 17 May 2023 14:25:16 +0200 Subject: [PATCH 07/29] use correct registry keys for onedrive detection --- .../OneDriveWindowsLocationPresetsProvider.java | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/src/main/java/org/cryptomator/common/locationpresets/OneDriveWindowsLocationPresetsProvider.java b/src/main/java/org/cryptomator/common/locationpresets/OneDriveWindowsLocationPresetsProvider.java index 07e253fb0..ab14a483e 100644 --- a/src/main/java/org/cryptomator/common/locationpresets/OneDriveWindowsLocationPresetsProvider.java +++ b/src/main/java/org/cryptomator/common/locationpresets/OneDriveWindowsLocationPresetsProvider.java @@ -1,7 +1,11 @@ package org.cryptomator.common.locationpresets; import org.cryptomator.integrations.common.OperatingSystem; +import org.cryptomator.integrations.locationpresets.LocationPreset; +import org.cryptomator.integrations.locationpresets.LocationPresetsProvider; import org.jetbrains.annotations.Blocking; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import java.io.IOException; import java.nio.charset.StandardCharsets; @@ -19,22 +23,22 @@ import static org.cryptomator.integrations.common.OperatingSystem.Value.WINDOWS; @OperatingSystem(WINDOWS) public final class OneDriveWindowsLocationPresetsProvider implements LocationPresetsProvider { + private static final Logger LOG = LoggerFactory.getLogger(OneDriveWindowsLocationPresetsProvider.class); private static final String REGSTR_TOKEN = "REG_SZ"; private static final String REG_ONEDRIVE_ACCOUNTS = "HKEY_CURRENT_USER\\Software\\Microsoft\\OneDrive\\Accounts\\"; @Override public Stream getLocations() { try { - - var accounts = queryRegistry(REG_ONEDRIVE_ACCOUNTS, List.of(), l -> l.startsWith(REG_ONEDRIVE_ACCOUNTS)).toList(); + var accountRegKeys = queryRegistry(REG_ONEDRIVE_ACCOUNTS, List.of(), l -> l.startsWith(REG_ONEDRIVE_ACCOUNTS)).toList(); var cloudLocations = new ArrayList(); - for (var account : accounts) { - var path = queryRegistry(REG_ONEDRIVE_ACCOUNTS + account, List.of("/v", "UserFolder"), l -> l.contains("UserFolder")).map(result -> result.substring(result.indexOf(REGSTR_TOKEN) + REGSTR_TOKEN.length()).trim()) // + for (var accountRegKey : accountRegKeys) { + var path = queryRegistry(accountRegKey, List.of("/v", "UserFolder"), l -> l.contains("UserFolder")).map(result -> result.substring(result.indexOf(REGSTR_TOKEN) + REGSTR_TOKEN.length()).trim()) // .map(Path::of) // .findFirst().orElseThrow(); var name = "OneDrive"; //we assume personal oneDrive account by default - if (!account.equals("Personal")) { - name = queryRegistry(REG_ONEDRIVE_ACCOUNTS + account, List.of("/v", "DisplayName"), l -> l.contains("DisplayName")).map(result -> result.substring(result.indexOf(REGSTR_TOKEN) + REGSTR_TOKEN.length()).trim()) // + if (!accountRegKey.endsWith("Personal")) { + name = queryRegistry(accountRegKey, List.of("/v", "DisplayName"), l -> l.contains("DisplayName")).map(result -> result.substring(result.indexOf(REGSTR_TOKEN) + REGSTR_TOKEN.length()).trim()) // .map("OneDrive - "::concat).findFirst().orElseThrow(); } cloudLocations.add(new LocationPreset(name, path)); From 0989c735c02e9589a8cb0f3f06e451901f574c95 Mon Sep 17 00:00:00 2001 From: Armin Schrenk Date: Wed, 17 May 2023 14:25:46 +0200 Subject: [PATCH 08/29] improve error handling when querying registry --- ...neDriveWindowsLocationPresetsProvider.java | 24 +++++++++---------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/src/main/java/org/cryptomator/common/locationpresets/OneDriveWindowsLocationPresetsProvider.java b/src/main/java/org/cryptomator/common/locationpresets/OneDriveWindowsLocationPresetsProvider.java index ab14a483e..809803118 100644 --- a/src/main/java/org/cryptomator/common/locationpresets/OneDriveWindowsLocationPresetsProvider.java +++ b/src/main/java/org/cryptomator/common/locationpresets/OneDriveWindowsLocationPresetsProvider.java @@ -44,28 +44,26 @@ public final class OneDriveWindowsLocationPresetsProvider implements LocationPre cloudLocations.add(new LocationPreset(name, path)); } return cloudLocations.stream(); - } catch (RuntimeException e) { + } catch (IOException | CommandFailedException | TimeoutException e) { + LOG.error("Unable to determine OneDrive location", e); + return Stream.of(); + } catch (InterruptedException e) { + Thread.currentThread().interrupt(); + LOG.error("Determination of OneDrive location interrupted", e); return Stream.of(); } } - private Stream queryRegistry(String keyname, List moreArgs, Predicate outputFilter) { + private Stream queryRegistry(String keyname, List moreArgs, Predicate outputFilter) throws InterruptedException, CommandFailedException, TimeoutException, IOException { var args = new ArrayList(); args.add("reg"); args.add("query"); args.add(keyname); args.addAll(moreArgs); - try { - ProcessBuilder command = new ProcessBuilder(args); - Process p = command.start(); - waitForSuccess(p, 3, "`reg query`"); - return p.inputReader(StandardCharsets.UTF_8).lines().filter(outputFilter); - } catch (TimeoutException | IOException | CommandFailedException e) { - throw new RuntimeException("FAIL"); - } catch (InterruptedException e) { - Thread.currentThread().interrupt(); - throw new RuntimeException("FAIL"); - } + ProcessBuilder command = new ProcessBuilder(args); + Process p = command.start(); + waitForSuccess(p, 3, "`reg query`"); + return p.inputReader(StandardCharsets.UTF_8).lines().filter(outputFilter); } From 0af0a9e4400143ee944775ea8ed939d498ba2a5a Mon Sep 17 00:00:00 2001 From: Armin Schrenk Date: Wed, 17 May 2023 14:51:43 +0200 Subject: [PATCH 09/29] refactor location ui in addVault workflow to new locationPreset framework --- .../cryptomator/common/LocationPreset.java | 64 -------- .../LocationPresetsProvider.java | 73 +++++++++ .../CreateNewVaultLocationController.java | 58 ++++--- .../ObservedLocationPresets.java | 141 ------------------ .../resources/fxml/addvault_new_location.fxml | 15 +- 5 files changed, 104 insertions(+), 247 deletions(-) delete mode 100644 src/main/java/org/cryptomator/common/LocationPreset.java delete mode 100644 src/main/java/org/cryptomator/ui/addvaultwizard/ObservedLocationPresets.java diff --git a/src/main/java/org/cryptomator/common/LocationPreset.java b/src/main/java/org/cryptomator/common/LocationPreset.java deleted file mode 100644 index 7861c6266..000000000 --- a/src/main/java/org/cryptomator/common/LocationPreset.java +++ /dev/null @@ -1,64 +0,0 @@ -package org.cryptomator.common; - -import java.nio.file.Files; -import java.nio.file.Path; -import java.util.Arrays; -import java.util.List; - -/** - * Enum of common cloud providers and their default local storage location path. - */ -public enum LocationPreset { - - DROPBOX("Dropbox", "~/Library/CloudStorage/Dropbox", "~/Dropbox"), - ICLOUDDRIVE("iCloud Drive", "~/Library/Mobile Documents/com~apple~CloudDocs", "~/iCloudDrive"), - GDRIVE("Google Drive", "~/Google Drive/My Drive", "~/Google Drive"), - MEGA("MEGA", "~/MEGA"), - ONEDRIVE("OneDrive", "~/OneDrive"), - PCLOUD("pCloud", "~/pCloudDrive"), - - LOCAL("local"); - - private final String name; - private final List candidates; - - LocationPreset(String name, String... candidates) { - this.name = name; - this.candidates = Arrays.stream(candidates).map(UserHome::resolve).map(Path::of).toList(); - } - - /** - * Checks for this LocationPreset if any of the associated paths exist. - * - * @return the first existing path or null, if none exists. - */ - public Path existingPath() { - return candidates.stream().filter(Files::isDirectory).findFirst().orElse(null); - } - - public String getDisplayName() { - return name; - } - - @Override - public String toString() { - return getDisplayName(); - } - - //this contruct is needed, since static members are initialized after every enum member is initialized - //TODO: refactor this to normal class and use this also in different parts of the project - private static class UserHome { - - private static final String USER_HOME = System.getProperty("user.home"); - - private static String resolve(String path) { - if (path.startsWith("~/")) { - return UserHome.USER_HOME + path.substring(1); - } else { - return path; - } - } - } - -} - diff --git a/src/main/java/org/cryptomator/common/locationpresets/LocationPresetsProvider.java b/src/main/java/org/cryptomator/common/locationpresets/LocationPresetsProvider.java index c48a45655..cf527a749 100644 --- a/src/main/java/org/cryptomator/common/locationpresets/LocationPresetsProvider.java +++ b/src/main/java/org/cryptomator/common/locationpresets/LocationPresetsProvider.java @@ -1,10 +1,22 @@ package org.cryptomator.common.locationpresets; +import org.cryptomator.integrations.common.CheckAvailability; +import org.cryptomator.integrations.common.IntegrationsLoader; +import org.cryptomator.integrations.common.OperatingSystem; +import org.jetbrains.annotations.Nullable; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.lang.reflect.Method; +import java.lang.reflect.Modifier; import java.nio.file.Path; +import java.util.Arrays; +import java.util.ServiceLoader; import java.util.stream.Stream; public interface LocationPresetsProvider { + Logger LOG = LoggerFactory.getLogger(LocationPresetsProvider.class); String USER_HOME = System.getProperty("user.home"); Stream getLocations(); @@ -17,4 +29,65 @@ public interface LocationPresetsProvider { } } + //copied from org.cryptomator.integrations.common.IntegrationsLoader + //TODO: delete, once migrated to integrations-api + static Stream loadAll(Class clazz) { + return ServiceLoader.load(clazz) + .stream() + .filter(LocationPresetsProvider::isSupportedOperatingSystem) + .filter(LocationPresetsProvider::passesStaticAvailabilityCheck) + .map(ServiceLoader.Provider::get) + .peek(impl -> logServiceIsAvailable(clazz, impl.getClass())); + } + + + private static boolean isSupportedOperatingSystem(ServiceLoader.Provider provider) { + var annotations = provider.type().getAnnotationsByType(OperatingSystem.class); + return annotations.length == 0 || Arrays.stream(annotations).anyMatch(OperatingSystem.Value::isCurrent); + } + + private static boolean passesStaticAvailabilityCheck(ServiceLoader.Provider provider) { + return passesStaticAvailabilityCheck(provider.type()); + } + + static boolean passesStaticAvailabilityCheck(Class type) { + return passesAvailabilityCheck(type, null); + } + + private static void logServiceIsAvailable(Class apiType, Class implType) { + if (LOG.isDebugEnabled()) { + LOG.debug("{}: Implementation is available: {}", apiType.getSimpleName(), implType.getName()); + } + } + + private static boolean passesAvailabilityCheck(Class type, @Nullable T instance) { + if (!type.isAnnotationPresent(CheckAvailability.class)) { + return true; // if type is not annotated, skip tests + } + if (!type.getModule().isExported(type.getPackageName(), IntegrationsLoader.class.getModule())) { + LOG.error("Can't run @CheckAvailability tests for class {}. Make sure to export {} to {}!", type.getName(), type.getPackageName(), IntegrationsLoader.class.getPackageName()); + return false; + } + return Arrays.stream(type.getMethods()) + .filter(m -> isAvailabilityCheck(m, instance == null)) + .allMatch(m -> passesAvailabilityCheck(m, instance)); + } + + private static boolean passesAvailabilityCheck(Method m, @Nullable Object instance) { + assert Boolean.TYPE.equals(m.getReturnType()); + try { + return (boolean) m.invoke(instance); + } catch (ReflectiveOperationException e) { + LOG.warn("Failed to invoke @CheckAvailability test {}#{}", m.getDeclaringClass(), m.getName(), e); + return false; + } + } + + private static boolean isAvailabilityCheck(Method m, boolean isStatic) { + return m.isAnnotationPresent(CheckAvailability.class) + && Boolean.TYPE.equals(m.getReturnType()) + && m.getParameterCount() == 0 + && Modifier.isStatic(m.getModifiers()) == isStatic; + } + } diff --git a/src/main/java/org/cryptomator/ui/addvaultwizard/CreateNewVaultLocationController.java b/src/main/java/org/cryptomator/ui/addvaultwizard/CreateNewVaultLocationController.java index cadccc091..5a36552b0 100644 --- a/src/main/java/org/cryptomator/ui/addvaultwizard/CreateNewVaultLocationController.java +++ b/src/main/java/org/cryptomator/ui/addvaultwizard/CreateNewVaultLocationController.java @@ -1,6 +1,8 @@ package org.cryptomator.ui.addvaultwizard; import dagger.Lazy; +import org.cryptomator.common.locationpresets.LocationPresetsProvider; +import org.cryptomator.common.locationpresets.LocationPreset; import org.cryptomator.ui.common.FxController; import org.cryptomator.ui.common.FxmlFile; import org.cryptomator.ui.common.FxmlScene; @@ -26,6 +28,7 @@ import javafx.scene.control.Label; import javafx.scene.control.RadioButton; import javafx.scene.control.Toggle; import javafx.scene.control.ToggleGroup; +import javafx.scene.layout.VBox; import javafx.stage.DirectoryChooser; import javafx.stage.Stage; import java.io.File; @@ -34,6 +37,9 @@ import java.nio.file.Files; import java.nio.file.Path; import java.nio.file.Paths; import java.nio.file.StandardOpenOption; +import java.util.Comparator; +import java.util.List; +import java.util.Optional; import java.util.ResourceBundle; @AddVaultWizardScoped @@ -46,7 +52,7 @@ public class CreateNewVaultLocationController implements FxController { private final Stage window; private final Lazy chooseNameScene; private final Lazy choosePasswordScene; - private final ObservedLocationPresets locationPresets; + private final List locationPresetBtns; private final ObjectProperty vaultPath; private final StringProperty vaultName; private final ResourceBundle resourceBundle; @@ -58,24 +64,18 @@ public class CreateNewVaultLocationController implements FxController { private Path customVaultPath = DEFAULT_CUSTOM_VAULT_PATH; //FXML - public ToggleGroup predefinedLocationToggler; - public RadioButton iclouddriveRadioButton; - public RadioButton dropboxRadioButton; - public RadioButton gdriveRadioButton; - public RadioButton onedriveRadioButton; - public RadioButton megaRadioButton; - public RadioButton pcloudRadioButton; + public ToggleGroup locationPresetsToggler; + public VBox radioButtonVBox; public RadioButton customRadioButton; public Label vaultPathStatus; public FontAwesome5IconView goodLocation; public FontAwesome5IconView badLocation; @Inject - CreateNewVaultLocationController(@AddVaultWizardWindow Stage window, @FxmlScene(FxmlFile.ADDVAULT_NEW_NAME) Lazy chooseNameScene, @FxmlScene(FxmlFile.ADDVAULT_NEW_PASSWORD) Lazy choosePasswordScene, ObservedLocationPresets locationPresets, ObjectProperty vaultPath, @Named("vaultName") StringProperty vaultName, ResourceBundle resourceBundle) { + CreateNewVaultLocationController(@AddVaultWizardWindow Stage window, @FxmlScene(FxmlFile.ADDVAULT_NEW_NAME) Lazy chooseNameScene, @FxmlScene(FxmlFile.ADDVAULT_NEW_PASSWORD) Lazy choosePasswordScene, ObjectProperty vaultPath, @Named("vaultName") StringProperty vaultName, ResourceBundle resourceBundle) { this.window = window; this.chooseNameScene = chooseNameScene; this.choosePasswordScene = choosePasswordScene; - this.locationPresets = locationPresets; this.vaultPath = vaultPath; this.vaultName = vaultName; this.resourceBundle = resourceBundle; @@ -83,6 +83,14 @@ public class CreateNewVaultLocationController implements FxController { this.usePresetPath = new SimpleBooleanProperty(); this.statusText = new SimpleStringProperty(); this.statusGraphic = new SimpleObjectProperty<>(); + this.locationPresetBtns = LocationPresetsProvider.loadAll(LocationPresetsProvider.class) // + .flatMap(LocationPresetsProvider::getLocations) // + .sorted(Comparator.comparing(LocationPreset::name)) // + .map(preset -> { // + var btn = new RadioButton(preset.name()); + btn.setUserData(preset.path()); + return btn; + }).toList(); } private boolean validateVaultPathAndSetStatus() { @@ -127,26 +135,15 @@ public class CreateNewVaultLocationController implements FxController { @FXML public void initialize() { - predefinedLocationToggler.selectedToggleProperty().addListener(this::togglePredefinedLocation); - usePresetPath.bind(predefinedLocationToggler.selectedToggleProperty().isNotEqualTo(customRadioButton)); + radioButtonVBox.getChildren().addAll(1, locationPresetBtns); //first item is the list header + locationPresetsToggler.getToggles().addAll(locationPresetBtns); + locationPresetsToggler.selectedToggleProperty().addListener(this::togglePredefinedLocation); + usePresetPath.bind(locationPresetsToggler.selectedToggleProperty().isNotEqualTo(customRadioButton)); } private void togglePredefinedLocation(@SuppressWarnings("unused") ObservableValue observable, @SuppressWarnings("unused") Toggle oldValue, Toggle newValue) { - if (iclouddriveRadioButton.equals(newValue)) { - vaultPath.set(locationPresets.getIclouddriveLocation().resolve(vaultName.get())); - } else if (dropboxRadioButton.equals(newValue)) { - vaultPath.set(locationPresets.getDropboxLocation().resolve(vaultName.get())); - } else if (gdriveRadioButton.equals(newValue)) { - vaultPath.set(locationPresets.getGdriveLocation().resolve(vaultName.get())); - } else if (onedriveRadioButton.equals(newValue)) { - vaultPath.set(locationPresets.getOnedriveLocation().resolve(vaultName.get())); - } else if (megaRadioButton.equals(newValue)) { - vaultPath.set(locationPresets.getMegaLocation().resolve(vaultName.get())); - } else if (pcloudRadioButton.equals(newValue)) { - vaultPath.set(locationPresets.getPcloudLocation().resolve(vaultName.get())); - } else if (customRadioButton.equals(newValue)) { - vaultPath.set(customVaultPath.resolve(vaultName.get())); - } + var storagePath = Optional.ofNullable((Path) newValue.getUserData()).orElse(customVaultPath); + vaultPath.set(storagePath.resolve(vaultName.get())); } @FXML @@ -197,10 +194,6 @@ public class CreateNewVaultLocationController implements FxController { return validVaultPath.get(); } - public ObservedLocationPresets getObservedLocationPresets() { - return locationPresets; - } - public BooleanProperty usePresetPathProperty() { return usePresetPath; } @@ -210,7 +203,7 @@ public class CreateNewVaultLocationController implements FxController { } public BooleanBinding anyRadioButtonSelectedProperty() { - return predefinedLocationToggler.selectedToggleProperty().isNotNull(); + return locationPresetsToggler.selectedToggleProperty().isNotNull(); } public boolean isAnyRadioButtonSelected() { @@ -232,4 +225,5 @@ public class CreateNewVaultLocationController implements FxController { public Node getStatusGraphic() { return statusGraphic.get(); } + } diff --git a/src/main/java/org/cryptomator/ui/addvaultwizard/ObservedLocationPresets.java b/src/main/java/org/cryptomator/ui/addvaultwizard/ObservedLocationPresets.java deleted file mode 100644 index 1c988dc04..000000000 --- a/src/main/java/org/cryptomator/ui/addvaultwizard/ObservedLocationPresets.java +++ /dev/null @@ -1,141 +0,0 @@ -package org.cryptomator.ui.addvaultwizard; - -import org.cryptomator.common.LocationPreset; - -import javax.inject.Inject; -import javafx.beans.binding.BooleanBinding; -import javafx.beans.property.ReadOnlyObjectProperty; -import javafx.beans.property.SimpleObjectProperty; -import java.nio.file.Path; - -@AddVaultWizardScoped -public class ObservedLocationPresets { - - private final ReadOnlyObjectProperty iclouddriveLocation; - private final ReadOnlyObjectProperty dropboxLocation; - private final ReadOnlyObjectProperty gdriveLocation; - private final ReadOnlyObjectProperty onedriveLocation; - private final ReadOnlyObjectProperty megaLocation; - private final ReadOnlyObjectProperty pcloudLocation; - private final BooleanBinding foundIclouddrive; - private final BooleanBinding foundDropbox; - private final BooleanBinding foundGdrive; - private final BooleanBinding foundOnedrive; - private final BooleanBinding foundMega; - private final BooleanBinding foundPcloud; - - @Inject - public ObservedLocationPresets() { - this.iclouddriveLocation = new SimpleObjectProperty<>(LocationPreset.ICLOUDDRIVE.existingPath()); - this.dropboxLocation = new SimpleObjectProperty<>(LocationPreset.DROPBOX.existingPath()); - this.gdriveLocation = new SimpleObjectProperty<>(LocationPreset.GDRIVE.existingPath()); - this.onedriveLocation = new SimpleObjectProperty<>(LocationPreset.ONEDRIVE.existingPath()); - this.megaLocation = new SimpleObjectProperty<>(LocationPreset.MEGA.existingPath()); - this.pcloudLocation = new SimpleObjectProperty<>(LocationPreset.PCLOUD.existingPath()); - this.foundIclouddrive = iclouddriveLocation.isNotNull(); - this.foundDropbox = dropboxLocation.isNotNull(); - this.foundGdrive = gdriveLocation.isNotNull(); - this.foundOnedrive = onedriveLocation.isNotNull(); - this.foundMega = megaLocation.isNotNull(); - this.foundPcloud = pcloudLocation.isNotNull(); - } - - /* Observables */ - - public ReadOnlyObjectProperty iclouddriveLocationProperty() { - return iclouddriveLocation; - } - - public Path getIclouddriveLocation() { - return iclouddriveLocation.get(); - } - - public BooleanBinding foundIclouddriveProperty() { - return foundIclouddrive; - } - - public boolean isFoundIclouddrive() { - return foundIclouddrive.get(); - } - - public ReadOnlyObjectProperty dropboxLocationProperty() { - return dropboxLocation; - } - - public Path getDropboxLocation() { - return dropboxLocation.get(); - } - - public BooleanBinding foundDropboxProperty() { - return foundDropbox; - } - - public boolean isFoundDropbox() { - return foundDropbox.get(); - } - - public ReadOnlyObjectProperty gdriveLocationProperty() { - return gdriveLocation; - } - - public Path getGdriveLocation() { - return gdriveLocation.get(); - } - - public BooleanBinding foundGdriveProperty() { - return foundGdrive; - } - - public boolean isFoundGdrive() { - return foundGdrive.get(); - } - - public ReadOnlyObjectProperty onedriveLocationProperty() { - return onedriveLocation; - } - - public Path getOnedriveLocation() { - return onedriveLocation.get(); - } - - public BooleanBinding foundOnedriveProperty() { - return foundOnedrive; - } - - public boolean isFoundOnedrive() { - return foundOnedrive.get(); - } - - public ReadOnlyObjectProperty megaLocationProperty() { - return megaLocation; - } - - public Path getMegaLocation() { - return megaLocation.get(); - } - - public BooleanBinding foundMegaProperty() { - return foundMega; - } - - public boolean isFoundMega() { - return foundMega.get(); - } - - public ReadOnlyObjectProperty pcloudLocationProperty() { - return pcloudLocation; - } - - public Path getPcloudLocation() { - return pcloudLocation.get(); - } - - public BooleanBinding foundPcloudProperty() { - return foundPcloud; - } - - public boolean isFoundPcloud() { - return foundPcloud.get(); - } - -} diff --git a/src/main/resources/fxml/addvault_new_location.fxml b/src/main/resources/fxml/addvault_new_location.fxml index 343a2d580..7920b6aac 100644 --- a/src/main/resources/fxml/addvault_new_location.fxml +++ b/src/main/resources/fxml/addvault_new_location.fxml @@ -19,7 +19,7 @@ spacing="12" alignment="CENTER_LEFT"> - + @@ -29,16 +29,11 @@ - +