Make preferred directory structure for Autofill configurable (#660)

Some users keep their password files in a directory structure such as:
/example.org/john@doe.org.gpg
while others prefer the style:
/example.org/john@doe.org/password.gpg

This commit adds a setting that allows to switch between the two. All Autofill
operations, such as search, match, generate and save, respect this setting.

Note: The first style seems to be the most widely used and is therefore kept as
the default. The second style is mentioned on the official Pass website at:
https://www.passwordstore.org/#organization

5 files changed, 134 insertions, 41 deletions

diff --git a/app/src/main/java/com/zeapo/pwdstore/autofill/oreo/AutofillHelper.kt b/app/src/main/java/com/zeapo/pwdstore/autofill/oreo/AutofillHelper.kt
index 4b7b47e2..e3d48302 100644
--- a/app/src/main/java/com/zeapo/pwdstore/autofill/oreo/AutofillHelper.kt
+++ b/app/src/main/java/com/zeapo/pwdstore/autofill/oreo/AutofillHelper.kt
@@ -73,9 +73,14 @@ val AssistStructure.ViewNode.webOrigin: String?
 
 data class Credentials(val username: String?, val password: String) {
     companion object {
-        fun fromStoreEntry(file: File, entry: PasswordEntry): Credentials {
-            return if (entry.hasUsername()) Credentials(entry.username, entry.password)
-            else Credentials(file.nameWithoutExtension, entry.password)
+        fun fromStoreEntry(
+            file: File,
+            entry: PasswordEntry,
+            directoryStructure: DirectoryStructure
+        ): Credentials {
+            // Always give priority to a username stored in the encrypted extras
+            val username = entry.username ?: directoryStructure.getUsernameFor(file)
+            return Credentials(username, entry.password)
         }
     }
 }
@@ -95,7 +100,7 @@ private fun makeRemoteView(
 
 fun makeFillMatchRemoteView(context: Context, file: File, formOrigin: FormOrigin): RemoteViews {
     val title = formOrigin.getPrettyIdentifier(context, untrusted = false)
-    val summary = file.nameWithoutExtension
+    val summary = AutofillPreferences.directoryStructure(context).getUsernameFor(file)
     val iconRes = R.drawable.ic_person_black_24dp
     return makeRemoteView(context, title, summary, iconRes)
 }
diff --git a/app/src/main/java/com/zeapo/pwdstore/autofill/oreo/AutofillPreferences.kt b/app/src/main/java/com/zeapo/pwdstore/autofill/oreo/AutofillPreferences.kt
new file mode 100644
index 00000000..c1ce51e9
--- /dev/null
+++ b/app/src/main/java/com/zeapo/pwdstore/autofill/oreo/AutofillPreferences.kt
@@ -0,0 +1,59 @@
+/*
+ * Copyright © 2014-2020 The Android Password Store Authors. All Rights Reserved.
+ * SPDX-License-Identifier: GPL-3.0-only
+ */
+package com.zeapo.pwdstore.autofill.oreo
+
+import android.content.Context
+import android.content.SharedPreferences
+import android.os.Build
+import androidx.annotation.RequiresApi
+import androidx.preference.PreferenceManager
+import java.io.File
+import java.nio.file.Paths
+
+private val Context.defaultSharedPreferences: SharedPreferences
+    get() = PreferenceManager.getDefaultSharedPreferences(this)
+
+enum class DirectoryStructure(val value: String) {
+    FileBased("file"),
+    DirectoryBased("directory");
+
+    fun getUsernameFor(file: File) = when (this) {
+        FileBased -> file.nameWithoutExtension
+        DirectoryBased -> file.parentFile?.name ?: file.nameWithoutExtension
+    }
+
+    fun getIdentifierFor(file: File) = when (this) {
+        FileBased -> file.parentFile?.name
+        DirectoryBased -> file.parentFile?.parentFile?.name
+    }
+
+    @RequiresApi(Build.VERSION_CODES.O)
+    fun getSaveFolderName(sanitizedIdentifier: String, username: String?) = when (this) {
+        FileBased -> sanitizedIdentifier
+        DirectoryBased -> Paths.get(sanitizedIdentifier, username ?: "username").toString()
+    }
+
+    fun getSaveFileName(username: String?) = when (this) {
+        FileBased -> username
+        DirectoryBased -> "password"
+    }
+
+    companion object {
+        const val PREFERENCE = "oreo_autofill_directory_structure"
+        private val DEFAULT = FileBased
+
+        private val reverseMap = values().associateBy { it.value }
+        fun fromValue(value: String?) = if (value != null) reverseMap[value] ?: DEFAULT else DEFAULT
+    }
+}
+
+object AutofillPreferences {
+
+    fun directoryStructure(context: Context): DirectoryStructure {
+        val value =
+            context.defaultSharedPreferences.getString(DirectoryStructure.PREFERENCE, null)
+        return DirectoryStructure.fromValue(value)
+    }
+}
diff --git a/app/src/main/java/com/zeapo/pwdstore/autofill/oreo/ui/AutofillDecryptActivity.kt b/app/src/main/java/com/zeapo/pwdstore/autofill/oreo/ui/AutofillDecryptActivity.kt
index 2f3824f9..2c44ee42 100644
--- a/app/src/main/java/com/zeapo/pwdstore/autofill/oreo/ui/AutofillDecryptActivity.kt
+++ b/app/src/main/java/com/zeapo/pwdstore/autofill/oreo/ui/AutofillDecryptActivity.kt
@@ -18,7 +18,9 @@ import com.github.ajalt.timberkt.d
 import com.github.ajalt.timberkt.e
 import com.zeapo.pwdstore.PasswordEntry
 import com.zeapo.pwdstore.autofill.oreo.AutofillAction
+import com.zeapo.pwdstore.autofill.oreo.AutofillPreferences
 import com.zeapo.pwdstore.autofill.oreo.Credentials
+import com.zeapo.pwdstore.autofill.oreo.DirectoryStructure
 import com.zeapo.pwdstore.autofill.oreo.FillableForm
 import java.io.ByteArrayOutputStream
 import java.io.File
@@ -76,6 +78,7 @@ class AutofillDecryptActivity : Activity(), CoroutineScope {
     }
 
     private var continueAfterUserInteraction: Continuation<Intent>? = null
+    private lateinit var directoryStructure: DirectoryStructure
 
     override val coroutineContext
         get() = Dispatchers.IO + SupervisorJob()
@@ -94,6 +97,7 @@ class AutofillDecryptActivity : Activity(), CoroutineScope {
         }
         val isSearchAction = intent?.getBooleanExtra(EXTRA_SEARCH_ACTION, true)!!
         val action = if (isSearchAction) AutofillAction.Search else AutofillAction.Match
+        directoryStructure = AutofillPreferences.directoryStructure(this)
         d { action.toString() }
         launch {
             val credentials = decryptUsernameAndPassword(File(filePath))
@@ -176,7 +180,7 @@ class AutofillDecryptActivity : Activity(), CoroutineScope {
                     val entry = withContext(Dispatchers.IO) {
                         PasswordEntry(decryptedOutput)
                     }
-                    Credentials.fromStoreEntry(file, entry)
+                    Credentials.fromStoreEntry(file, entry, directoryStructure)
                 } catch (e: UnsupportedEncodingException) {
                     e(e) { "Failed to parse password entry" }
                     null
diff --git a/app/src/main/java/com/zeapo/pwdstore/autofill/oreo/ui/AutofillFilterActivity.kt b/app/src/main/java/com/zeapo/pwdstore/autofill/oreo/ui/AutofillFilterActivity.kt
index 8c77fff8..e4517197 100644
--- a/app/src/main/java/com/zeapo/pwdstore/autofill/oreo/ui/AutofillFilterActivity.kt
+++ b/app/src/main/java/com/zeapo/pwdstore/autofill/oreo/ui/AutofillFilterActivity.kt
@@ -23,10 +23,13 @@ import com.afollestad.recyclical.withItem
 import com.github.ajalt.timberkt.e
 import com.zeapo.pwdstore.R
 import com.zeapo.pwdstore.autofill.oreo.AutofillMatcher
+import com.zeapo.pwdstore.autofill.oreo.AutofillPreferences
+import com.zeapo.pwdstore.autofill.oreo.DirectoryStructure
 import com.zeapo.pwdstore.autofill.oreo.FormOrigin
 import com.zeapo.pwdstore.utils.PasswordItem
 import com.zeapo.pwdstore.utils.PasswordRepository
 import java.io.File
+import java.nio.file.Paths
 import java.util.Locale
 import kotlinx.android.synthetic.main.activity_oreo_autofill_filter.*
 
@@ -69,6 +72,8 @@ class AutofillFilterView : AppCompatActivity() {
         get() = PasswordRepository.PasswordSortOrder.getSortOrder(preferences)
 
     private lateinit var formOrigin: FormOrigin
+    private lateinit var repositoryRoot: File
+    private lateinit var directoryStructure: DirectoryStructure
 
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
@@ -98,6 +103,8 @@ class AutofillFilterView : AppCompatActivity() {
                 return
             }
         }
+        repositoryRoot = PasswordRepository.getRepositoryDirectory(this)
+        directoryStructure = AutofillPreferences.directoryStructure(this)
 
         supportActionBar?.hide()
         bindUI()
@@ -110,9 +117,19 @@ class AutofillFilterView : AppCompatActivity() {
             withDataSource(dataSource)
             withItem<PasswordItem, PasswordViewHolder>(R.layout.oreo_autofill_filter_row) {
                 onBind(::PasswordViewHolder) { _, item ->
-                    title.text = item.fullPathToParent
-                    // drop the .gpg extension
-                    subtitle.text = item.name.dropLast(4)
+                    when (directoryStructure) {
+                        DirectoryStructure.FileBased -> {
+                            title.text = item.file.relativeTo(item.rootDir).parent
+                            subtitle.text = item.file.nameWithoutExtension
+                        }
+                        DirectoryStructure.DirectoryBased -> {
+                            title.text =
+                                item.file.relativeTo(item.rootDir).parentFile?.parent ?: "/INVALID"
+                            subtitle.text =
+                                Paths.get(item.file.parentFile.name, item.file.nameWithoutExtension)
+                                    .toString()
+                        }
+                    }
                 }
                 onClick { decryptAndFill(item) }
             }
@@ -156,40 +173,41 @@ class AutofillFilterView : AppCompatActivity() {
         }
     }
 
+    private fun File.matches(filter: String, strict: Boolean): Boolean {
+        return if (strict) {
+            val toMatch = directoryStructure.getIdentifierFor(this) ?: return false
+            // In strict mode, we match
+            // * the search term exactly,
+            // * subdomains of the search term,
+            // * or the search term plus an arbitrary protocol.
+            toMatch == filter || toMatch.endsWith(".$filter") || toMatch.endsWith("://$filter")
+        } else {
+            val toMatch =
+                "${relativeTo(repositoryRoot).path}/$nameWithoutExtension".toLowerCase(Locale.getDefault())
+            toMatch.contains(filter.toLowerCase(Locale.getDefault()))
+        }
+    }
+
     private fun recursiveFilter(filter: String, dir: File? = null, strict: Boolean = true) {
-        val root = PasswordRepository.getRepositoryDirectory(this)
         // on the root the pathStack is empty
         val passwordItems = if (dir == null) {
-            PasswordRepository.getPasswords(
-                PasswordRepository.getRepositoryDirectory(this),
-                sortOrder
-            )
+            PasswordRepository.getPasswords(repositoryRoot, sortOrder)
         } else {
-            PasswordRepository.getPasswords(
-                dir,
-                PasswordRepository.getRepositoryDirectory(this),
-                sortOrder
-            )
+            PasswordRepository.getPasswords(dir, repositoryRoot, sortOrder)
         }
 
         for (item in passwordItems) {
             if (item.type == PasswordItem.TYPE_CATEGORY) {
                 recursiveFilter(filter, item.file, strict = strict)
-            }
-
-            // TODO: Implement fuzzy search if strict == false?
-            val matches = if (strict) item.file.parentFile.name.let {
-                it == filter || it.endsWith(".$filter") || it.endsWith("://$filter")
-            }
-            else "${item.file.relativeTo(root).path}/${item.file.nameWithoutExtension}".toLowerCase(
-                Locale.getDefault()
-            ).contains(filter.toLowerCase(Locale.getDefault()))
-
-            val inAdapter = dataSource.contains(item)
-            if (item.type == PasswordItem.TYPE_PASSWORD && matches && !inAdapter) {
-                dataSource.add(item)
-            } else if (!matches && inAdapter) {
-                dataSource.remove(item)
+            } else {
+                // TODO: Implement fuzzy search if strict == false?
+                val matches = item.file.matches(filter, strict = strict)
+                val inAdapter = dataSource.contains(item)
+                if (matches && !inAdapter) {
+                    dataSource.add(item)
+                } else if (!matches && inAdapter) {
+                    dataSource.remove(item)
+                }
             }
         }
     }
diff --git a/app/src/main/java/com/zeapo/pwdstore/autofill/oreo/ui/AutofillSaveActivity.kt b/app/src/main/java/com/zeapo/pwdstore/autofill/oreo/ui/AutofillSaveActivity.kt
index e5368b73..e5def0fb 100644
--- a/app/src/main/java/com/zeapo/pwdstore/autofill/oreo/ui/AutofillSaveActivity.kt
+++ b/app/src/main/java/com/zeapo/pwdstore/autofill/oreo/ui/AutofillSaveActivity.kt
@@ -18,6 +18,7 @@ import com.github.ajalt.timberkt.e
 import com.zeapo.pwdstore.PasswordStore
 import com.zeapo.pwdstore.autofill.oreo.AutofillAction
 import com.zeapo.pwdstore.autofill.oreo.AutofillMatcher
+import com.zeapo.pwdstore.autofill.oreo.AutofillPreferences
 import com.zeapo.pwdstore.autofill.oreo.Credentials
 import com.zeapo.pwdstore.autofill.oreo.FillableForm
 import com.zeapo.pwdstore.autofill.oreo.FormOrigin
@@ -32,7 +33,7 @@ class AutofillSaveActivity : Activity() {
         private const val EXTRA_FOLDER_NAME =
             "com.zeapo.pwdstore.autofill.oreo.ui.EXTRA_FOLDER_NAME"
         private const val EXTRA_PASSWORD = "com.zeapo.pwdstore.autofill.oreo.ui.EXTRA_PASSWORD"
-        private const val EXTRA_USERNAME = "com.zeapo.pwdstore.autofill.oreo.ui.EXTRA_USERNAME"
+        private const val EXTRA_NAME = "com.zeapo.pwdstore.autofill.oreo.ui.EXTRA_NAME"
         private const val EXTRA_SHOULD_MATCH_APP =
             "com.zeapo.pwdstore.autofill.oreo.ui.EXTRA_SHOULD_MATCH_APP"
         private const val EXTRA_SHOULD_MATCH_WEB =
@@ -48,15 +49,23 @@ class AutofillSaveActivity : Activity() {
             formOrigin: FormOrigin
         ): IntentSender {
             val identifier = formOrigin.getPrettyIdentifier(context, untrusted = false)
-            val sanitizedIdentifier = identifier.replace("""[\\\/]""", "")
-            val folderName =
-                sanitizedIdentifier.takeUnless { it.isBlank() } ?: formOrigin.identifier
+            // Prevent directory traversals
+            val sanitizedIdentifier = identifier.replace('\\', '_')
+                .replace('/', '_')
+                .trimStart('.')
+                .takeUnless { it.isBlank() } ?: formOrigin.identifier
+            val directoryStructure = AutofillPreferences.directoryStructure(context)
+            val folderName = directoryStructure.getSaveFolderName(
+                sanitizedIdentifier = sanitizedIdentifier,
+                username = credentials?.username
+            )
+            val fileName = directoryStructure.getSaveFileName(username = credentials?.username)
             val intent = Intent(context, AutofillSaveActivity::class.java).apply {
                 putExtras(
                     bundleOf(
                         EXTRA_FOLDER_NAME to folderName,
+                        EXTRA_NAME to fileName,
                         EXTRA_PASSWORD to credentials?.password,
-                        EXTRA_USERNAME to credentials?.username,
                         EXTRA_SHOULD_MATCH_APP to formOrigin.identifier.takeIf { formOrigin is FormOrigin.App },
                         EXTRA_SHOULD_MATCH_WEB to formOrigin.identifier.takeIf { formOrigin is FormOrigin.Web },
                         EXTRA_GENERATE_PASSWORD to (credentials == null)
@@ -87,15 +96,13 @@ class AutofillSaveActivity : Activity() {
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
         val repo = PasswordRepository.getRepositoryDirectory(applicationContext)
-        val username = intent.getStringExtra(EXTRA_USERNAME)
-
         val saveIntent = Intent(this, PgpActivity::class.java).apply {
             putExtras(
                 bundleOf(
                     "REPO_PATH" to repo.absolutePath,
                     "FILE_PATH" to repo.resolve(intent.getStringExtra(EXTRA_FOLDER_NAME)).absolutePath,
                     "OPERATION" to "ENCRYPT",
-                    "SUGGESTED_NAME" to username,
+                    "SUGGESTED_NAME" to intent.getStringExtra(EXTRA_NAME),
                     "SUGGESTED_PASS" to intent.getStringExtra(EXTRA_PASSWORD),
                     "GENERATE_PASSWORD" to intent.getBooleanExtra(EXTRA_GENERATE_PASSWORD, false)
                 )