Merge pull request #3474 from cryptomator/feature/notificationbar

Feature: Introduce NotificationBars for Update is available, Support Cryptomator, and DEBUG MODE
2024-11-23 03:59:51 +00:00 · 2024-10-02 11:05:58 +02:00 · 2024-10-02 11:05:58 +02:00 · 4bc9b1d60c
commit 4bc9b1d60c
parent ad555ece8e 7a40a3cb0c
7 changed files with 285 additions and 24 deletions
--- a/.idea/compiler.xml
+++ b/.idea/compiler.xml
@ -14,22 +14,45 @@
        <option name="dagger.fastInit" value="enabled" />
        <option name="dagger.formatGeneratedSource" value="enabled" />
        <processorPath useClasspath="false">
-          <entry name="$MAVEN_REPOSITORY$/com/google/dagger/dagger-compiler/2.49/dagger-compiler-2.49.jar" />
-          <entry name="$MAVEN_REPOSITORY$/com/google/dagger/dagger/2.49/dagger-2.49.jar" />
+          <entry name="$MAVEN_REPOSITORY$/com/google/dagger/dagger-compiler/2.51.1/dagger-compiler-2.51.1.jar" />
+          <entry name="$MAVEN_REPOSITORY$/com/google/dagger/dagger/2.51.1/dagger-2.51.1.jar" />
          <entry name="$MAVEN_REPOSITORY$/javax/inject/javax.inject/1/javax.inject-1.jar" />
-          <entry name="$MAVEN_REPOSITORY$/com/google/dagger/dagger-spi/2.49/dagger-spi-2.49.jar" />
+          <entry name="$MAVEN_REPOSITORY$/com/google/dagger/dagger-spi/2.51.1/dagger-spi-2.51.1.jar" />
          <entry name="$MAVEN_REPOSITORY$/com/google/code/findbugs/jsr305/3.0.2/jsr305-3.0.2.jar" />
          <entry name="$MAVEN_REPOSITORY$/com/google/devtools/ksp/symbol-processing-api/1.9.20-1.0.14/symbol-processing-api-1.9.20-1.0.14.jar" />
          <entry name="$MAVEN_REPOSITORY$/org/jetbrains/kotlin/kotlin-stdlib-jdk8/1.9.0/kotlin-stdlib-jdk8-1.9.0.jar" />
          <entry name="$MAVEN_REPOSITORY$/org/jetbrains/kotlin/kotlin-stdlib/1.9.20/kotlin-stdlib-1.9.20.jar" />
          <entry name="$MAVEN_REPOSITORY$/org/jetbrains/annotations/13.0/annotations-13.0.jar" />
          <entry name="$MAVEN_REPOSITORY$/org/jetbrains/kotlin/kotlin-stdlib-jdk7/1.9.0/kotlin-stdlib-jdk7-1.9.0.jar" />
-          <entry name="$MAVEN_REPOSITORY$/com/google/guava/failureaccess/1.0.1/failureaccess-1.0.1.jar" />
-          <entry name="$MAVEN_REPOSITORY$/com/google/guava/guava/31.0.1-jre/guava-31.0.1-jre.jar" />
+          <entry name="$MAVEN_REPOSITORY$/com/google/guava/failureaccess/1.0.2/failureaccess-1.0.2.jar" />
+          <entry name="$MAVEN_REPOSITORY$/com/google/guava/guava/33.0.0-jre/guava-33.0.0-jre.jar" />
          <entry name="$MAVEN_REPOSITORY$/com/google/guava/listenablefuture/9999.0-empty-to-avoid-conflict-with-guava/listenablefuture-9999.0-empty-to-avoid-conflict-with-guava.jar" />
