From e808db51a5b71f6ec29ffa9e8f1c437f05b4c370 Mon Sep 17 00:00:00 2001
From: Marc Stammerjohann <marcstammerjohann@web.de>
Date: Wed, 20 Dec 2017 15:50:31 +0100
Subject: [PATCH 1/3] #114: show success message

* after creating a vault
* after changing password
* after upgrade
---
 .../ui/controllers/MainController.java        | 14 +++----
 .../ui/controllers/UnlockController.java      | 42 ++++++++++++++++++-
 main/ui/src/main/resources/fxml/unlock.fxml   |  3 ++
 .../ui/src/main/resources/localization/de.txt |  4 ++
 .../ui/src/main/resources/localization/en.txt |  3 ++
 5 files changed, 58 insertions(+), 8 deletions(-)

diff --git a/main/ui/src/main/java/org/cryptomator/ui/controllers/MainController.java b/main/ui/src/main/java/org/cryptomator/ui/controllers/MainController.java
index 682cd0afb..202267215 100644
--- a/main/ui/src/main/java/org/cryptomator/ui/controllers/MainController.java
+++ b/main/ui/src/main/java/org/cryptomator/ui/controllers/MainController.java
@@ -396,7 +396,7 @@ public class MainController implements ViewController {
 		} else if (newValue.isValidVaultDirectory() && upgradeStrategyForSelectedVault.isPresent()) {
 			this.showUpgradeView();
 		} else if (newValue.isValidVaultDirectory()) {
-			this.showUnlockView();
+			this.showUnlockView(UnlockController.State.UNLOCKING);
 		} else {
 			this.showInitializeView();
 		}
@@ -446,7 +446,7 @@ public class MainController implements ViewController {
 	}
 
 	public void didInitialize() {
-		showUnlockView();
+		showUnlockView(UnlockController.State.INITIALIZED);
 		activeController.get().focus();
 	}
 
@@ -458,13 +458,13 @@ public class MainController implements ViewController {
 	}
 
 	public void didUpgrade() {
-		showUnlockView();
+		showUnlockView(UnlockController.State.UPGRADED);
 		activeController.get().focus();
 	}
 
