feat(card-browser): implement 'Default search text'

Fixes 18618

Assisted-by: Claude Opus 4.7 - all

Author: david-allison

AnkiDroid/src/main/java/com/ichi2/anki/browser/BrowserOptionsRepository.kt

@@ -20,6 +20,7 @@ import android.content.SharedPreferences
 import androidx.core.content.edit
 import com.ichi2.anki.CollectionManager.withCol
 import com.ichi2.anki.model.CardsOrNotes
+import com.ichi2.anki.utils.ext.defaultBrowserSearch
 import com.ichi2.anki.utils.ext.ignoreAccentsInSearch
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.StateFlow
@@ -40,10 +41,15 @@ class BrowserOptionsRepository(
     val ignoreAccentsInSearch: StateFlow<Boolean>
         field = MutableStateFlow(false)
 
+    /** @see com.ichi2.anki.libanki.Config.defaultBrowserSearch */
+    val defaultBrowserSearch: StateFlow<String>
+        field = MutableStateFlow("")
+
     /** Reads persisted values into the flows. Call once during ViewModel init. */
     suspend fun load() {
         cardsOrNotes.value = withCol { CardsOrNotes.fromCollection(this) }
         ignoreAccentsInSearch.value = withCol { config.ignoreAccentsInSearch }
+        defaultBrowserSearch.value = withCol { config.defaultBrowserSearch }
     }
 
     suspend fun setCardsOrNotes(value: CardsOrNotes) {
@@ -67,6 +73,13 @@ class BrowserOptionsRepository(
         ignoreAccentsInSearch.value = value
     }
 
+    suspend fun setDefaultBrowserSearch(value: String) {
+        if (defaultBrowserSearch.value == value) return
+        Timber.d("setting default browser search to %s", value)
+        withCol { config.defaultBrowserSearch = value }
+        defaultBrowserSearch.value = value
+    }
+
     companion object {
         private const val PREF_IS_TRUNCATED = "isTruncated"
     }

AnkiDroid/src/main/java/com/ichi2/anki/browser/CardBrowserFragment.kt

@@ -969,6 +969,11 @@ class CardBrowserFragment :
             Timber.d("syncing searchview state from chip updates")
             val filters = search.filters
 
+            // Handle default search text
+            if (search.query.isNotEmpty() && searchBar?.text.isNullOrEmpty()) {
+                launchCatchingTask { searchBar?.setText(search.toUserSpannable()) }
+            }
+
             decksChip?.text = filters.decks.firstOrNull()?.name ?: getString(R.string.card_browser_all_decks)
             decksChip?.hasCheckedBackground = filters.decks.any()
 

AnkiDroid/src/main/java/com/ichi2/anki/browser/CardBrowserViewModel.kt

@@ -239,6 +239,8 @@ class CardBrowserViewModel(
 
     val shouldIgnoreAccents: Boolean get() = browserOptionsRepository.ignoreAccentsInSearch.value
 
+    val defaultBrowserSearch: String get() = browserOptionsRepository.defaultBrowserSearch.value
+
     private val _selectedRows: MutableSet<CardOrNoteId> = Collections.synchronizedSet(LinkedHashSet())
 
     // immutable accessor for _selectedRows
@@ -500,6 +502,11 @@ class CardBrowserViewModel(
         viewModelScope.launch {
             browserOptionsRepository.load()
 
+            // Apply the default search (if available)
+            if (Prefs.devUsingCardBrowserSearchView) {
+                searchTerms = searchTerms.ifEmpty { defaultBrowserSearch }
+            }
+
             val initialDeckId = if (selectAllDecks) SelectableDeck.AllDecks else getInitialDeck()
             // PERF: slightly inefficient if the source was lastDeckId
             setSelectedDeck(initialDeckId)
@@ -693,6 +700,12 @@ class CardBrowserViewModel(
 
     fun setIgnoreAccents(value: Boolean) = viewModelScope.launch { browserOptionsRepository.setIgnoreAccentsInSearch(value) }
 
+    fun setDefaultSearchText(text: String) =
+        viewModelScope.launch {
+            if (!Prefs.devUsingCardBrowserSearchView) return@launch
+            browserOptionsRepository.setDefaultBrowserSearch(text)
+        }
+
     fun selectAll(): Job? {
         if (!_selectedRows.addAll(cards)) return null
         Timber.d("selecting all: %d item(s)", cards.size)

AnkiDroid/src/main/java/com/ichi2/anki/dialogs/BrowserOptionsDialog.kt

@@ -18,16 +18,20 @@ package com.ichi2.anki.dialogs
 
 import android.app.Dialog
 import android.os.Bundle
+import android.text.Editable
 import androidx.appcompat.app.AppCompatDialogFragment
 import androidx.core.os.bundleOf
+import androidx.core.view.isVisible
 import androidx.fragment.app.activityViewModels
+import anki.config.ConfigKey
 import com.google.android.material.dialog.MaterialAlertDialogBuilder
 import com.ichi2.anki.CollectionManager.TR
 import com.ichi2.anki.R
 import com.ichi2.anki.browser.BrowserColumnSelectionFragment
 import com.ichi2.anki.browser.CardBrowserViewModel
 import com.ichi2.anki.databinding.DialogBrowserOptionsBinding
 import com.ichi2.anki.model.CardsOrNotes
+import com.ichi2.anki.settings.Prefs
 import com.ichi2.utils.create
 import com.ichi2.utils.negativeButton
 import com.ichi2.utils.positiveButton
@@ -52,6 +56,7 @@ class BrowserOptionsDialog : AppCompatDialogFragment(R.layout.dialog_browser_opt
         viewModel.setCardsOrNotes(dialogCardsOrNotes)
         viewModel.setTruncated(binding.truncateCheckBox.isChecked)
         viewModel.setIgnoreAccents(binding.ignoreAccentsCheckBox.isChecked)
+        viewModel.setDefaultSearchText(binding.defaultSearchText.text.orEmpty())
     }
 
     private val cardsOrNotes by lazy {
@@ -100,6 +105,17 @@ class BrowserOptionsDialog : AppCompatDialogFragment(R.layout.dialog_browser_opt
             isChecked = viewModel.shouldIgnoreAccents
         }
 
+        if (Prefs.devUsingCardBrowserSearchView) {
+            binding.defaultSearchInputLayout.apply {
+                isVisible = true
+                hint = TR.preferencesDefaultSearchText()
+            }
+            binding.defaultSearchText.apply {
+                hint = TR.preferencesDefaultSearchTextExample()
+                setText(viewModel.defaultBrowserSearch)
+            }
+        }
+
         binding.browsingTextView.text = TR.preferencesBrowsing()
 
         return MaterialAlertDialogBuilder(requireContext()).create {
@@ -135,3 +151,6 @@ class BrowserOptionsDialog : AppCompatDialogFragment(R.layout.dialog_browser_opt
         }
     }
 }
+
+/** Returns the text content as a [String], or `""` if the receiver is `null`. */
+private fun Editable?.orEmpty(): String = this?.toString().orEmpty()

AnkiDroid/src/main/java/com/ichi2/anki/utils/ext/Config.kt

@@ -33,3 +33,12 @@ import com.ichi2.anki.libanki.Config
 var Config.ignoreAccentsInSearch
     get() = getBool(ConfigKey.Bool.IGNORE_ACCENTS_IN_SEARCH)
     set(value) = setBool(ConfigKey.Bool.IGNORE_ACCENTS_IN_SEARCH, value)
+
+/**
+ * Default search text for the card browser
+ *
+ * e.g. "deck:current"
+ */
+var Config.defaultBrowserSearch
+    get() = getString(ConfigKey.String.DEFAULT_SEARCH_TEXT)
+    set(value) = setString(ConfigKey.String.DEFAULT_SEARCH_TEXT, value)

AnkiDroid/src/main/res/layout/dialog_browser_options.xml

@@ -92,6 +92,26 @@
                 android:layout_height="wrap_content"
                 android:layout_marginHorizontal="16dp"
                 tools:text="Ignore accents in search (slower)"/>
+
+            <com.google.android.material.textfield.TextInputLayout
+                android:id="@+id/default_search_input_layout"
+                android:layout_width="match_parent"
+                android:layout_height="wrap_content"
+                style="@style/Widget.MaterialComponents.TextInputLayout.OutlinedBox"
+                app:expandedHintEnabled="false"
+                app:endIconMode="clear_text"
+                android:layout_marginHorizontal="16dp"
+                android:layout_marginTop="8dp"
+                android:visibility="gone"
+                tools:visibility="visible"
+                tools:hint="Default search text">
+                <com.google.android.material.textfield.TextInputEditText
+                    android:id="@+id/default_search_text"
+                    android:layout_width="match_parent"
+                    android:layout_height="wrap_content"
+                    android:inputType="text"
+                    tools:hint="e.g. 'deck:current'"/>
+            </com.google.android.material.textfield.TextInputLayout>
         </LinearLayout>
 
         <LinearLayout

AnkiDroid/src/test/java/com/ichi2/anki/browser/CardBrowserViewModelTest.kt

@@ -82,6 +82,7 @@ import com.ichi2.anki.model.SortType
 import com.ichi2.anki.servicelayer.NoteService
 import com.ichi2.anki.setFlagFilterSync
 import com.ichi2.anki.settings.Prefs
+import com.ichi2.anki.utils.ext.defaultBrowserSearch
 import com.ichi2.anki.utils.ext.ifNotZero
 import com.ichi2.anki.utils.ext.ignoreAccentsInSearch
 import com.ichi2.testutils.IntentAssert
@@ -1570,6 +1571,47 @@ class CardBrowserViewModelTest : JvmTest() {
         }
     }
 
+    @Test
+    fun `default search text is applied on init`() {
+        col.config.defaultBrowserSearch = "deck:current"
+        try {
+            Prefs.devUsingCardBrowserSearchView = true
+            runViewModelTest {
+                assertThat(searchTerms, equalTo("deck:current"))
+                assertThat(defaultBrowserSearch, equalTo("deck:current"))
+            }
+        } finally {
+            Prefs.devUsingCardBrowserSearchView = false
+        }
+    }
+
+    @Test
+    fun `intent search wins over default search text`() {
+        col.config.defaultBrowserSearch = "deck:current"
+        try {
+            Prefs.devUsingCardBrowserSearchView = true
+            runViewModelTest(options = DeepLink("tag:foo")) {
+                assertThat(searchTerms, equalTo("tag:foo"))
+            }
+        } finally {
+            Prefs.devUsingCardBrowserSearchView = false
+        }
+    }
+
+    @Test
+    fun `setDefaultSearchText round-trips through collection config`() {
+        try {
+            Prefs.devUsingCardBrowserSearchView = true
+            runViewModelTest {
+                setDefaultSearchText("tag:foo").join()
+                assertThat(defaultBrowserSearch, equalTo("tag:foo"))
+                assertThat(col.config.defaultBrowserSearch, equalTo("tag:foo"))
+            }
+        } finally {
+            Prefs.devUsingCardBrowserSearchView = false
+        }
+    }
+
     @Test
     fun `updating sort type launches search`() =
         runViewModelTest {