-          <entry name="$MAVEN_REPOSITORY$/org/checkerframework/checker-qual/3.12.0/checker-qual-3.12.0.jar" />
-          <entry name="$MAVEN_REPOSITORY$/com/google/errorprone/error_prone_annotations/2.7.1/error_prone_annotations-2.7.1.jar" />
-          <entry name="$MAVEN_REPOSITORY$/com/google/j2objc/j2objc-annotations/1.3/j2objc-annotations-1.3.jar" />
+          <entry name="$MAVEN_REPOSITORY$/org/checkerframework/checker-qual/3.41.0/checker-qual-3.41.0.jar" />
+          <entry name="$MAVEN_REPOSITORY$/com/google/errorprone/error_prone_annotations/2.23.0/error_prone_annotations-2.23.0.jar" />
+          <entry name="$MAVEN_REPOSITORY$/com/google/j2objc/j2objc-annotations/2.8/j2objc-annotations-2.8.jar" />
+          <entry name="$MAVEN_REPOSITORY$/com/squareup/javapoet/1.13.0/javapoet-1.13.0.jar" />
+          <entry name="$MAVEN_REPOSITORY$/com/google/googlejavaformat/google-java-format/1.5/google-java-format-1.5.jar" />
+          <entry name="$MAVEN_REPOSITORY$/com/google/errorprone/javac-shaded/9-dev-r4023-3/javac-shaded-9-dev-r4023-3.jar" />
+          <entry name="$MAVEN_REPOSITORY$/com/squareup/kotlinpoet/1.11.0/kotlinpoet-1.11.0.jar" />
+          <entry name="$MAVEN_REPOSITORY$/org/jetbrains/kotlin/kotlin-reflect/1.6.10/kotlin-reflect-1.6.10.jar" />
+          <entry name="$MAVEN_REPOSITORY$/net/ltgt/gradle/incap/incap/0.2/incap-0.2.jar" />
+          <entry name="$MAVEN_REPOSITORY$/org/checkerframework/checker-compat-qual/2.5.5/checker-compat-qual-2.5.5.jar" />
+          <entry name="$MAVEN_REPOSITORY$/com/google/dagger/dagger-compiler/2.51.1/dagger-compiler-2.51.1.jar" />
+          <entry name="$MAVEN_REPOSITORY$/com/google/dagger/dagger/2.51.1/dagger-2.51.1.jar" />
+          <entry name="$MAVEN_REPOSITORY$/javax/inject/javax.inject/1/javax.inject-1.jar" />
+          <entry name="$MAVEN_REPOSITORY$/com/google/dagger/dagger-spi/2.51.1/dagger-spi-2.51.1.jar" />
+          <entry name="$MAVEN_REPOSITORY$/com/google/code/findbugs/jsr305/3.0.2/jsr305-3.0.2.jar" />
+          <entry name="$MAVEN_REPOSITORY$/com/google/devtools/ksp/symbol-processing-api/1.9.20-1.0.14/symbol-processing-api-1.9.20-1.0.14.jar" />
+          <entry name="$MAVEN_REPOSITORY$/org/jetbrains/kotlin/kotlin-stdlib-jdk8/1.9.0/kotlin-stdlib-jdk8-1.9.0.jar" />
+          <entry name="$MAVEN_REPOSITORY$/org/jetbrains/kotlin/kotlin-stdlib/1.9.20/kotlin-stdlib-1.9.20.jar" />
+          <entry name="$MAVEN_REPOSITORY$/org/jetbrains/annotations/13.0/annotations-13.0.jar" />
+          <entry name="$MAVEN_REPOSITORY$/org/jetbrains/kotlin/kotlin-stdlib-jdk7/1.9.0/kotlin-stdlib-jdk7-1.9.0.jar" />
+          <entry name="$MAVEN_REPOSITORY$/com/google/guava/failureaccess/1.0.2/failureaccess-1.0.2.jar" />
+          <entry name="$MAVEN_REPOSITORY$/com/google/guava/guava/33.0.0-jre/guava-33.0.0-jre.jar" />
+          <entry name="$MAVEN_REPOSITORY$/com/google/guava/listenablefuture/9999.0-empty-to-avoid-conflict-with-guava/listenablefuture-9999.0-empty-to-avoid-conflict-with-guava.jar" />
+          <entry name="$MAVEN_REPOSITORY$/org/checkerframework/checker-qual/3.41.0/checker-qual-3.41.0.jar" />
+          <entry name="$MAVEN_REPOSITORY$/com/google/errorprone/error_prone_annotations/2.23.0/error_prone_annotations-2.23.0.jar" />
+          <entry name="$MAVEN_REPOSITORY$/com/google/j2objc/j2objc-annotations/2.8/j2objc-annotations-2.8.jar" />
          <entry name="$MAVEN_REPOSITORY$/com/squareup/javapoet/1.13.0/javapoet-1.13.0.jar" />
          <entry name="$MAVEN_REPOSITORY$/com/google/googlejavaformat/google-java-format/1.5/google-java-format-1.5.jar" />
          <entry name="$MAVEN_REPOSITORY$/com/google/errorprone/javac-shaded/9-dev-r4023-3/javac-shaded-9-dev-r4023-3.jar" />