-	private void showUnlockView() {
+	private void showUnlockView(UnlockController.State state) {
 		final UnlockController ctrl = viewControllerLoader.load("/fxml/unlock.fxml");
-		ctrl.setVault(selectedVault.get());
+		ctrl.setVault(selectedVault.get(), state);
 		ctrl.setListener(this::didUnlock);
 		activeController.set(ctrl);
 	}
@@ -486,7 +486,7 @@ public class MainController implements ViewController {
 
 	public void didLock(UnlockedController ctrl) {
 		unlockedVaults.remove(ctrl.getVault());
-		showUnlockView();
+		showUnlockView(UnlockController.State.UNLOCKING);
 		activeController.get().focus();
 	}
 
@@ -499,7 +499,7 @@ public class MainController implements ViewController {
 	}
 
 	public void didChangePassword() {
-		showUnlockView();
+		showUnlockView(UnlockController.State.PASSWORD_CHANGED);
 		activeController.get().focus();
 	}
 
diff --git a/main/ui/src/main/java/org/cryptomator/ui/controllers/UnlockController.java b/main/ui/src/main/java/org/cryptomator/ui/controllers/UnlockController.java
index 6d30a7e2f..9369632f7 100644
--- a/main/ui/src/main/java/org/cryptomator/ui/controllers/UnlockController.java
+++ b/main/ui/src/main/java/org/cryptomator/ui/controllers/UnlockController.java
@@ -94,6 +94,9 @@ public class UnlockController implements ViewController {
 	@FXML
 	private Button unlockButton;
 
+	@FXML
+	private Label successMessage;
+
 	@FXML
 	private CheckBox savePassword;
 
@@ -160,7 +163,7 @@ public class UnlockController implements ViewController {
 		passwordField.requestFocus();
 	}
 
-	void setVault(Vault vault) {
+	void setVault(Vault vault, State state) {
 		vaultSubs.unsubscribe();
 		vaultSubs = Subscription.EMPTY;
 
@@ -175,6 +178,10 @@ public class UnlockController implements ViewController {
 		advancedOptions.setVisible(false);
 		advancedOptionsButton.setText(localization.getString("unlock.button.advancedOptions.show"));
 		progressIndicator.setVisible(false);
+		successMessage.setVisible(didChange(state));
+		if (successMessage.isVisible()) {
+			successMessage.setText(localization.getString(state.successMessage()));
+		}
 		if (SystemUtils.IS_OS_WINDOWS) {
 			winDriveLetter.valueProperty().removeListener(driveLetterChangeListener);
 			winDriveLetter.getItems().clear();
@@ -225,6 +232,7 @@ public class UnlockController implements ViewController {
 
 	@FXML
 	private void didClickAdvancedOptionsButton(ActionEvent event) {
+		successMessage.setVisible(false);
 		advancedOptions.setVisible(!advancedOptions.isVisible());
 		if (advancedOptions.isVisible()) {
 			advancedOptionsButton.setText(localization.getString("unlock.button.advancedOptions.hide"));
@@ -389,6 +397,15 @@ public class UnlockController implements ViewController {
 		}).run();
 	}
 
+	private boolean didChange(State state) {
+		switch (state) {
+			case UNLOCKING:
+				return false;
+			default:
+				return true;
+		}
+	}
+
 	/* callback */
 
 	public void setListener(UnlockListener listener) {
@@ -400,4 +417,27 @@ public class UnlockController implements ViewController {
 		void didUnlock(Vault vault);
 	}
 
+	/* state */
+
+	public enum State {
+		UNLOCKING(empty()),
+		INITIALIZED("unlock.successLabel.vaultCreated"),
+		PASSWORD_CHANGED("unlock.successLabel.passwordChanged"),
+		UPGRADED("unlock.successLabel.upgraded");
+
+		private static String empty() {
+			return "";
+		}
+
+		private String successMessage;
+
+		State(String successMessage) {
+			this.successMessage = successMessage;
+		}
+
+		public String successMessage() {
+			return successMessage;
+		}
+	}
+
 }
diff --git a/main/ui/src/main/resources/fxml/unlock.fxml b/main/ui/src/main/resources/fxml/unlock.fxml
index 3d5872bf4..399aaf2fc 100644
--- a/main/ui/src/main/resources/fxml/unlock.fxml
+++ b/main/ui/src/main/resources/fxml/unlock.fxml
@@ -46,6 +46,9 @@
 			<Button fx:id="unlockButton" text="%unlock.button.unlock" defaultButton="true" prefWidth="150.0" onAction="#didClickUnlockButton" disable="true" cacheShape="true" cache="true" />
 		</HBox>
 		
+		<!-- Row 3 -->
+		<Label fx:id="successMessage" cacheShape="true" cache="true" visible="true" GridPane.rowIndex="3" GridPane.columnIndex="0" GridPane.columnSpan="2"/>
+
 		<!-- Row 3 -->
 		<GridPane fx:id="advancedOptions" vgap="12.0" hgap="12.0" prefWidth="400.0" GridPane.rowIndex="3" GridPane.columnIndex="0" GridPane.columnSpan="2" visible="false" cacheShape="true" cache="true">
 			<padding>
diff --git a/main/ui/src/main/resources/localization/de.txt b/main/ui/src/main/resources/localization/de.txt
index c402c51fa..8b2118836 100644
--- a/main/ui/src/main/resources/localization/de.txt
+++ b/main/ui/src/main/resources/localization/de.txt
@@ -34,6 +34,10 @@ unlock.errorMessage.wrongPassword = Falsches Passwort
 unlock.errorMessage.unsupportedVersion.vaultOlderThanSoftware = Tresor nicht unterstützt. Der Tresor wurde mit einer älteren Version von Cryptomator erstellt.
 unlock.errorMessage.unsupportedVersion.softwareOlderThanVault = Tresor nicht unterstützt. Der Tresor wurde mit einer neueren Version von Cryptomator erstellt.
 unlock.messageLabel.startServerFailed = Starten des WebDAV-Servers fehlgeschlagen.
+unlock.successLabel.vaultCreated = Der Tresor wurde erfolgreich erstellt.
+unlock.successLabel.passwordChanged = Das Passwort wurde erfolgreich geändert.
+unlock.successLabel.upgraded = Cryptomator wurde erfolgreich geupdated.
+
 # change_password.fxml
 changePassword.label.oldPassword = Altes Passwort
 changePassword.label.newPassword = Neues Passwort
diff --git a/main/ui/src/main/resources/localization/en.txt b/main/ui/src/main/resources/localization/en.txt
index fb27ddf01..ce39123e7 100644
--- a/main/ui/src/main/resources/localization/en.txt
+++ b/main/ui/src/main/resources/localization/en.txt
@@ -82,6 +82,9 @@ unlock.errorMessage.unsupportedVersion.vaultOlderThanSoftware=Unsupported vault.
 unlock.errorMessage.unsupportedVersion.softwareOlderThanVault=Unsupported vault. This vault has been created with a newer version of Cryptomator.
 unlock.errorMessage.unauthenticVersionMac=Could not authenticate version MAC.
 unlock.messageLabel.startServerFailed=Starting WebDAV server failed.
+unlock.successLabel.vaultCreated=Vault was successfully created.
+unlock.successLabel.passwordChanged=Password was successfully changed.
+unlock.successLabel.upgraded=Cryptomator was successfully upgraded.
 
 # change_password.fxml
 changePassword.label.oldPassword=Old Password

From da31a9d2a088d80cda53dd492de71901340993e8 Mon Sep 17 00:00:00 2001
From: infeo <schrenk.armin@hotmail.de>
Date: Thu, 22 Mar 2018 15:21:11 +0100
Subject: [PATCH 2/3] integrating changes proposed by comments in commit
 e808db51a5b71f6ec29ffa9e8f1c437f05b4c370

---
 .../ui/controllers/UnlockController.java      | 47 +++++++++----------
 1 file changed, 23 insertions(+), 24 deletions(-)

diff --git a/main/ui/src/main/java/org/cryptomator/ui/controllers/UnlockController.java b/main/ui/src/main/java/org/cryptomator/ui/controllers/UnlockController.java
index 9369632f7..874ed8599 100644
--- a/main/ui/src/main/java/org/cryptomator/ui/controllers/UnlockController.java
+++ b/main/ui/src/main/java/org/cryptomator/ui/controllers/UnlockController.java
@@ -2,7 +2,7 @@
  * Copyright (c) 2014, 2017 Sebastian Stenzel
  * All rights reserved.
  * This program and the accompanying materials are made available under the terms of the accompanying LICENSE file.
- * 
+ *
  * Contributors:
  *     Sebastian Stenzel - initial API and implementation
  ******************************************************************************/
@@ -178,9 +178,9 @@ public class UnlockController implements ViewController {
 		advancedOptions.setVisible(false);
 		advancedOptionsButton.setText(localization.getString("unlock.button.advancedOptions.show"));
 		progressIndicator.setVisible(false);
-		successMessage.setVisible(didChange(state));
-		if (successMessage.isVisible()) {
-			successMessage.setText(localization.getString(state.successMessage()));
+		successMessage.setVisible(state.shouldShowStatusMessage());
+		if (successMessage.isVisible() && state.successMessage().isPresent()) {
+			successMessage.setText(localization.getString(state.successMessage().get()));
 		}
 		if (SystemUtils.IS_OS_WINDOWS) {
 			winDriveLetter.valueProperty().removeListener(driveLetterChangeListener);
@@ -397,15 +397,6 @@ public class UnlockController implements ViewController {
 		}).run();
 	}
 
-	private boolean didChange(State state) {
-		switch (state) {
-			case UNLOCKING:
-				return false;
-			default:
-				return true;
-		}
-	}
-
 	/* callback */
 
 	public void setListener(UnlockListener listener) {
@@ -414,30 +405,38 @@ public class UnlockController implements ViewController {
 
 	@FunctionalInterface
 	interface UnlockListener {
+
 		void didUnlock(Vault vault);
 	}
 
 	/* state */
 
 	public enum State {
-		UNLOCKING(empty()),
-		INITIALIZED("unlock.successLabel.vaultCreated"),
-		PASSWORD_CHANGED("unlock.successLabel.passwordChanged"),
-		UPGRADED("unlock.successLabel.upgraded");
+		UNLOCKING(false),
+		INITIALIZED("unlock.successLabel.vaultCreated", true),
+		PASSWORD_CHANGED("unlock.successLabel.passwordChanged", true),
+		UPGRADED("unlock.successLabel.upgraded", true);
 
-		private static String empty() {
-			return "";
+		private Optional<String> successMessage;
+		private boolean shouldShowStatusMessage;
+
+		State(boolean shouldShowStatusMessage) {
+			this.successMessage = Optional.empty();
+			this.shouldShowStatusMessage = shouldShowStatusMessage;
 		}
 
-		private String successMessage;
-
-		State(String successMessage) {
-			this.successMessage = successMessage;
+		State(String successMessage, boolean shouldShowStatusMessage) {
+			this.successMessage = Optional.of(successMessage);
+			this.shouldShowStatusMessage = shouldShowStatusMessage;
 		}
 
-		public String successMessage() {
+		public Optional<String> successMessage() {
 			return successMessage;
 		}
+
+		public boolean shouldShowStatusMessage() {
+			return shouldShowStatusMessage;
+		}
 	}
 
 }

From 68445befeb17cee00c3b7d050edd0404ae3089d2 Mon Sep 17 00:00:00 2001
From: infeo <schrenk.armin@hotmail.de>
Date: Thu, 22 Mar 2018 17:47:43 +0100
Subject: [PATCH 3/3] simplifying the state enum to prevent illegal states

---
 .../ui/controllers/UnlockController.java         | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/main/ui/src/main/java/org/cryptomator/ui/controllers/UnlockController.java b/main/ui/src/main/java/org/cryptomator/ui/controllers/UnlockController.java
index 874ed8599..9d9afe5a5 100644
--- a/main/ui/src/main/java/org/cryptomator/ui/controllers/UnlockController.java
+++ b/main/ui/src/main/java/org/cryptomator/ui/controllers/UnlockController.java
@@ -412,22 +412,22 @@ public class UnlockController implements ViewController {
 	/* state */
 
 	public enum State {
-		UNLOCKING(false),
-		INITIALIZED("unlock.successLabel.vaultCreated", true),
-		PASSWORD_CHANGED("unlock.successLabel.passwordChanged", true),
-		UPGRADED("unlock.successLabel.upgraded", true);
+		UNLOCKING(),
+		INITIALIZED("unlock.successLabel.vaultCreated"),
+		PASSWORD_CHANGED("unlock.successLabel.passwordChanged"),
+		UPGRADED("unlock.successLabel.upgraded");
 
 		private Optional<String> successMessage;
 		private boolean shouldShowStatusMessage;
 
-		State(boolean shouldShowStatusMessage) {
+		State() {
 			this.successMessage = Optional.empty();
-			this.shouldShowStatusMessage = shouldShowStatusMessage;
+			this.shouldShowStatusMessage = false;
 		}
 
-		State(String successMessage, boolean shouldShowStatusMessage) {
+		State(String successMessage) {
 			this.successMessage = Optional.of(successMessage);
-			this.shouldShowStatusMessage = shouldShowStatusMessage;
+			this.shouldShowStatusMessage = true;
 		}
 
 		public Optional<String> successMessage() {