Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions .github/workflows/local-retention.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Local retention

on:
pull_request:
paths:
- 'electron/**'
- 'src/**'
- 'scripts/test-*-retention.cjs'
- 'scripts/test-sns-download.cjs'
- 'package*.json'
- 'tsconfig*.json'
- '.github/workflows/local-retention.yml'
push:
paths:
- 'electron/**'
- 'src/**'
- 'scripts/test-*-retention.cjs'
- 'scripts/test-sns-download.cjs'
- 'package*.json'
- 'tsconfig*.json'
- '.github/workflows/local-retention.yml'

permissions:
contents: read

jobs:
regression:
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest, windows-latest, macos-latest]
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v5
- uses: actions/setup-node@v5
with:
node-version: 24
cache: npm
- run: npm ci --ignore-scripts --legacy-peer-deps --no-audit --no-fund
- run: npm run test:retention
- run: npm run typecheck
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
## 主要功能

- 本地实时查看聊天记录
- 本地消息与朋友圈留存(需主动开启,见[使用说明](docs/local-retention.md))
- 朋友圈图片、视频、**实况**的预览和解密
- 统计分析与群聊画像
- 年度报告与可视化概览
Expand Down
54 changes: 54 additions & 0 deletions docs/local-retention.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# 本地消息与朋友圈留存

侧栏的「消息留存」和「朋友圈留存」用于保存独立的本地副本。两项功能默认关闭,分别由你主动开启;它们读取当前账号在本机可访问的内容,不修改微信源数据库,也不安装防撤回或防删除触发器。原有防撤回、防删除功能保持独立。

留存只能保住已经读到的内容:没有捕获到的消息、在首次读取前已经删除或不可见的朋友圈,无法靠留存恢复。它也不是手机或微信云端全部历史记录的备份。

## 使用前准备

1. 先完成 WeFlow 的数据库连接和账号选择,确认「聊天」或「朋友圈」能正常读取内容。图片等媒体还需要对应的[第三方组件](third-party-components.md)能够正常工作。
2. 保持微信和 WeFlow 运行。退出 WeFlow 后不会继续捕获;再次运行时只能读取仍在本机可用的内容。
3. 在对应留存页开启开关。关闭开关会停止后续留存,已有副本仍可查看。

## 消息留存

打开侧栏「消息留存」,开启「自动留存消息」。开始运行时会读取会话中近期可用的消息,之后持续检查更新,不会补齐全部历史聊天。

- **已留存原文**:消息在撤回前已被读到,会保留当时的副本。
- **未捕获原文**:只读到了撤回提示,原消息已经不可用。该条记录表示发现过撤回,不表示恢复了原文。
- **检测到撤回**:时间是 WeFlow 识别该提示的时间,可能晚于实际撤回时间;首次扫描也可能发现较早的撤回提示。

可用搜索查找会话、发送者或消息正文,也可勾选「只看撤回」。留存依赖扫描时机和数据库可读性,不能保证捕获每一条消息。

### 消息媒体范围

目前会尝试为可读取、可解密的本机图片,以及已有本地文件的表情保存独立副本。尚不保存视频、语音和附件的完整文件内容。看到了消息文字或类型提示,不代表对应媒体文件已经保存;以每条记录的媒体状态为准。

## 朋友圈留存

1. 在微信中打开、刷新朋友圈,让可见的新内容进入本机缓存;需要较早的动态时,也要先在微信中浏览到它们。
2. 打开侧栏「朋友圈留存」,开启「自动留存朋友圈」。首次整理会分批读取本机已经存在的动态。
3. 需要立即重新检查时,点击「立即扫描」。此按钮需要先开启自动留存;「刷新列表」不会重新扫描微信数据库。

文字通常会先出现,图片和视频在后台尝试保存。当前查看或搜索到的动态会优先处理媒体,但原件可能已过期、无法下载、格式不支持或超过大小限制,不能保证补齐。

动态正文、曾经读到的点赞和评论,以及不同读取结果的快照会独立留存。它们可能与微信当前显示不同;「最近读取」只是再次读到本机缓存的时间,不证明对方此刻仍公开这条动态。