--- a/src/main/java/org/cryptomator/ui/controls/NotificationBar.java
+++ b/src/main/java/org/cryptomator/ui/controls/NotificationBar.java
@ -0,0 +1,102 @@
+package org.cryptomator.ui.controls;
+
+import javafx.beans.property.BooleanProperty;
+import javafx.beans.property.SimpleBooleanProperty;
+import javafx.fxml.FXML;
+import javafx.geometry.Pos;
+import javafx.scene.control.Button;
+import javafx.scene.control.Label;
+import javafx.scene.layout.HBox;
+import javafx.scene.layout.Region;
+import javafx.scene.layout.VBox;
+
+public class NotificationBar extends HBox {
+
+	@FXML
+	private Label notificationLabel;
+
+	private final BooleanProperty dismissable = new SimpleBooleanProperty();
+	private final BooleanProperty notify = new SimpleBooleanProperty();
+
+
+	public NotificationBar() {
+		setAlignment(Pos.CENTER);
+		setStyle("-fx-alignment: center;");
+
+		Region spacer = new Region();
+		spacer.setMinWidth(40);
+
+		Region leftRegion = new Region();
+		HBox.setHgrow(leftRegion, javafx.scene.layout.Priority.ALWAYS);
+
+		Region rightRegion = new Region();
+		HBox.setHgrow(rightRegion, javafx.scene.layout.Priority.ALWAYS);
+
+		VBox vbox = new VBox();
+		vbox.setAlignment(Pos.CENTER);
+		HBox.setHgrow(vbox, javafx.scene.layout.Priority.ALWAYS);
+
+		notificationLabel = new Label();
+		notificationLabel.getStyleClass().add("notification-label");
+		notificationLabel.setStyle("-fx-alignment: center;");
+		vbox.getChildren().add(notificationLabel);
+
+		Button closeButton = new Button("X");
+		closeButton.setMinWidth(40);
+		closeButton.setStyle("-fx-background-color: transparent; -fx-text-fill: white; -fx-font-weight: bold;");
+		closeButton.visibleProperty().bind(dismissable);
+
+		closeButton.setOnAction(_ -> {
+			visibleProperty().unbind();
+			managedProperty().unbind();
+			visibleProperty().set(false);
+			managedProperty().set(false);
+		});
+		closeButton.visibleProperty().bind(dismissable);
+
+		closeButton.setOnAction(_ -> {
+			visibleProperty().unbind();
+			managedProperty().unbind();
+			visibleProperty().set(false);
+			managedProperty().set(false);
+		});
+
+		getChildren().addAll(spacer, leftRegion, vbox, rightRegion, closeButton);
+
+		visibleProperty().bind(notifyProperty());
+		managedProperty().bind(notifyProperty());
+	}
+
+	public String getText() {
+		return notificationLabel.getText();
+	}
+
+	public void setText(String text) {
+		notificationLabel.setText(text);
+	}
+
+	public void setStyleClass(String styleClass) {
+		getStyleClass().add(styleClass);
+	}
+
+	public boolean isDismissable() {
+		return dismissable.get();
+	}
+
+	public void setDismissable(boolean value) {
+		dismissable.set(value);
+	}
+
+	public boolean getNotify() {
+		return notify.get();
+	}
+
+	public void setNotify(boolean value) {
+		notify.set(value);
+	}
+
+	public BooleanProperty notifyProperty() {
+		return notify;
+	}
+
+}
--- a/src/main/java/org/cryptomator/ui/mainwindow/MainWindowController.java
+++ b/src/main/java/org/cryptomator/ui/mainwindow/MainWindowController.java
@ -1,20 +1,26 @@
 package org.cryptomator.ui.mainwindow;

-import org.apache.commons.lang3.SystemUtils;
-import org.cryptomator.common.settings.Settings;
-import org.cryptomator.common.vaults.Vault;
-import org.cryptomator.common.vaults.VaultListManager;
-import org.cryptomator.ui.common.FxController;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-import javax.inject.Inject;
 import javafx.beans.Observable;
+import javafx.beans.binding.BooleanBinding;
 import javafx.beans.property.ObjectProperty;
+import javafx.beans.property.ReadOnlyBooleanProperty;
 import javafx.beans.property.ReadOnlyObjectProperty;
 import javafx.fxml.FXML;
 import javafx.scene.layout.StackPane;
 import javafx.stage.Stage;
