feat: support for forgot keyphrase instructions (#1047)

Author: yogeshpaliyal

app/src/main/java/com/yogeshpaliyal/keypass/ui/home/components/ForgotKeyPhraseDialog.kt

@@ -0,0 +1,50 @@
+package com.yogeshpaliyal.keypass.ui.home.components
+
+import androidx.compose.foundation.layout.Column
+import androidx.compose.foundation.layout.Spacer
+import androidx.compose.foundation.layout.fillMaxWidth
+import androidx.compose.foundation.layout.size
+import androidx.compose.material3.AlertDialog
+import androidx.compose.material3.Text
+import androidx.compose.material3.TextButton
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.res.stringResource
+import androidx.compose.ui.unit.dp
+import com.yogeshpaliyal.keypass.R
+import com.yogeshpaliyal.keypass.ui.redux.actions.Action
+import com.yogeshpaliyal.keypass.ui.redux.actions.UpdateDialogState
+import com.yogeshpaliyal.keypass.ui.redux.states.ValidateKeyPhrase
+import org.reduxkotlin.compose.rememberTypedDispatcher
+
+@Composable
+fun ForgotKeyPhraseDialog() {
+    val dispatchAction = rememberTypedDispatcher<Action>()
+
+    val hideDialog: () -> Unit = {
+        dispatchAction(UpdateDialogState(ValidateKeyPhrase))
+    }
+
+    AlertDialog(
+        onDismissRequest = {
+            hideDialog()
+        },
+        title = {
+            Text(text = stringResource(id = R.string.forgot_keyphrase))
+        },
+        confirmButton = {
+            TextButton(onClick = {
+                hideDialog()
+            }) {
+                Text(text = stringResource(id = R.string.got_it))
+            }
+        },
+        text = {
+            Column(modifier = Modifier.fillMaxWidth(1f)) {
+                Spacer(modifier = Modifier.size(8.dp))
+                Text(text = stringResource(id = R.string.forgot_keyphrase_info))
+                Spacer(modifier = Modifier.size(8.dp))
+            }
+        }
+    )
+}

app/src/main/java/com/yogeshpaliyal/keypass/ui/home/components/ValidateKeyPhraseDialog.kt

@@ -22,6 +22,7 @@ import com.yogeshpaliyal.keypass.ui.nav.LocalUserSettings
 import com.yogeshpaliyal.keypass.ui.redux.actions.Action
 import com.yogeshpaliyal.keypass.ui.redux.actions.ToastAction
 import com.yogeshpaliyal.keypass.ui.redux.actions.UpdateDialogState
+import com.yogeshpaliyal.keypass.ui.redux.states.ForgotKeyPhraseState
 import kotlinx.coroutines.launch
 import org.reduxkotlin.compose.rememberTypedDispatcher
 
@@ -87,6 +88,16 @@ fun ValidateKeyPhraseDialog() {
                         Text(text = stringResource(id = R.string.enter_keyphrase))
                     }
                 )
+
+                Spacer(modifier = Modifier.size(8.dp))
+
+                TextButton(onClick = {
+                    dispatchAction(UpdateDialogState(ForgotKeyPhraseState))
+                }) {
+                    Text(text = stringResource(id = R.string.forgot_keyphrase_question))
+                }
+
+                Spacer(modifier = Modifier.size(8.dp))
             }
         }
     )

app/src/main/java/com/yogeshpaliyal/keypass/ui/nav/DashboardComposeActivity.kt

@@ -33,6 +33,7 @@ import com.yogeshpaliyal.keypass.ui.changePassword.ChangePassword
 import com.yogeshpaliyal.keypass.ui.detail.AccountDetailPage
 import com.yogeshpaliyal.keypass.ui.generate.ui.GeneratePasswordScreen
 import com.yogeshpaliyal.keypass.ui.home.Homepage
+import com.yogeshpaliyal.keypass.ui.home.components.ForgotKeyPhraseDialog
 import com.yogeshpaliyal.keypass.ui.home.components.ValidateKeyPhraseDialog
 import com.yogeshpaliyal.keypass.ui.nav.components.DashboardBottomSheet
 import com.yogeshpaliyal.keypass.ui.nav.components.KeyPassBottomBar
@@ -48,6 +49,7 @@ import com.yogeshpaliyal.keypass.ui.redux.states.BackupScreenState
 import com.yogeshpaliyal.keypass.ui.redux.states.ChangeAppHintState
 import com.yogeshpaliyal.keypass.ui.redux.states.ChangeAppPasswordState
 import com.yogeshpaliyal.keypass.ui.redux.states.ChangeDefaultPasswordLengthState
+import com.yogeshpaliyal.keypass.ui.redux.states.ForgotKeyPhraseState
 import com.yogeshpaliyal.keypass.ui.redux.states.HomeState
 import com.yogeshpaliyal.keypass.ui.redux.states.KeyPassState
 import com.yogeshpaliyal.keypass.ui.redux.states.PasswordGeneratorState
@@ -189,9 +191,8 @@ fun CurrentPage() {
 
     currentScreen.dialog?.let {
         when (it) {
-            is ValidateKeyPhrase -> {
-                ValidateKeyPhraseDialog()
-            }
+            is ValidateKeyPhrase -> ValidateKeyPhraseDialog()
+            ForgotKeyPhraseState -> ForgotKeyPhraseDialog()
         }
     }
 }

app/src/main/java/com/yogeshpaliyal/keypass/ui/redux/states/DialogState.kt

@@ -3,3 +3,4 @@ package com.yogeshpaliyal.keypass.ui.redux.states
 sealed class DialogState()
 
 object ValidateKeyPhrase : DialogState()
+object ForgotKeyPhraseState : DialogState()

app/src/main/res/values/strings.xml

@@ -125,9 +125,13 @@
     <string name="file_not_found">File not found (please try again)</string>
     <string name="enter_password_hint">Enter password hint</string>
     <string name="validate_keyphrase">Keyphrase Check</string>
+    <string name="forgot_keyphrase">Forgot Keyphrase</string>
+    <string name="forgot_keyphrase_question">Forgot Keyphrase?</string>
+    <string name="forgot_keyphrase_info">If you can\'t remember your keyphrase, the only way to regain access is to turn off backups and then turn them back on. This will generate a new backup file and a new keyphrase. \nNote: Your old backup will be inaccessible.</string>
     <string name="valid_keyphrase">Valid Keyphrase</string>
     <string name="mismatch_keyphrase">Entered Keyphrase does not match with backup keyphrase</string>
     <string name="validate">Check</string>
+    <string name="got_it">Got it</string>
     <string name="biometric_disabled_due_to_timeout">Please login via password because you haven\'t used password in last 24 hours</string>
 
 </resources>