### 朋友圈媒体状态

| 页面提示 | 含义 |
| --- | --- |
| 已保存图片/视频/实况照片 | 已有对应的本地原件副本;能否播放还取决于设备支持的格式。 |
| 仅保存缩略图 | 原件尚未保存,当前显示的是缩略图,不代表高清图片、完整视频或实况视频已经留存。 |
| 排队保存中 | 自动留存已开启,正在等待后台尝试;退出应用或关闭开关会暂停后续处理。 |
| 未保存 | 尚未获得可用文件,文字和其他成功保存的内容仍会保留。 |

顶部「已保存原件」只统计完整原件;「原件未保存」包括仅有缩略图的项目。视频和实况视频不会自动播放。当前每个朋友圈媒体文件的留存上限为 128 MiB。

朋友圈媒体可能需要从微信媒体服务下载,因此获取媒体时需要网络。归档页面的图片和视频预览仅使用归档内的本地副本,不会直接加载动态中的远程图片地址,也不会把正文作为 HTML 执行。

## 保存位置与备份

点击对应页面的「打开保存目录」即可查看当前账号的归档。不同账号的留存相互隔离,媒体是独立文件,不依赖原缓存一直存在。关闭留存不会清空已保存数据,归档也不会按时间自动过期。

留存文件可能包含可直接读取的消息、评论及媒体,请按自己的隐私需要保管和备份。自动留存不是磁盘备份;手动删除归档、卸载时清理应用数据或磁盘损坏,仍可能造成丢失。备份前先关闭两项留存并退出 WeFlow,再复制完整保存目录。
26 changes: 25 additions & 1 deletion electron/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ import { cloudControlService } from './services/cloudControlService'
import { destroyNotificationWindow, registerNotificationHandlers, showNotification, setNotificationNavigateHandler } from './windows/notificationWindow'
import { httpService } from './services/httpService'
import { messagePushService } from './services/messagePushService'
import { messageRetentionService } from './services/messageRetentionService'
import { snsRetentionService } from './services/snsRetentionService'
import { insightService } from './services/insightService'
import { insightRecordService } from './services/insightRecordService'
import { insightProfileService } from './services/insightProfileService'
Expand Down Expand Up @@ -2141,6 +2143,13 @@ const runLegacySnsCacheMigration = async (

// 注册 IPC 处理器
function registerIpcHandlers() {
ipcMain.handle('snsRetention:status', () => snsRetentionService.status())
ipcMain.handle('snsRetention:setEnabled', (_, enabled: boolean) => snsRetentionService.setEnabled(enabled === true))
ipcMain.handle('snsRetention:list', (_, options?: { query?: string; username?: string; limit?: number; offset?: number }) => snsRetentionService.list(options))
ipcMain.handle('snsRetention:scanNow', () => snsRetentionService.scanNow())
ipcMain.handle('messageRetention:status', () => messageRetentionService.status())
ipcMain.handle('messageRetention:setEnabled', (_, enabled: boolean) => messageRetentionService.setEnabled(enabled === true))
ipcMain.handle('messageRetention:list', (_, options?: { query?: string; onlyRevoked?: boolean; limit?: number; offset?: number }) => messageRetentionService.list(options))
const relayOneService = new RelayOneService(configService!)
registerNotificationHandlers()
ensureNotificationNavigateHandlerRegistered()
Expand All @@ -2164,6 +2173,8 @@ function registerIpcHandlers() {
applyAutoUpdateChannel('settings')
}
void messagePushService.handleConfigChanged(key)
messageRetentionService.handleConfigChanged(key)
snsRetentionService.handleConfigChanged(key)
void insightService.handleConfigChanged(key)
void groupSummaryService.handleConfigChanged(key)
if (['dbPath', 'decryptKey', 'myAccountId'].includes(key)) {
Expand Down Expand Up @@ -3027,6 +3038,8 @@ function registerIpcHandlers() {
}
configService?.clear()
messagePushService.handleConfigCleared()
messageRetentionService.handleConfigChanged('dbPath')
snsRetentionService.handleConfigChanged('dbPath')
insightService.handleConfigCleared()
groupSummaryService.handleConfigCleared()
snsService.clearMemoryCache()
Expand Down Expand Up @@ -4008,7 +4021,12 @@ function registerIpcHandlers() {
})

ipcMain.handle('sns:getTimeline', async (_, limit: number, offset: number, usernames?: string[], keyword?: string, startTime?: number, endTime?: number) => {
return snsService.getTimeline(limit, offset, usernames, keyword, startTime, endTime)
const accountScope = JSON.stringify([configService?.get('myAccountId'), configService?.get('dbPath')])
const result = await snsService.getTimeline(limit, offset, usernames, keyword, startTime, endTime)
if (result.success && result.timeline && accountScope === JSON.stringify([configService?.get('myAccountId'), configService?.get('dbPath')])) {
snsRetentionService.captureVisible(result.timeline)
}
return result
})

ipcMain.handle('sns:getSnsUsernames', async () => {
Expand Down Expand Up @@ -5568,6 +5586,8 @@ app.whenReady().then(async () => {
})
chatService.addDbMonitorListener((type, json) => {
messagePushService.handleDbMonitorChange(type, json)
messageRetentionService.handleDbMonitorChange(type, json)
snsRetentionService.handleDbMonitorChange(type, json)
insightService.handleDbMonitorChange(type, json)
})

Expand Down Expand Up @@ -5648,6 +5668,8 @@ app.whenReady().then(async () => {

// 依赖数据库的后台服务在窗口显示后再启动,避免与启动预热争抢数据库 worker
messagePushService.start()
messageRetentionService.start()
snsRetentionService.start()
insightService.start()
groupSummaryService.start()
if (configService.get('autoDownloadHighRes')) {
Expand Down Expand Up @@ -5687,6 +5709,8 @@ const shutdownAppServices = async (): Promise<void> => {
// 通知窗使用 hide 而非 close,退出时主动销毁,避免残留窗口阻塞进程退出。
destroyNotificationWindow()
messagePushService.stop()
messageRetentionService.stop()
snsRetentionService.stop()
insightService.stop()
groupSummaryService.stop()
// before-quit 不会等待后续 await,先同步落盘刚生成的语音转写。
Expand Down
11 changes: 11 additions & 0 deletions electron/preload.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,17 @@ type CloseConfirmPayload = {

// 暴露给渲染进程的 API
contextBridge.exposeInMainWorld('electronAPI', {
snsRetention: {
status: () => ipcRenderer.invoke('snsRetention:status'),
setEnabled: (enabled: boolean) => ipcRenderer.invoke('snsRetention:setEnabled', enabled),
list: (options?: { query?: string; username?: string; limit?: number; offset?: number }) => ipcRenderer.invoke('snsRetention:list', options),
scanNow: () => ipcRenderer.invoke('snsRetention:scanNow')
},
messageRetention: {
status: () => ipcRenderer.invoke('messageRetention:status'),
setEnabled: (enabled: boolean) => ipcRenderer.invoke('messageRetention:setEnabled', enabled),
list: (options?: { query?: string; onlyRevoked?: boolean; limit?: number; offset?: number }) => ipcRenderer.invoke('messageRetention:list', options)
},
// 配置
config: {
get: (key: string) => ipcRenderer.invoke('config:get', key),
Expand Down
4 changes: 4 additions & 0 deletions electron/services/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ interface ConfigSchema {
cachePath: string
lastOpenedDb: string
lastSession: string
messageRetentionEnabled: boolean
snsRetentionEnabled: boolean

// 界面相关
theme: 'light' | 'dark' | 'system'
Expand Down Expand Up @@ -229,6 +231,8 @@ export class ConfigService {
cachePath: '',
lastOpenedDb: '',
lastSession: '',
messageRetentionEnabled: false,
snsRetentionEnabled: false,
theme: 'system',
themeId: 'cloud-dancer',
language: 'zh-CN',
Expand Down
Loading
Loading