+import org.apache.commons.lang3.SystemUtils;
+import org.cryptomator.common.LicenseHolder;
+import org.cryptomator.common.settings.Settings;
+import org.cryptomator.common.vaults.Vault;
+import org.cryptomator.common.vaults.VaultListManager;
+import org.cryptomator.ui.common.FxController;
+import org.cryptomator.ui.fxapp.FxApplicationWindows;
+import org.cryptomator.ui.fxapp.UpdateChecker;
+import org.cryptomator.ui.preferences.SelectedPreferencesTab;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import javax.inject.Inject;

@MainWindowScoped
 public class MainWindowController implements FxController {
@ -24,19 +30,34 @@ public class MainWindowController implements FxController {
 	private final Stage window;
 	private final ReadOnlyObjectProperty<Vault> selectedVault;
 	private final Settings settings;
+	private final FxApplicationWindows appWindows;
+	private final BooleanBinding updateAvailable;
+	private final LicenseHolder licenseHolder;

-	public StackPane root;
+	@FXML
+	private StackPane root;

 	@Inject
-	public MainWindowController(@MainWindow Stage window, ObjectProperty<Vault> selectedVault, Settings settings) {
+	public MainWindowController(@MainWindow Stage window, //
+								ObjectProperty<Vault> selectedVault, //
+								Settings settings, //
+								FxApplicationWindows appWindows, //
+								UpdateChecker updateChecker, //
+								LicenseHolder licenseHolder) {
 		this.window = window;
 		this.selectedVault = selectedVault;
 		this.settings = settings;
+		this.appWindows = appWindows;
+		this.updateAvailable = updateChecker.updateAvailableProperty();
+		this.licenseHolder = licenseHolder;
+		updateChecker.automaticallyCheckForUpdatesIfEnabled();
+
 	}

 	@FXML
 	public void initialize() {
 		LOG.trace("init MainWindowController");
+
 		if (SystemUtils.IS_OS_WINDOWS) {
 			root.getStyleClass().add("os-windows");
 		}
@ -48,17 +69,16 @@ public class MainWindowController implements FxController {
 			window.setX(settings.windowXPosition.get());
 			window.setY(settings.windowYPosition.get());
 		}
-		window.widthProperty().addListener((_,_,_) -> savePositionalSettings());
-		window.heightProperty().addListener((_,_,_) -> savePositionalSettings());
-		window.xProperty().addListener((_,_,_) -> savePositionalSettings());
-		window.yProperty().addListener((_,_,_) -> savePositionalSettings());
+		window.widthProperty().addListener((_, _, _) -> savePositionalSettings());
+		window.heightProperty().addListener((_, _, _) -> savePositionalSettings());
+		window.xProperty().addListener((_, _, _) -> savePositionalSettings());
+		window.yProperty().addListener((_, _, _) -> savePositionalSettings());
 	}

 	private boolean neverTouched() {
 		return (settings.windowHeight.get() == 0) && (settings.windowWidth.get() == 0) && (settings.windowXPosition.get() == 0) && (settings.windowYPosition.get() == 0);
 	}

-	@FXML
 	public void savePositionalSettings() {
 		settings.windowWidth.setValue(window.getWidth());
 		settings.windowHeight.setValue(window.getHeight());
@ -73,4 +93,43 @@ public class MainWindowController implements FxController {
 		}
 	}

+	@FXML
+	public void showGeneralPreferences() {
+		appWindows.showPreferencesWindow(SelectedPreferencesTab.GENERAL);
+	}
+
+	@FXML
+	public void showContributePreferences() {
+		appWindows.showPreferencesWindow(SelectedPreferencesTab.CONTRIBUTE);
+	}
+
+	@FXML
+	public void showUpdatePreferences() {
+		appWindows.showPreferencesWindow(SelectedPreferencesTab.UPDATES);
+	}
+
+	public ReadOnlyBooleanProperty debugModeEnabledProperty() {
+		return settings.debugMode;
+	}
+
+	public boolean getDebugModeEnabled() {
+		return debugModeEnabledProperty().get();
+	}
+
+	public BooleanBinding updateAvailableProperty() {
+		return updateAvailable;
+	}
+
+	public boolean getUpdateAvailable() {
+		return updateAvailable.get();
+	}
+
+	public BooleanBinding licenseValidProperty(){
+		return licenseHolder.validLicenseProperty();
+	}
+
+	public boolean getLicenseValid() {
+		return licenseHolder.isValidLicense();
+	}
+
 }
--- a/src/main/resources/css/dark_theme.css
+++ b/src/main/resources/css/dark_theme.css
@ -311,6 +311,35 @@
 	-fx-fill: transparent;
 }

+/*******************************************************************************
+ *                                                                             *
+ * NotificationBar                                                             *
+ *                                                                             *
+ ******************************************************************************/
+
+.notification-label {
+	-fx-text-fill: white;
+	-fx-font-weight: bold;
+}
+
+.notification-debug {
+	-fx-min-height:24px;
+	-fx-max-height:24px;
+	-fx-background-color: RED_5;
+}
+
+.notification-update {
+	-fx-min-height:24px;
+	-fx-max-height:24px;
+	-fx-background-color: YELLOW_5;
+}
+
+.notification-support {
+	-fx-min-height:24px;
+	-fx-max-height:24px;
+	-fx-background-color: PRIMARY;
+}
+
 /*******************************************************************************
 *                                                                             *
 * ScrollBar                                                                   *
--- a/src/main/resources/css/light_theme.css
+++ b/src/main/resources/css/light_theme.css
@ -311,6 +311,35 @@
 	-fx-fill: transparent;
 }

+/*******************************************************************************
+ *                                                                             *
+ * NotificationBar                                                             *
+ *                                                                             *
+ ******************************************************************************/
+
+.notification-label {
+	-fx-text-fill: white;
+	-fx-font-weight: bold;
+}
+
+.notification-debug {
+	-fx-min-height:24px;
+	-fx-max-height:24px;
+	-fx-background-color: RED_5;
+}
+
+.notification-update {
+	-fx-min-height:24px;
+	-fx-max-height:24px;
+	-fx-background-color: YELLOW_5;
+}
+
+.notification-support {
+	-fx-min-height:24px;
+	-fx-max-height:24px;
+	-fx-background-color: PRIMARY;
+}
+
 /*******************************************************************************
 *                                                                             *
 * ScrollBar                                                                   *
--- a/src/main/resources/fxml/main_window.fxml
+++ b/src/main/resources/fxml/main_window.fxml
@ -3,15 +3,31 @@
 <?import javafx.scene.control.SplitPane?>
 <?import javafx.scene.layout.StackPane?>
 <?import javafx.scene.layout.VBox?>
+<?import org.cryptomator.ui.controls.NotificationBar?>
+
 <StackPane xmlns:fx="http://javafx.com/fxml"
 		   xmlns="http://javafx.com/javafx"
 		   fx:id="root"
 		   fx:controller="org.cryptomator.ui.mainwindow.MainWindowController"
 		   styleClass="main-window">
 	<VBox minWidth="600">
+		<NotificationBar onMouseClicked="#showUpdatePreferences"
+						 text="%main.notification.updateAvailable"
+						 dismissable="true"
+						 notify="${controller.updateAvailable}"
+						 styleClass="notification-update"/>
+		<NotificationBar onMouseClicked="#showContributePreferences"
+						 text="%main.notification.support"
+						 dismissable="true"
+						 notify="${!controller.licenseValid}"
+						 styleClass="notification-support"/>
 		<SplitPane dividerPositions="0.33" orientation="HORIZONTAL" VBox.vgrow="ALWAYS">
 			<fx:include source="vault_list.fxml" SplitPane.resizableWithParent="false"/>
 			<fx:include source="vault_detail.fxml" SplitPane.resizableWithParent="true"/>
 		</SplitPane>
+		<NotificationBar onMouseClicked="#showGeneralPreferences"
+						 text="DEBUG MODE"
+						 styleClass="notification-debug"
+						 notify="${controller.debugModeEnabled}"/>
 	</VBox>
 </StackPane>
--- a/src/main/resources/i18n/strings.properties
+++ b/src/main/resources/i18n/strings.properties
@ -386,6 +386,9 @@ main.vaultlist.contextMenu.vaultoptions=Show Vault Options
 main.vaultlist.contextMenu.reveal=Reveal Drive
 main.vaultlist.addVaultBtn.menuItemNew=Create New Vault...
 main.vaultlist.addVaultBtn.menuItemExisting=Open Existing Vault...
+##Notificaition
+main.notification.updateAvailable=Update is available.
+main.notification.support=Support Cryptomator.
 ## Vault Detail
 ### Welcome
 main.vaultDetail.welcomeOnboarding=Thanks for choosing Cryptomator to protect your files. If you need any assistance, check out our getting started guides: