[UI Enhancement] Displayed File Name During Password Entry

OffRange · OffRange · commit 9d1487ba8733 · 2024-02-03T01:55:18.000+01:00
Implemented a feature to show the file name on the password entry dialog, providing users with a clear context of the file they are accessing. This UI enhancement improves usability by ensuring users are aware of which specific file requires password authentication.
diff --git a/app/src/main/java/de/davis/passwordmanager/backup/BackupResourceProvider.kt b/app/src/main/java/de/davis/passwordmanager/backup/BackupResourceProvider.kt
@@ -3,8 +3,10 @@ package de.davis.passwordmanager.backup
 import java.io.InputStream
 import java.io.OutputStream
 
-interface StreamProvider {
+interface BackupResourceProvider {
 
     suspend fun provideInputStream(): InputStream
     suspend fun provideOutputStream(): OutputStream
+
+    suspend fun getFileName(): String
 }
diff --git a/app/src/main/java/de/davis/passwordmanager/backup/DataBackup.kt b/app/src/main/java/de/davis/passwordmanager/backup/DataBackup.kt
@@ -25,12 +25,15 @@ abstract class DataBackup(private val backupListener: BackupListener = BackupLis
         }
     }
 
-    open suspend fun execute(backupOperation: BackupOperation, streamProvider: StreamProvider) {
+    open suspend fun execute(
+        backupOperation: BackupOperation,
+        backupResourceProvider: BackupResourceProvider
+    ) {
         backupListener.run {
             runCatching {
                 withContext(Dispatchers.Main) { onStart(backupOperation) }
 
-                streamProvider.run {
+                backupResourceProvider.run {
                     progressContext.run {
                         when (backupOperation) {
                             BackupOperation.IMPORT -> provideInputStream().use { runImport(it) }
diff --git a/app/src/main/java/de/davis/passwordmanager/backup/PasswordProvider.kt b/app/src/main/java/de/davis/passwordmanager/backup/PasswordProvider.kt
@@ -4,6 +4,7 @@ interface PasswordProvider {
 
     suspend operator fun invoke(
         backupOperation: BackupOperation,
+        backupResourceProvider: BackupResourceProvider,
         callback: suspend (password: String) -> Unit
     )
 }
diff --git a/app/src/main/java/de/davis/passwordmanager/backup/SecureDataBackup.kt b/app/src/main/java/de/davis/passwordmanager/backup/SecureDataBackup.kt
@@ -27,10 +27,13 @@ abstract class SecureDataBackup(
     final override suspend fun ProgressContext.runExport(outputStream: OutputStream): BackupResult =
         runExport(outputStream, password)
 
-    override suspend fun execute(backupOperation: BackupOperation, streamProvider: StreamProvider) {
-        passwordProvider(backupOperation) {
+    override suspend fun execute(
+        backupOperation: BackupOperation,
+        backupResourceProvider: BackupResourceProvider
+    ) {
+        passwordProvider(backupOperation, backupResourceProvider) {
             password = it
-            super.execute(backupOperation, streamProvider)
+            super.execute(backupOperation, backupResourceProvider)
         }
     }
 }
diff --git a/app/src/main/java/de/davis/passwordmanager/backup/impl/AndroidPasswordProvider.kt b/app/src/main/java/de/davis/passwordmanager/backup/impl/AndroidPasswordProvider.kt
@@ -10,6 +10,7 @@ import androidx.appcompat.content.res.AppCompatResources
 import com.google.android.material.textfield.TextInputLayout
 import de.davis.passwordmanager.R
 import de.davis.passwordmanager.backup.BackupOperation
+import de.davis.passwordmanager.backup.BackupResourceProvider
 import de.davis.passwordmanager.backup.PasswordProvider
 import de.davis.passwordmanager.dialog.EditDialogBuilder
 import de.davis.passwordmanager.ui.views.InformationView
@@ -22,6 +23,7 @@ import kotlinx.coroutines.withContext
 class AndroidPasswordProvider(private val context: Context) : PasswordProvider {
     override suspend fun invoke(
         backupOperation: BackupOperation,
+        backupResourceProvider: BackupResourceProvider,
         callback: suspend (password: String) -> Unit
     ) {
         withContext(Dispatchers.Main) {
@@ -33,6 +35,12 @@ class AndroidPasswordProvider(private val context: Context) : PasswordProvider {
 
             EditDialogBuilder(context).apply {
                 setTitle(R.string.password)
+                setMessage(
+                    context.getString(
+                        R.string.enter_password_for_s,
+                        backupResourceProvider.getFileName()
+                    )
+                )
                 setPositiveButton(R.string.yes) { _: DialogInterface?, _: Int -> }
                 setButtonListener(
                     DialogInterface.BUTTON_POSITIVE,
diff --git a/app/src/main/java/de/davis/passwordmanager/backup/impl/KdbxBackup.kt b/app/src/main/java/de/davis/passwordmanager/backup/impl/KdbxBackup.kt
@@ -39,8 +39,7 @@ class KdbxBackup(
         inputStream: InputStream,
         password: String
     ): BackupResult {
-        val database =
-            inputStream.use { KeePassDatabase.decode(it, credentialFactory(password)) }
+        val database = inputStream.use { KeePassDatabase.decode(it, credentialFactory(password)) }
 
         val existingElements = SecureElementManager.getSecureElements(ElementType.PASSWORD.typeId)
         val elementsToAdd = mutableListOf<SecureElement>()
diff --git a/app/src/main/java/de/davis/passwordmanager/backup/impl/UriBackupResourceProvider.kt b/app/src/main/java/de/davis/passwordmanager/backup/impl/UriBackupResourceProvider.kt
@@ -0,0 +1,44 @@
+package de.davis.passwordmanager.backup.impl
+
+import android.annotation.SuppressLint
+import android.content.ContentResolver
+import android.database.Cursor
+import android.net.Uri
+import android.provider.OpenableColumns
+import de.davis.passwordmanager.backup.BackupResourceProvider
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.withContext
+import java.io.InputStream
+import java.io.OutputStream
+
+class UriBackupResourceProvider(
+    private var uri: Uri,
+    private var contentResolver: ContentResolver
+) : BackupResourceProvider {
+
+    override suspend fun provideInputStream(): InputStream = contentResolver.openInputStream(uri)
+        ?: throw IllegalStateException("ContentResolver returned null")
+
+    override suspend fun provideOutputStream(): OutputStream = contentResolver.openOutputStream(uri)
+        ?: throw IllegalStateException("ContentResolver returned null")
+
+    override suspend fun getFileName(): String = contentResolver.getFileName(uri) ?: "Unknown"
+
+    private suspend fun ContentResolver.getFileName(uri: Uri): String? =
+        withContext(Dispatchers.IO) {
+            var fileName: String? = null
+            if (uri.scheme == ContentResolver.SCHEME_CONTENT) {
+                val cursor: Cursor? = query(uri, null, null, null, null)
+                cursor?.use {
+                    if (it.moveToFirst()) {
+                        @SuppressLint("Range")
+                        fileName = it.getString(it.getColumnIndex(OpenableColumns.DISPLAY_NAME))
+                    }
+                }
+            } else if (uri.scheme == ContentResolver.SCHEME_FILE) {
+                fileName = uri.lastPathSegment
+            }
+            
+            fileName
+        }
+}
diff --git a/app/src/main/java/de/davis/passwordmanager/backup/impl/UriStreamProvider.kt b/app/src/main/java/de/davis/passwordmanager/backup/impl/UriStreamProvider.kt
diff --git a/app/src/main/java/de/davis/passwordmanager/ui/backup/BackupFragment.kt b/app/src/main/java/de/davis/passwordmanager/ui/backup/BackupFragment.kt
@@ -21,7 +21,7 @@ import de.davis.passwordmanager.backup.impl.AndroidBackupListener
 import de.davis.passwordmanager.backup.impl.AndroidPasswordProvider
 import de.davis.passwordmanager.backup.impl.CsvBackup
 import de.davis.passwordmanager.backup.impl.KdbxBackup
-import de.davis.passwordmanager.backup.impl.UriStreamProvider
+import de.davis.passwordmanager.backup.impl.UriBackupResourceProvider
 import de.davis.passwordmanager.ktx.getParcelableCompat
 import de.davis.passwordmanager.ui.auth.AuthenticationRequest
 import de.davis.passwordmanager.ui.auth.createRequestAuthenticationIntent
@@ -95,7 +95,7 @@ class BackupFragment : PreferenceFragmentCompat() {
         backup: DataBackup
     ): ActivityResultLauncher<T> {
         val createStreamProvider = { uri: Uri ->
-            UriStreamProvider(uri, requireContext().contentResolver)
+            UriBackupResourceProvider(uri, requireContext().contentResolver)
         }
 
         return registerForActivityResult(contract) { uri: Uri? ->
diff --git a/app/src/main/java/de/davis/passwordmanager/ui/sync/ImportActivity.kt b/app/src/main/java/de/davis/passwordmanager/ui/sync/ImportActivity.kt
@@ -7,16 +7,18 @@ import androidx.activity.result.ActivityResult
 import androidx.activity.result.contract.ActivityResultContracts
 import androidx.appcompat.app.AppCompatActivity
 import androidx.lifecycle.lifecycleScope
+import de.davis.passwordmanager.R
 import de.davis.passwordmanager.backup.BackupOperation
 import de.davis.passwordmanager.backup.BackupResult
 import de.davis.passwordmanager.backup.impl.AndroidBackupListener
 import de.davis.passwordmanager.backup.impl.AndroidPasswordProvider
 import de.davis.passwordmanager.backup.impl.KdbxBackup
-import de.davis.passwordmanager.backup.impl.UriStreamProvider
+import de.davis.passwordmanager.backup.impl.UriBackupResourceProvider
 import de.davis.passwordmanager.databinding.ActivityImportBinding
 import de.davis.passwordmanager.ui.MainActivity
 import de.davis.passwordmanager.ui.auth.AuthenticationRequest
 import de.davis.passwordmanager.ui.auth.createRequestAuthenticationIntent
+import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.launch
 
 class ImportActivity : AppCompatActivity() {
@@ -46,18 +48,32 @@ class ImportActivity : AppCompatActivity() {
             layoutInflater
         )
         setContentView(binding.root)
+        val fileUri = intent.data ?: run {
+            finish()
+            return
+        }
+
+        val uriBackupResourceProvider = UriBackupResourceProvider(fileUri, contentResolver)
+
+        lifecycleScope.launch(Dispatchers.Main) {
+            binding.informationView.setInformationText(
+                getString(
+                    R.string.authenticate_to_import,
+                    uriBackupResourceProvider.getFileName()
+                )
+            )
+        }
 
         val auth =
             registerForActivityResult(ActivityResultContracts.StartActivityForResult()) { result: ActivityResult ->
                 if (result.resultCode != RESULT_OK) return@registerForActivityResult
                 if (intent.action == null) return@registerForActivityResult
                 if (intent.action != Intent.ACTION_VIEW) return@registerForActivityResult
-                val fileUri = intent.data ?: return@registerForActivityResult
 
                 lifecycleScope.launch {
                     kdbxBackup.execute(
                         BackupOperation.IMPORT,
-                        UriStreamProvider(fileUri, contentResolver)
+                        UriBackupResourceProvider(fileUri, contentResolver)
                     )
                 }
             }
diff --git a/app/src/main/res/layout/activity_import.xml b/app/src/main/res/layout/activity_import.xml
@@ -9,6 +9,7 @@
     tools:context=".ui.sync.ImportActivity">
 
     <de.davis.passwordmanager.ui.views.InformationView
+        android:id="@+id/informationView"
         android:layout_width="match_parent"
         android:layout_height="wrap_content"
         app:information="@string/authenticate_to_import"
diff --git a/app/src/main/res/values-de/strings.xml b/app/src/main/res/values-de/strings.xml
@@ -149,8 +149,9 @@
     <string name="invalid_file">Ungültige Datei</string>
 
     <string name="wait_text">Das könnte ein wenig Zeit in Anspruch nehmen. Bitte haben Sie Geduld</string>
-    <string name="authenticate_to_import">Um ein Backup laden zu können, ist eine Authentifizierung erforderlich</string>
+    <string name="authenticate_to_import">Um \"%s\" laden zu können, ist eine Authentifizierung erforderlich</string>
     <string name="authenticate_to_proceed">Authentifizieren um fortzufahren</string>
+    <string name="enter_password_for_s">Geben Sie das Passwort für \"%s\" ein</string>
 
     <string name="tag">Tag</string>
     <string name="tags">Tags</string>
diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml
@@ -191,8 +191,9 @@
     <string name="invalid_file">Invalid file</string>
 
     <string name="wait_text">This might take a little time. Please be patient</string>
-    <string name="authenticate_to_import">To load a backup, authentication is required</string>
+    <string name="authenticate_to_import">To load \"%s\", authentication is required</string>
     <string name="authenticate_to_proceed">Authenticate to proceed</string>
+    <string name="enter_password_for_s">Enter password for \"%s\"</string>
 
     <string name="tag">Tag</string>
     <string name="tags">Tags</string>

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@ interface PasswordProvider {`
`4`	`4`
`5`	`5`	`suspend operator fun invoke(`
`6`	`6`	`backupOperation: BackupOperation,`
	`7`	`+ backupResourceProvider: BackupResourceProvider,`
`7`	`8`	`callback: suspend (password: String) -> Unit`
`8`	`9`	`)`
`9`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,10 +27,13 @@ abstract class SecureDataBackup(`
`27`	`27`	`final override suspend fun ProgressContext.runExport(outputStream: OutputStream): BackupResult =`
`28`	`28`	`runExport(outputStream, password)`
`29`	`29`
`30`		`- override suspend fun execute(backupOperation: BackupOperation, streamProvider: StreamProvider) {`
`31`		`- passwordProvider(backupOperation) {`
	`30`	`+ override suspend fun execute(`
	`31`	`+ backupOperation: BackupOperation,`
	`32`	`+ backupResourceProvider: BackupResourceProvider`
	`33`	`+ ) {`
	`34`	`+ passwordProvider(backupOperation, backupResourceProvider) {`
`32`	`35`	`password = it`
`33`		`- super.execute(backupOperation, streamProvider)`
	`36`	`+ super.execute(backupOperation, backupResourceProvider)`
`34`	`37`	`}`
`35`	`38`	`}`
`36`	`39`	`}`