Repository navigation
Expand file tree
/
Copy pathdahi.patch
More file actions
4586 lines (4521 loc) · 184 KB
/
Copy pathdahi.patch
File metadata and controls
4586 lines (4521 loc) · 184 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
diff --git a/.github/workflows/build-dahi-apk.yml b/.github/workflows/build-dahi-apk.yml
new file mode 100755
index 0000000..d034338
--- /dev/null
+++ b/.github/workflows/build-dahi-apk.yml
@@ -0,0 +1,74 @@
+# SPDX-FileCopyrightText: 2026 Rime community
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+# 一键在 GitHub Actions 上编译「同文输入法大海版」(自用版)。
+# 用法:把本仓库(含本文件)推到自己的 GitHub 仓库,
+# 然后 Actions -> "Build Dahi Trime APK" -> Run workflow。
+# 编译完成后在本次运行的 Artifacts 中下载 APK。
+# 原生依赖(librime/OpenCC/...)由 script/fetch-dahi-deps.sh 按 v3.3.12 锁定版本自动拉取,
+# 因此**无需**一并上传 git 子模块;签名用自签名 keystore,构建时自动生成,**无需配置任何 Secrets**。
+
+name: Build Dahi Trime APK
+
+on:
+ workflow_dispatch:
+ push:
+ branches:
+ - develop
+ - main
+ - dahi
+
+env:
+ CI_NAME: Dahi Build
+
+jobs:
+ build:
+ runs-on: ubuntu-26.04
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v7
+ with:
+ submodules: false
+ fetch-depth: 0
+
+ - name: 拉取原生依赖(按 v3.3.12 锁定版本)
+ run: bash script/fetch-dahi-deps.sh
+
+ - name: Setup Java
+ uses: actions/setup-java@v6
+ with:
+ distribution: temurin
+ java-version: 25
+ cache: gradle
+
+ - name: Setup Android SDK
+ uses: android-actions/setup-android@v4
+
+ - name: Install CMake
+ run: |
+ sdkmanager --install "cmake;3.31.6"
+
+ - name: Generate self-signed keystore
+ run: |
+ keytool -genkeypair -v -keystore dahi.keystore -alias dahi \
+ -keyalg RSA -keysize 2048 -validity 10000 \
+ -storepass dahipass -keypass dahipass \
+ -dname "CN=Dahi Trime, OU=Dahi, O=Dahi, L=City, ST=State, C=CN"
+ B64=$(base64 -w0 dahi.keystore)
+ {
+ echo "keyBase64=$B64"
+ echo "storePassword=dahipass"
+ echo "keyAlias=dahi"
+ echo "keyPassword=dahipass"
+ } > keystore.properties
+
+ - name: Build release APKs
+ run: make release
+
+ - name: Upload APKs
+ uses: actions/upload-artifact@v4
+ with:
+ name: dahi-trime-apk
+ path: app/build/outputs/apk/release/*.apk
+ if-no-files-found: error
diff --git a/README-DAHI.md b/README-DAHI.md
new file mode 100755
index 0000000..1dbabe8
--- /dev/null
+++ b/README-DAHI.md
@@ -0,0 +1,130 @@
+# 同文输入法大海版(自用版)
+
+基于 [osfans/trime](https://github.com/osfans/trime) **v3.3.12**(tag `v3.3.12`,commit `e09ac711`)的定制源码。
+
+- **应用名**:同文输入法大海版
+- **包名(applicationId)**:`com.osfans.trime.dahi`
+- **原生库 namespace**:仍为 `com.osfans.trime`(保证与原版共存,且不改动内部类名)
+- **Rime 用户数据目录**:`/storage/emulated/0/Android/data/com.osfans.trime.dahi/files/rime`
+ (由 `getExternalFilesDir(null)/rime` 自动得出,随包名变化)
+
+> 因包名不同,本版本可**与原版同文、CatTrime、BiBi 版共存安装**,互不覆盖。
+
+---
+
+## 一、相对原版 v3.3.12 的改动
+
+### 【1】剪切板 / 收藏夹
+- **文字搜索**:两个列表均支持按子串过滤(SQL `LIKE` + Room `PagingSource`,与分页协同)。
+ 标题栏新增搜索按钮,点按展开输入框;退出即清空。
+- **自由拖动排序**:条目左侧新增拖拽把手,可上下拖动调整顺序并持久化
+ (新增 `orderIndex` 列 + 数据库迁移 4→5,排序统一为 `pinned DESC, orderIndex ASC, time DESC`)。
+- **收藏夹置顶**:把原本只在剪切板出现的「置顶/取消置顶」菜单项**同时**提供给收藏夹,
+ 行为与剪切板完全一致(含右下角图钉指示)。
+- 为避免搜索时对子集重排打乱整体顺序,搜索状态下自动禁用拖动排序。
+
+> 搜索框位于输入法自身窗口内,普通 `EditText` 无法直接接收同文键盘的提交文本,
+> 因此新增 `ClipboardSearchBridge`:搜索激活时,把 Rime 提交的文本重定向到搜索框;
+> 未激活时完全不拦截(零影响)。退格键亦被重定向用于删除搜索内容。
+
+### 【2】配置页「备份与还原」(**加密**)
+- 位置:设置 → 配置 → **备份与还原**(可参照截图 1 的样式)。
+- **备份**:可选择「首选项 / 剪切板数据 / 收藏夹数据」,导出前需**设置密码**。
+- **还原**:选择备份文件 → 输入密码 → 选择要还原的项 → 应用(会覆盖所选数据,有确认提示)。
+- **加密设计(隐私保护)**:导出内容**绝不明文落盘**。文件为二进制加密格式:
+ ```
+ magic(8B "DAHIBAK1") | version(1B) | salt(16B) | iv(12B) | AES-256-GCM(ciphertext + 16B tag)
+ ```
+ - 密钥:用户密码经 **PBKDF2-HMAC-SHA256**(低版本回退 SHA1)派生,**200000** 次迭代,256 bit;
+ - 加密:**AES-256-GCM** 认证加密(防未授权读取 + 防篡改);
+ - 即使备份文件被其它应用读取,也无法获得剪贴板/收藏夹/首选项明文。
+
+### 【3】「说点啥」语音输入联动
+在「常规」页新增 3 个开关(默认关闭,参照截图 2):
+1. **说点啥AIDL语音输入** — 通过 AIDL 调用「说点啥」的语音识别(需在其内开启“允许外部输入法联动(AIDL)”)。
+2. **录音时暂停其他媒体** — 录音时申请音频焦点,请求其它应用降低音量/暂停播放。
+3. **工具栏麦克风按钮** — 在工具栏显示麦克风按钮:点按开始录音,再次点按停止并上屏。
+
+行为:**长按带语音功能的空格键**(主题中 `long_click` 映射为 `VOICE_ASSIST`)或**工具栏麦克风**均可触发;
+识别结果经 `onPartial/onFinal` 回填 / 上屏。AIDL 客户端复用「说点啥」官方对接协议
+(显式组件 `com.brycewg.asrkb[.pro]` / `com.brycewg.asrkb.api.ExternalSpeechService`,
+描述符 `com.brycewg.asrkb.aidl.IExternalSpeechService` / `ISpeechCallback`)。
+
+### 【4】共存包名 / 应用名
+见文首。改动仅涉及 `applicationId` 与应用名资源,`namespace` 保持不变,尽量不影响其它设置。
+
+---
+
+## 二、如何编译出 APK
+
+本仓库**不含预编译 APK**。用下面任一方式生成 APK:
+
+### 方式 A:GitHub Actions「最小补丁包」(★最省事,推荐)
+见 `github-actions-kit/使用说明.md`。只需在 GitHub 新建一个仓库、上传 **2 个文件**
+(`dahi.patch` + 工作流 yml),点一下按钮即可出 APK。补丁应用到上游 v3.3.12,
+其子模块由 Actions 原生拉取,最稳、最不容易出错。
+
+### 方式 B:GitHub Actions(推送本仓库全量源码)
+1. 把本项目推送到你自己的 GitHub 仓库(用 GitHub Desktop 或 git,注意保留 `.github/` 等隐藏文件);
+2. 进入 **Actions → “Build Dahi Trime APK” → Run workflow**;
+3. 完成后在运行页面的 **Artifacts** 下载 `dahi-trime-apk`。
+ - 原生依赖由 `script/fetch-dahi-deps.sh` 按 v3.3.12 锁定版本自动拉取,**无需上传子模块**;
+ - 自动安装 CMake 3.31.6,并**自动生成自签名 keystore**,无需配置 Secrets。
+ - ⚠️ 若在 Windows 上解压源码:`app/data/rime/*` 与部分 `app/src/main/assets/shared/*`
+ 是**符号链接**,Windows 解压可能丢失;这种情况请改用方式 A。
+
+### 方式 C:本机编译
+```bash
+# 依赖:JDK 25、Android SDK(build-tools 36 / platform 36)、
+# NDK 28.0.13004108、CMake 3.31.6、git
+bash script/fetch-dahi-deps.sh # 拉取原生依赖(代替 git submodule update)
+./build-dahi.sh # 或 BUILD_ABI=arm64-v8a ./build-dahi.sh
+# 产物:app/build/outputs/apk/release/*.apk
+```
+> 现代手机安装 `arm64-v8a` 版本。
+
+---
+
+## 三、改动文件一览(相对原版 v3.3.12)
+
+**新增**
+- `app/src/main/java/com/osfans/trime/link/`:`AsrkbSpeechClient.kt`、`AsrkbExternalInputSession.kt`、
+ `AsrkbRecordingAudioFocusController.kt`、`AsrkbVoiceHoldSessionController.kt`、
+ `VoiceOverlayUiBridge.kt`、`MicPermissionActivity.kt`
+- `app/src/main/java/com/osfans/trime/ime/voice/WaveformView.kt`
+- `app/src/main/java/com/osfans/trime/ime/clipboard/ClipboardSearchBridge.kt`
+- `app/src/main/java/com/osfans/trime/data/backup/`:`BackupData.kt`、`BackupCrypto.kt`、
+ `BackupManager.kt`、`BackupRestoreDialog.kt`
+- `app/src/main/res/values{,-zh-rCN,-zh-rTW}/strings_dahi_voice.xml`
+- `app/src/main/res/values{,-zh-rCN,-zh-rTW}/strings_dahi_clipboard.xml`
+- `app/src/main/res/values{,-zh-rCN,-zh-rTW}/strings_dahi_backup.xml`
+- `app/src/main/res/drawable/ic_baseline_mic_24.xml`、`ic_baseline_stop_24.xml`、
+ `ic_baseline_drag_handle_24.xml`
+- `build-dahi.sh`、`.github/workflows/build-dahi-apk.yml`、`README-DAHI.md`
+
+**修改**
+- `app/build.gradle.kts`(applicationId)
+- `app/src/main/res/values*/strings.xml`(应用名)
+- `app/src/main/AndroidManifest.xml`(麦克风权限、BiBi `<queries>`、`MicPermissionActivity`)
+- `data/prefs/AppPrefs.kt`(常规页 3 个开关)
+- `ime/bar/InputBarDelegate.kt`、`ime/bar/ui/AlwaysUi.kt`(工具栏麦克风按钮)
+- `ime/keyboard/KeyView.kt`、`KeyboardView.kt`、`KeyboardWindow.kt`(长按空格 / 录音浮层)
+- `ime/core/TrimeInputMethodService.kt`(语音生命周期钩子 + 搜索框文本重定向)
+- `ime/clipboard/*`(搜索、拖动排序、置顶)
+- `data/db/*`(orderIndex 列、迁移、查询)
+- `ui/main/settings/ProfileSettingsFragment.kt`(备份与还原入口)
+
+---
+
+## 四、已知限制 / 需要留意的点
+
+1. **未能本地编译验证**:受沙箱磁盘/内存限制,本次改动**未经编译**,首次在 Actions 构建时可能需少量编译修正
+ (多为 import / API 签名层面)。
+2. **AIDL 事务码为硬编码**,与本仓库参照的「说点啥」协议版本绑定;若实机端「说点啥」版本不同,调用可能失败
+ (已用 try/catch + 提示兜底)。
+3. **工具栏麦克风开关切换后**如未立即生效,请按提示在键盘样式中切换主题再切回以刷新(与原版按钮刷新机制一致)。
+4. 备份/还原为**整体覆盖**所选数据,请在还原前确认。
+5. 波形图为去除三方依赖后的自绘实现,外观与原 fork 略有差异。
+
+## 五、许可
+沿用上游 GPL-3.0-or-later。
diff --git a/app/build.gradle.kts b/app/build.gradle.kts
index 395e00e..4a5630d 100644
--- a/app/build.gradle.kts
+++ b/app/build.gradle.kts
@@ -22,7 +22,8 @@ android {
buildToolsVersion = "36.0.0"
defaultConfig {
- applicationId = "com.osfans.trime"
+ // 共存包名:与原版同文(com.osfans.trime)可同时安装
+ applicationId = "com.osfans.trime.dahi"
minSdk = 21
targetSdk = 36
versionCode = 20260901
diff --git a/app/src/main/AndroidManifest.xml b/app/src/main/AndroidManifest.xml
index d0298d6..95ee344 100644
--- a/app/src/main/AndroidManifest.xml
+++ b/app/src/main/AndroidManifest.xml
@@ -10,7 +10,16 @@ SPDX-License-Identifier: GPL-3.0-or-later
xmlns:android="http://schemas.android.com/apk/res/android">
<uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED" />
<uses-permission android:name="android.permission.VIBRATE" />
+ <uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.POST_NOTIFICATIONS" />
+ <!-- 权限:访问说点啥外部语音服务(AIDL)(若目标包声明则需请求) -->
+ <uses-permission android:name="com.brycewg.asrkb.EXTERNAL_SPEECH" />
+ <uses-permission android:name="com.brycewg.asrkb.pro.EXTERNAL_SPEECH" />
+
+ <queries>
+ <package android:name="com.brycewg.asrkb" />
+ <package android:name="com.brycewg.asrkb.pro" />
+ </queries>
<application
android:name="com.osfans.trime.TrimeApplication"
@@ -83,6 +92,11 @@ SPDX-License-Identifier: GPL-3.0-or-later
android:theme="@style/Theme.DialogTheme"
android:windowSoftInputMode="stateAlwaysVisible|adjustPan" />
+ <!-- 说点啥语音输入:从输入法场景触发麦克风运行时权限弹窗 -->
+ <activity
+ android:name=".link.MicPermissionActivity"
+ android:exported="false" />
+
<!-- Using an activity alias to disable/enable the app icon in the launcher -->
<activity-alias
android:name="com.osfans.trime.MainLauncherAlias"
diff --git a/app/src/main/java/com/osfans/trime/data/backup/BackupCrypto.kt b/app/src/main/java/com/osfans/trime/data/backup/BackupCrypto.kt
new file mode 100755
index 0000000..273af55
--- /dev/null
+++ b/app/src/main/java/com/osfans/trime/data/backup/BackupCrypto.kt
@@ -0,0 +1,101 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Rime community
+ *
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ */
+
+package com.osfans.trime.data.backup
+
+import java.security.SecureRandom
+import javax.crypto.Cipher
+import javax.crypto.SecretKeyFactory
+import javax.crypto.spec.GCMParameterSpec
+import javax.crypto.spec.PBEKeySpec
+import javax.crypto.spec.SecretKeySpec
+
+/**
+ * 备份文件的加密封装。
+ *
+ * 文件格式(大端无关,按字节顺序):
+ * ```
+ * magic(8B) | version(1B) | salt(16B) | iv(12B) | AES-GCM(ciphertext + 16B tag)
+ * ```
+ *
+ * - magic 固定为 `DAHIBAK1`,用于快速识别本版本导出的加密备份;
+ * - 密钥由用户密码经 PBKDF2-HMAC-SHA256(回退 SHA1)派生,迭代 200000 次,256 bit;
+ * - 内容使用 AES-256-GCM 认证加密,附带认证标签,可同时防篡改与防未授权读取。
+ *
+ * 说明:本实现**不导出任何明文**,从设计上避免剪贴板/收藏夹/首选项内容被其它应用随意读取。
+ */
+object BackupCrypto {
+ private const val MAGIC = "DAHIBAK1"
+ private const val VERSION: Byte = 1
+ private const val SALT_LEN = 16
+ private const val IV_LEN = 12
+ private const val TAG_BITS = 128
+ private const val ITERATIONS = 200_000
+ private const val KEY_BITS = 256
+ private const val TRANSFORMATION = "AES/GCM/NoPadding"
+
+ private val random = SecureRandom()
+
+ /** 文件头后偏移量:magic + version。 */
+ private val HEADER_LEN = MAGIC.length + 1
+
+ fun isEncrypted(data: ByteArray): Boolean =
+ data.size > HEADER_LEN + SALT_LEN + IV_LEN &&
+ String(data, 0, MAGIC.length, Charsets.US_ASCII) == MAGIC
+
+ fun encrypt(
+ plain: ByteArray,
+ password: CharArray,
+ ): ByteArray {
+ val salt = ByteArray(SALT_LEN).also { random.nextBytes(it) }
+ val iv = ByteArray(IV_LEN).also { random.nextBytes(it) }
+ val cipher = Cipher.getInstance(TRANSFORMATION)
+ cipher.init(Cipher.ENCRYPT_MODE, deriveKey(password, salt), GCMParameterSpec(TAG_BITS, iv))
+ val cipherText = cipher.doFinal(plain)
+ return buildList {
+ add(MAGIC.toByteArray(Charsets.US_ASCII))
+ add(byteArrayOf(VERSION))
+ add(salt)
+ add(iv)
+ add(cipherText)
+ }.fold(ByteArray(0)) { acc, bytes -> acc + bytes }
+ }
+
+ fun decrypt(
+ data: ByteArray,
+ password: CharArray,
+ ): ByteArray {
+ require(isEncrypted(data)) { "Not a DAHI encrypted backup file" }
+ var offset = MAGIC.length
+ val fileVersion = data[offset]
+ offset += 1
+ require(fileVersion <= VERSION) { "Unsupported backup version: $fileVersion" }
+ val salt = data.copyOfRange(offset, offset + SALT_LEN)
+ offset += SALT_LEN
+ val iv = data.copyOfRange(offset, offset + IV_LEN)
+ offset += IV_LEN
+ val cipherText = data.copyOfRange(offset, data.size)
+ val cipher = Cipher.getInstance(TRANSFORMATION)
+ cipher.init(Cipher.DECRYPT_MODE, deriveKey(password, salt), GCMParameterSpec(TAG_BITS, iv))
+ return cipher.doFinal(cipherText)
+ }
+
+ private fun deriveKey(
+ password: CharArray,
+ salt: ByteArray,
+ ): SecretKeySpec {
+ // PBKDF2WithHmacSHA256 自 Android 8.0 起可用;更低版本回退到 SHA1。
+ val factory =
+ runCatching { SecretKeyFactory.getInstance("PBKDF2WithHmacSHA256") }
+ .getOrElse { SecretKeyFactory.getInstance("PBKDF2WithHmacSHA1") }
+ val spec = PBEKeySpec(password, salt, ITERATIONS, KEY_BITS)
+ return try {
+ SecretKeySpec(factory.generateSecret(spec).encoded, "AES")
+ } finally {
+ spec.clearPassword()
+ }
+ }
+}
diff --git a/app/src/main/java/com/osfans/trime/data/backup/BackupData.kt b/app/src/main/java/com/osfans/trime/data/backup/BackupData.kt
new file mode 100755
index 0000000..2afc7d1
--- /dev/null
+++ b/app/src/main/java/com/osfans/trime/data/backup/BackupData.kt
@@ -0,0 +1,50 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Rime community
+ *
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ */
+
+package com.osfans.trime.data.backup
+
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.json.JsonElement
+
+/**
+ * 备份数据模型。
+ *
+ * 出于隐私考虑,序列化后的明文 JSON 在落盘/导出前会整体加密(见 [BackupCrypto]),
+ * 因此磁盘上的备份文件不会以明文形式暴露剪贴板、收藏夹或首选项内容。
+ */
+@Serializable
+data class BackupData(
+ val format: String = FORMAT,
+ val version: Int = CURRENT_VERSION,
+ val timestamp: Long = System.currentTimeMillis(),
+ val appVersion: String? = null,
+ val preferences: Map<String, BackupPreference>? = null,
+ val clipboard: List<BackupBean>? = null,
+ val collection: List<BackupBean>? = null,
+) {
+ companion object {
+ const val FORMAT = "dahi-trime-backup"
+ const val CURRENT_VERSION = 1
+ }
+}
+
+/** 单条偏好设置:[type] 为存储类型名,[value] 为对应的 JSON 值。 */
+@Serializable
+data class BackupPreference(
+ val type: String,
+ val value: JsonElement,
+)
+
+/** 剪贴板/收藏夹条目。 */
+@Serializable
+data class BackupBean(
+ val text: String? = null,
+ val html: String? = null,
+ val type: String = "TEXT",
+ val time: Long = 0L,
+ val pinned: Boolean = false,
+ val orderIndex: Int = 0,
+)
diff --git a/app/src/main/java/com/osfans/trime/data/backup/BackupManager.kt b/app/src/main/java/com/osfans/trime/data/backup/BackupManager.kt
new file mode 100755
index 0000000..5f1c8e4
--- /dev/null
+++ b/app/src/main/java/com/osfans/trime/data/backup/BackupManager.kt
@@ -0,0 +1,124 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Rime community
+ *
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ */
+
+package com.osfans.trime.data.backup
+
+import androidx.core.content.edit
+import androidx.preference.PreferenceManager
+import com.osfans.trime.BuildConfig
+import com.osfans.trime.data.db.ClipboardHelper
+import com.osfans.trime.data.db.CollectionHelper
+import com.osfans.trime.data.db.DatabaseBean
+import com.osfans.trime.util.appContext
+import kotlinx.serialization.encodeToString
+import kotlinx.serialization.json.Json
+import kotlinx.serialization.json.JsonArray
+import kotlinx.serialization.json.JsonPrimitive
+import kotlinx.serialization.json.boolean
+import kotlinx.serialization.json.contentOrNull
+import kotlinx.serialization.json.float
+import kotlinx.serialization.json.int
+import kotlinx.serialization.json.jsonArray
+import kotlinx.serialization.json.jsonPrimitive
+import kotlinx.serialization.json.long
+
+/**
+ * 备份/还原的核心逻辑:收集首选项、剪贴板与收藏夹数据,并以加密方式编码/解码。
+ */
+object BackupManager {
+ private val json =
+ Json {
+ prettyPrint = true
+ encodeDefaults = true
+ ignoreUnknownKeys = true
+ }
+
+ suspend fun createBackup(
+ includePreferences: Boolean,
+ includeClipboard: Boolean,
+ includeCollection: Boolean,
+ ): BackupData =
+ BackupData(
+ timestamp = System.currentTimeMillis(),
+ appVersion = BuildConfig.BUILD_VERSION_NAME,
+ preferences = if (includePreferences) exportPreferences() else null,
+ clipboard = if (includeClipboard) ClipboardHelper.exportBeans().map { it.toBackupBean() } else null,
+ collection = if (includeCollection) CollectionHelper.exportBeans().map { it.toBackupBean() } else null,
+ )
+
+ fun encode(
+ data: BackupData,
+ password: CharArray,
+ ): ByteArray = BackupCrypto.encrypt(json.encodeToString(data).toByteArray(Charsets.UTF_8), password)
+
+ fun decode(
+ bytes: ByteArray,
+ password: CharArray,
+ ): BackupData = json.decodeFromString(BackupCrypto.decrypt(bytes, password).toString(Charsets.UTF_8))
+
+ suspend fun applyBackup(
+ data: BackupData,
+ restorePreferences: Boolean,
+ restoreClipboard: Boolean,
+ restoreCollection: Boolean,
+ ) {
+ if (restorePreferences) data.preferences?.let { importPreferences(it) }
+ if (restoreClipboard) data.clipboard?.let { beans -> ClipboardHelper.restoreBeans(beans.map { it.toBean() }) }
+ if (restoreCollection) data.collection?.let { beans -> CollectionHelper.restoreBeans(beans.map { it.toBean() }) }
+ }
+
+ private fun exportPreferences(): Map<String, BackupPreference> {
+ val shared = PreferenceManager.getDefaultSharedPreferences(appContext)
+ val result = linkedMapOf<String, BackupPreference>()
+ shared.all.forEach { (key, value) ->
+ when (value) {
+ is Boolean -> result[key] = BackupPreference("BOOLEAN", JsonPrimitive(value))
+ is Int -> result[key] = BackupPreference("INT", JsonPrimitive(value))
+ is Long -> result[key] = BackupPreference("LONG", JsonPrimitive(value))
+ is Float -> result[key] = BackupPreference("FLOAT", JsonPrimitive(value))
+ is String -> result[key] = BackupPreference("STRING", JsonPrimitive(value))
+ is Set<*> ->
+ result[key] =
+ BackupPreference("STRING_SET", JsonArray(value.map { JsonPrimitive(it.toString()) }))
+ }
+ }
+ return result
+ }
+
+ private fun importPreferences(preferences: Map<String, BackupPreference>) {
+ val shared = PreferenceManager.getDefaultSharedPreferences(appContext)
+ shared.edit {
+ preferences.forEach { (key, pref) ->
+ runCatching {
+ when (pref.type) {
+ "BOOLEAN" -> putBoolean(key, pref.value.jsonPrimitive.boolean)
+ "INT" -> putInt(key, pref.value.jsonPrimitive.int)
+ "LONG" -> putLong(key, pref.value.jsonPrimitive.long)
+ "FLOAT" -> putFloat(key, pref.value.jsonPrimitive.float)
+ "STRING" -> putString(key, pref.value.jsonPrimitive.contentOrNull)
+ "STRING_SET" ->
+ putStringSet(
+ key,
+ pref.value.jsonArray.mapNotNull { it.jsonPrimitive.contentOrNull }.toSet(),
+ )
+ }
+ }
+ }
+ }
+ }
+
+ private fun DatabaseBean.toBackupBean() = BackupBean(text, html, type.name, time, pinned, orderIndex)
+
+ private fun BackupBean.toBean() =
+ DatabaseBean(
+ text = text,
+ html = html,
+ type = runCatching { DatabaseBean.BeanType.valueOf(type) }.getOrDefault(DatabaseBean.BeanType.TEXT),
+ time = time,
+ pinned = pinned,
+ orderIndex = orderIndex,
+ )
+}
diff --git a/app/src/main/java/com/osfans/trime/data/backup/BackupRestoreDialog.kt b/app/src/main/java/com/osfans/trime/data/backup/BackupRestoreDialog.kt
new file mode 100755
index 0000000..1afb760
--- /dev/null
+++ b/app/src/main/java/com/osfans/trime/data/backup/BackupRestoreDialog.kt
@@ -0,0 +1,281 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Rime community
+ *
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ */
+
+package com.osfans.trime.data.backup
+
+import android.net.Uri
+import android.text.InputType
+import android.view.ViewGroup
+import android.widget.EditText
+import android.widget.FrameLayout
+import androidx.activity.result.ActivityResultLauncher
+import androidx.activity.result.contract.ActivityResultContracts
+import androidx.annotation.StringRes
+import androidx.appcompat.app.AlertDialog
+import androidx.fragment.app.Fragment
+import androidx.lifecycle.lifecycleScope
+import com.osfans.trime.R
+import com.osfans.trime.ui.common.withLoadingDialog
+import com.osfans.trime.util.toast
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.launch
+import kotlinx.coroutines.withContext
+
+/**
+ * 设置页「备份与还原」的交互入口。
+ *
+ * 备份文件始终为加密格式(见 [BackupCrypto]),导出前需由用户设置密码;
+ * 还原时需输入密码解密。任何情况下都不会导出明文。
+ */
+class BackupRestoreDialog(
+ private val fragment: Fragment,
+) {
+ companion object {
+ private const val MIME = "application/octet-stream"
+ }
+
+ private lateinit var saveLauncher: ActivityResultLauncher<String>
+ private lateinit var openLauncher: ActivityResultLauncher<Array<String>>
+
+ private var backupInProgress = false
+ private var restoreInProgress = false
+
+ /** 已加密、待写入用户所选文件的字节。 */
+ private var pendingBackupBytes: ByteArray? = null
+
+ fun setupLaunchers() {
+ saveLauncher =
+ fragment.registerForActivityResult(ActivityResultContracts.CreateDocument(MIME)) { uri ->
+ if (uri != null) handleBackupSave(uri)
+ }
+ openLauncher =
+ fragment.registerForActivityResult(ActivityResultContracts.OpenDocument()) { uri ->
+ if (uri != null) handleRestoreOpen(uri)
+ }
+ }
+
+ fun showBackupDialog() {
+ if (backupInProgress) return
+ val ctx = fragment.requireContext()
+ val items =
+ arrayOf(
+ ctx.getString(R.string.dahi_backup_pref),
+ ctx.getString(R.string.dahi_backup_clipboard),
+ ctx.getString(R.string.dahi_backup_collection),
+ )
+ val checked = booleanArrayOf(true, true, true)
+ AlertDialog
+ .Builder(ctx)
+ .setTitle(R.string.dahi_backup_select_items)
+ .setMultiChoiceItems(items, checked) { _, which, isChecked ->
+ checked[which] = isChecked
+ }.setNegativeButton(android.R.string.cancel, null)
+ .setPositiveButton(android.R.string.ok) { _, _ ->
+ if (!checked.any { it }) {
+ ctx.toast(R.string.dahi_backup_empty_selection)
+ return@setPositiveButton
+ }
+ askPassword(R.string.dahi_backup_set_password) { password ->
+ performBackup(checked[0], checked[1], checked[2], password)
+ }
+ }.show()
+ }
+
+ fun showRestoreDialog() {
+ if (restoreInProgress) return
+ openLauncher.launch(arrayOf(MIME, "application/octet-stream", "*/*"))
+ }
+
+ private fun performBackup(
+ includePreferences: Boolean,
+ includeClipboard: Boolean,
+ includeCollection: Boolean,
+ password: CharArray,
+ ) {
+ if (backupInProgress) return
+ backupInProgress = true
+ val ctx = fragment.requireContext()
+ fragment.lifecycleScope.launch {
+ var encrypted: ByteArray? = null
+ runCatching {
+ withLoadingDialog(ctx) {
+ withContext(Dispatchers.IO) {
+ val data =
+ BackupManager.createBackup(
+ includePreferences = includePreferences,
+ includeClipboard = includeClipboard,
+ includeCollection = includeCollection,
+ )
+ encrypted = BackupManager.encode(data, password)
+ }
+ }
+ }
+ val bytes = encrypted
+ if (bytes == null) {
+ ctx.toast(R.string.dahi_backup_failure)
+ backupInProgress = false
+ return@launch
+ }
+ pendingBackupBytes = bytes
+ saveLauncher.launch("trime_dahi_backup_${System.currentTimeMillis()}.dahibak")
+ }
+ }
+
+ private fun handleBackupSave(uri: Uri) {
+ val data = pendingBackupBytes
+ pendingBackupBytes = null
+ val ctx = fragment.requireContext()
+ if (data == null) {
+ ctx.toast(R.string.dahi_backup_failure)
+ backupInProgress = false
+ return
+ }
+ fragment.lifecycleScope.launch {
+ val ok =
+ withContext(Dispatchers.IO) {
+ runCatching {
+ ctx.contentResolver.openOutputStream(uri)?.use { it.write(data) }
+ ?: error("No output stream for uri")
+ }.isSuccess
+ }
+ ctx.toast(if (ok) R.string.dahi_backup_success else R.string.dahi_backup_failure)
+ backupInProgress = false
+ }
+ }
+
+ private fun handleRestoreOpen(uri: Uri) {
+ if (restoreInProgress) return
+ val ctx = fragment.requireContext()
+ fragment.lifecycleScope.launch {
+ val bytes =
+ withContext(Dispatchers.IO) {
+ runCatching {
+ ctx.contentResolver.openInputStream(uri)?.use { it.readBytes() }
+ }.getOrNull()
+ }
+ if (bytes == null || bytes.isEmpty() || !BackupCrypto.isEncrypted(bytes)) {
+ ctx.toast(R.string.dahi_restore_invalid_file)
+ return@launch
+ }
+ askPassword(R.string.dahi_backup_enter_password) { password ->
+ performRestore(bytes, password)
+ }
+ }
+ }
+
+ private fun performRestore(
+ bytes: ByteArray,
+ password: CharArray,
+ ) {
+ restoreInProgress = true
+ val ctx = fragment.requireContext()
+ fragment.lifecycleScope.launch {
+ var decoded: BackupData? = null
+ runCatching {
+ withLoadingDialog(ctx) {
+ withContext(Dispatchers.IO) {
+ decoded = BackupManager.decode(bytes, password)
+ }
+ }
+ }
+ val data = decoded
+ if (data == null) {
+ ctx.toast(R.string.dahi_restore_wrong_password)
+ restoreInProgress = false
+ return@launch
+ }
+ showRestoreItems(data)
+ }
+ }
+
+ private fun showRestoreItems(data: BackupData) {
+ val ctx = fragment.requireContext()
+ val items =
+ arrayOf(
+ ctx.getString(R.string.dahi_backup_pref),
+ ctx.getString(R.string.dahi_backup_clipboard),
+ ctx.getString(R.string.dahi_backup_collection),
+ )
+ val available =
+ booleanArrayOf(
+ data.preferences != null,
+ data.clipboard != null,
+ data.collection != null,
+ )
+ val checked = available.copyOf()
+ AlertDialog
+ .Builder(ctx)
+ .setTitle(R.string.dahi_restore_select_items)
+ .setMessage(R.string.dahi_restore_replace_warning)
+ .setMultiChoiceItems(items, checked) { _, which, isChecked ->
+ checked[which] = isChecked
+ }.setNegativeButton(android.R.string.cancel, null)
+ .setPositiveButton(android.R.string.ok) { _, _ ->
+ val restorePref = checked[0] && available[0]
+ val restoreClip = checked[1] && available[1]
+ val restoreColl = checked[2] && available[2]
+ if (!(restorePref || restoreClip || restoreColl)) {
+ ctx.toast(R.string.dahi_backup_empty_selection)
+ return@setPositiveButton
+ }
+ applyRestore(data, restorePref, restoreClip, restoreColl)
+ }.show()
+ }
+
+ private fun applyRestore(
+ data: BackupData,
+ restorePreferences: Boolean,
+ restoreClipboard: Boolean,
+ restoreCollection: Boolean,
+ ) {
+ val ctx = fragment.requireContext()
+ fragment.lifecycleScope.launch {
+ val ok =
+ runCatching {
+ withLoadingDialog(ctx) {
+ withContext(Dispatchers.IO) {
+ BackupManager.applyBackup(data, restorePreferences, restoreClipboard, restoreCollection)
+ }
+ }
+ }.isSuccess
+ ctx.toast(if (ok) R.string.dahi_restore_success else R.string.dahi_restore_failure)
+ restoreInProgress = false
+ }
+ }
+
+ private fun askPassword(
+ @StringRes title: Int,
+ onPassword: (CharArray) -> Unit,
+ ) {
+ val ctx = fragment.requireContext()
+ val input =
+ EditText(ctx).apply {
+ inputType = InputType.TYPE_CLASS_TEXT or InputType.TYPE_TEXT_VARIATION_PASSWORD
+ hint = ctx.getString(R.string.dahi_backup_password_hint)
+ setSingleLine()
+ }
+ val margin = (24 * ctx.resources.displayMetrics.density).toInt()
+ val container =
+ FrameLayout(ctx).apply {
+ addView(
+ input,
+ FrameLayout.LayoutParams(
+ ViewGroup.LayoutParams.MATCH_PARENT,
+ ViewGroup.LayoutParams.WRAP_CONTENT,
+ ).apply { setMargins(margin, 0, margin, 0) },
+ )
+ }
+ AlertDialog
+ .Builder(ctx)
+ .setTitle(title)
+ .setView(container)
+ .setNegativeButton(android.R.string.cancel, null)
+ .setPositiveButton(android.R.string.ok) { _, _ ->
+ val text = input.text?.toString().orEmpty()
+ if (text.isNotEmpty()) onPassword(text.toCharArray())
+ }.show()
+ }
+}
diff --git a/app/src/main/java/com/osfans/trime/data/db/ClipboardHelper.kt b/app/src/main/java/com/osfans/trime/data/db/ClipboardHelper.kt
index 0c0bfa8..b2b4d2c 100644
--- a/app/src/main/java/com/osfans/trime/data/db/ClipboardHelper.kt
+++ b/app/src/main/java/com/osfans/trime/data/db/ClipboardHelper.kt
@@ -102,7 +102,7 @@ object ClipboardHelper :
clbDb =
Room
.databaseBuilder(context, Database::class.java, "clipboard.db")
- .addMigrations(Database.MIGRATION_3_4)
+ .addMigrations(Database.MIGRATION_3_4, Database.MIGRATION_4_5)
.build()
clbDao = clbDb.databaseDao()
enabledListener.onChange(enabledPref.key, enabledPref.getValue())
@@ -118,6 +118,30 @@ object ClipboardHelper :
fun allBeans() = clbDao.allBeans()
+ /** 导出全部条目(用于加密备份)。 */
+ suspend fun exportBeans(): List<DatabaseBean> = clbDao.getAll()
+
+ /** 用备份数据整体替换当前条目(还原)。 */
+ suspend fun restoreBeans(beans: List<DatabaseBean>) {
+ clbDb.withTransaction {
+ clbDao.deleteAll()
+ clbDao.insertAll(beans)
+ }
+ updateItemCount()
+ }
+
+ fun searchBeans(query: String) = clbDao.searchBeans(query)
+
+ /**
+ * 持久化手动排序结果,[beans] 需按目标顺序排列,
+ * 其 orderIndex 以列表下标重新写入数据库。
+ */
+ suspend fun updateOrder(beans: List<DatabaseBean>) {
+ clbDb.withTransaction {
+ beans.forEach { clbDao.updateOrderIndex(it.id, it.orderIndex) }
+ }
+ }
+
suspend fun pin(id: Int) = clbDao.updatePinned(id, true)
suspend fun unpin(id: Int) = clbDao.updatePinned(id, false)
diff --git a/app/src/main/java/com/osfans/trime/data/db/CollectionHelper.kt b/app/src/main/java/com/osfans/trime/data/db/CollectionHelper.kt
index 3deaa1d..2dda893 100644
--- a/app/src/main/java/com/osfans/trime/data/db/CollectionHelper.kt
+++ b/app/src/main/java/com/osfans/trime/data/db/CollectionHelper.kt
@@ -28,7 +28,7 @@ object CollectionHelper : CoroutineScope by CoroutineScope(SupervisorJob() + Dis
cltDb =
Room
.databaseBuilder(context, Database::class.java, "collection.db")
- .addMigrations(Database.MIGRATION_3_4)
+ .addMigrations(Database.MIGRATION_3_4, Database.MIGRATION_4_5)
.build()
cltDao = cltDb.databaseDao()
}
@@ -41,6 +41,26 @@ object CollectionHelper : CoroutineScope by CoroutineScope(SupervisorJob() + Dis
fun allBeans() = cltDao.allBeans()
+ /** 导出全部条目(用于加密备份)。 */
+ suspend fun exportBeans(): List<DatabaseBean> = cltDao.getAll()
+
+ /** 用备份数据整体替换当前条目(还原)。 */
+ suspend fun restoreBeans(beans: List<DatabaseBean>) {
+ cltDb.withTransaction {
+ cltDao.deleteAll()
+ cltDao.insertAll(beans)
+ }
+ }
+
+ fun searchBeans(query: String) = cltDao.searchBeans(query)
+
+ /** 持久化手动排序结果,[beans] 需按目标顺序排列。 */
+ suspend fun updateOrder(beans: List<DatabaseBean>) {
+ cltDb.withTransaction {
+ beans.forEach { cltDao.updateOrderIndex(it.id, it.orderIndex) }
+ }
+ }
+
suspend fun pin(id: Int) = cltDao.updatePinned(id, true)
suspend fun unpin(id: Int) = cltDao.updatePinned(id, false)
diff --git a/app/src/main/java/com/osfans/trime/data/db/Database.kt b/app/src/main/java/com/osfans/trime/data/db/Database.kt
index d72efe9..e7e5cc6 100644
--- a/app/src/main/java/com/osfans/trime/data/db/Database.kt
+++ b/app/src/main/java/com/osfans/trime/data/db/Database.kt
@@ -10,7 +10,7 @@ import androidx.room.TypeConverters
import androidx.room.migration.Migration
import androidx.sqlite.db.SupportSQLiteDatabase
-@Database(entities = [DatabaseBean::class], version = 4)
+@Database(entities = [DatabaseBean::class], version = 5)
@TypeConverters(DatabaseBean.Converters::class)
abstract class Database : RoomDatabase() {
abstract fun databaseDao(): DatabaseDao
@@ -44,5 +44,18 @@ abstract class Database : RoomDatabase() {
}
}
}
+
+ val MIGRATION_4_5 =
+ object : Migration(4, 5) {
+ override fun migrate(database: SupportSQLiteDatabase) {
+ if (database.needUpgrade(5)) {
+ // 新增手动排序索引列;既有数据默认 0,回落到 time DESC,保持原有排序。
+ database.execSQL(
+ "ALTER TABLE ${DatabaseBean.TABLE_NAME} " +
+ "ADD COLUMN orderIndex INTEGER NOT NULL DEFAULT 0",
+ )
+ }
+ }
+ }
}
}
diff --git a/app/src/main/java/com/osfans/trime/data/db/DatabaseBean.kt b/app/src/main/java/com/osfans/trime/data/db/DatabaseBean.kt
index ccd8f18..3970f01 100644
--- a/app/src/main/java/com/osfans/trime/data/db/DatabaseBean.kt
+++ b/app/src/main/java/com/osfans/trime/data/db/DatabaseBean.kt
@@ -20,6 +20,11 @@ data class DatabaseBean(
val type: BeanType = BeanType.TEXT,
val time: Long = System.currentTimeMillis(),
val pinned: Boolean = false,
+ /**
+ * 手动排序索引(自由排序)。默认 0,此时回落到按 [time] 降序排列;
+ * 排序规则统一为 `pinned DESC, orderIndex ASC, time DESC`。
+ */
+ val orderIndex: Int = 0,
) {
companion object {
const val TABLE_NAME = "t_data"
diff --git a/app/src/main/java/com/osfans/trime/data/db/DatabaseDao.kt b/app/src/main/java/com/osfans/trime/data/db/DatabaseDao.kt
index d643496..ebfce73 100644
--- a/app/src/main/java/com/osfans/trime/data/db/DatabaseDao.kt
+++ b/app/src/main/java/com/osfans/trime/data/db/DatabaseDao.kt
@@ -38,6 +38,12 @@ interface DatabaseDao {
timestamp: Long,
)
+ @Query("UPDATE ${DatabaseBean.TABLE_NAME} SET orderIndex=:orderIndex WHERE id=:id")
+ suspend fun updateOrderIndex(
+ id: Int,
+ orderIndex: Int,
+ )
+
@Delete
suspend fun delete(bean: DatabaseBean)
@@ -59,9 +65,12 @@ interface DatabaseDao {
@Query("DELETE FROM ${DatabaseBean.TABLE_NAME} WHERE time<:timestamp AND pinned=0")
suspend fun deletedUnpinnedEarlierThan(timestamp: Long)
- @Query("SELECT * FROM ${DatabaseBean.TABLE_NAME} ORDER BY pinned DESC, time DESC")
+ @Query("SELECT * FROM ${DatabaseBean.TABLE_NAME} ORDER BY pinned DESC, orderIndex ASC, time DESC")
fun allBeans(): PagingSource<Int, DatabaseBean>