feat: add clipboard listening switch

Author: WhiredPlanck

app/src/main/java/com/osfans/trime/data/db/ClipboardHelper.kt

@@ -7,9 +7,11 @@ package com.osfans.trime.data.db
 import android.content.ClipboardManager
 import android.content.Context
 import android.os.Build
+import androidx.annotation.Keep
 import androidx.room.Room
 import androidx.room.withTransaction
 import com.osfans.trime.data.prefs.AppPrefs
+import com.osfans.trime.data.prefs.PreferenceDelegate
 import com.osfans.trime.util.WeakHashSet
 import com.osfans.trime.util.matchesAny
 import com.osfans.trime.util.removeRegexSet
@@ -53,7 +55,23 @@ object ClipboardHelper :
 
     private val clipPref = AppPrefs.defaultInstance().clipboard
 
-    private val limit by clipPref.clipboardLimit
+    private val enabledPref = clipPref.clipboardListening
+
+    @Keep
+    private val enabledListener = PreferenceDelegate.OnChangeListener<Boolean> { _, value ->
+        if (value) {
+            clipboardManager.addPrimaryClipChangedListener(this)
+        } else {
+            clipboardManager.removePrimaryClipChangedListener(this)
+        }
+    }
+
+    private val limitPref = clipPref.clipboardLimit
+
+    @Keep
+    private val limitListener = PreferenceDelegate.OnChangeListener<Int> { _, _ ->
+        launch { removeOutdated() }
+    }
 
     private val compareRules: Set<Regex> by lazy {
         val rules by clipPref.clipboardCompareRules
@@ -86,6 +104,10 @@ object ClipboardHelper :
                 .addMigrations(Database.MIGRATION_3_4)
                 .build()
         clbDao = clbDb.databaseDao()
+        enabledListener.onChange(enabledPref.key, enabledPref.getValue())
+        enabledPref.registerOnChangeListener(enabledListener)
+        limitListener.onChange(limitPref.key, limitPref.getValue())
+        limitPref.registerOnChangeListener(limitListener)
         launch { updateItemCount() }
     }
 
@@ -135,9 +157,6 @@ object ClipboardHelper :
      * - [outputRules] 输出规则。如果剪贴板内容与规则匹配，则不通知剪贴板管理器。
      */
     override fun onPrimaryClipChanged() {
-        if (!(limit != 0 && this::clbDao.isInitialized)) {
-            return
-        }
         val clip = clipboardManager.primaryClip ?: return
         if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
             val timestamp = clip.description.timestamp
@@ -183,6 +202,7 @@ object ClipboardHelper :
     }
 
     private suspend fun removeOutdated() {
+        val limit = limitPref.getValue()
         val unpinned = clbDao.getAllUnpinned()
         if (unpinned.size > limit) {
             val outdated =

app/src/main/java/com/osfans/trime/data/prefs/AppPrefs.kt

@@ -241,34 +241,44 @@ class AppPrefs(
         shared: SharedPreferences,
     ) : PreferenceDelegateOwner(shared, R.string.clipboard) {
         companion object {
+            const val CLIPBOARD_LISTENING = "clipboard_listening"
             const val CLIPBOARD_LIMIT = "clipboard_clipboard_limit"
             const val CLIPBOARD_COMPARE_RULES = "clipboard_clipboard_compare"
             const val CLIPBOARD_OUTPUT_RULES = "clipboard_clipboard_output"
             const val CLIPBOARD_SUGGESTION = "clipboard_suggestion"
             const val CLIPBOARD_SUGGESTION_TIMEOUT = "clipboard_suggestion_timeout"
         }
-        val clipboardLimit = int(R.string.clipboard_limit, CLIPBOARD_LIMIT, 10)
+        val clipboardListening = switch(R.string.clipboard_listening, CLIPBOARD_LISTENING, true)
+        val clipboardLimit = int(
+            R.string.clipboard_limit,
+            CLIPBOARD_LIMIT,
+            10,
+        ) { clipboardListening.getValue() }
         val clipboardCompareRules = editText(
             R.string.clipboard_compare_rules,
             CLIPBOARD_COMPARE_RULES,
             "",
             R.string.a_regular_expression_per_line,
-        )
+        ) { clipboardListening.getValue() }
         val clipboardOutputRules = editText(
             R.string.clipboard_output_rules,
             CLIPBOARD_OUTPUT_RULES,
             "",
             R.string.a_regular_expression_per_line,
-        )
-        val clipboardSuggestion = switch(R.string.clipboard_suggestion, CLIPBOARD_SUGGESTION, true)
+        ) { clipboardListening.getValue() }
+        val clipboardSuggestion = switch(
+            R.string.clipboard_suggestion,
+            CLIPBOARD_SUGGESTION,
+            true,
+        ) { clipboardListening.getValue() }
         val clipboardSuggestionTimeout = int(
             R.string.clipboard_suggestion_timeout,
             CLIPBOARD_SUGGESTION_TIMEOUT,
             20,
             0,
             100,
             "s",
-        ) { clipboardSuggestion.getValue() }
+        ) { clipboardListening.getValue() && clipboardSuggestion.getValue() }
     }
 
     /**

app/src/main/res/values-zh-rCN/strings.xml

@@ -237,4 +237,5 @@ SPDX-License-Identifier: GPL-3.0-or-later
     <string name="restored_from_x">已从 %1$s 中还原</string>
     <string name="backup">备份</string>
     <string name="restore">还原</string>
+    <string name="clipboard_listening">记录剪贴板历史</string>
 </resources>

app/src/main/res/values-zh-rTW/strings.xml

@@ -238,4 +238,5 @@ SPDX-License-Identifier: GPL-3.0-or-later
     <string name="restored_from_x">已從 %1$s 還原</string>
     <string name="backup">備份</string>
     <string name="restore">還原</string>
+    <string name="clipboard_listening">監聽剪貼簿</string>
 </resources>

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

@@ -238,4 +238,5 @@ SPDX-License-Identifier: GPL-3.0-or-later
     <string name="restored_from_x">Restored from %1$s</string>
     <string name="backup">Backup</string>
     <string name="restore">Restore</string>
+    <string name="clipboard_listening">Clipboard listening</string>
 </resources>