Datasets:
DOI:
License:
Upload 60 files
Browse files
XPostArchiver-clean-upload-20260711-225630.zip
CHANGED
|
@@ -1,3 +1,3 @@
|
|
| 1 |
version https://git-lfs.github.com/spec/v1
|
| 2 |
-
oid sha256:
|
| 3 |
-
size
|
|
|
|
| 1 |
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:c2c29ca700975578757826008746be4af7600fb5f7c9b23c5d77b3e3262ca467
|
| 3 |
+
size 111588
|
XPostArchiver-clean-upload-20260711-225630/docs/12-维护接手文档.md
ADDED
|
@@ -0,0 +1,227 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# 维护接手文档
|
| 2 |
+
|
| 3 |
+
本文给后续接手维护本项目的 AI 或开发者阅读。目标是快速理解项目边界、技术栈、常用命令、目录职责和容易踩坑的地方。
|
| 4 |
+
|
| 5 |
+
## 一、项目定位
|
| 6 |
+
|
| 7 |
+
项目名:X公开帖子归档器。
|
| 8 |
+
|
| 9 |
+
内部英文标识:`XPostArchiver`。
|
| 10 |
+
|
| 11 |
+
项目路径:`<project-directory>`。
|
| 12 |
+
|
| 13 |
+
这是一个纯本地 Windows 桌面软件,使用 Rust + Slint。软件只通过官方 X API,在用户已有权限、额度和平台可访问范围内归档公开帖子。
|
| 14 |
+
|
| 15 |
+
禁止方向:
|
| 16 |
+
|
| 17 |
+
- 不模拟登录。
|
| 18 |
+
- 不收集 X 密码、Cookie 或浏览器会话。
|
| 19 |
+
- 不绕过验证码、保护账号、付费权限、访问控制或速率限制。
|
| 20 |
+
- 不使用 Python、JavaScript、TypeScript、Node.js、Electron、Tauri、WebView、Selenium、Playwright、Docker、云数据库或远程服务器。
|
| 21 |
+
|
| 22 |
+
## 二、开发环境
|
| 23 |
+
|
| 24 |
+
Rust 和 Cargo 使用 D 盘目录:
|
| 25 |
+
|
| 26 |
+
```powershell
|
| 27 |
+
$env:RUSTUP_HOME='<rustup-home>'
|
| 28 |
+
$env:CARGO_HOME='<cargo-home>'
|
| 29 |
+
$env:PATH='<cargo-home>\bin;'+$env:PATH
|
| 30 |
+
```
|
| 31 |
+
|
| 32 |
+
常用工作目录:
|
| 33 |
+
|
| 34 |
+
```powershell
|
| 35 |
+
Set-Location -LiteralPath '<project-directory>'
|
| 36 |
+
```
|
| 37 |
+
|
| 38 |
+
用户级 PATH 曾经有路径串联异常,所以维护时不要假设 `cargo` 一定在默认 PATH 中。优先显式设置上面的环境变量。
|
| 39 |
+
|
| 40 |
+
## 三、严格验收命令
|
| 41 |
+
|
| 42 |
+
每个阶段完成前必须跑:
|
| 43 |
+
|
| 44 |
+
```powershell
|
| 45 |
+
$ErrorActionPreference='Stop'
|
| 46 |
+
$env:RUSTUP_HOME='<rustup-home>'
|
| 47 |
+
$env:CARGO_HOME='<cargo-home>'
|
| 48 |
+
$env:PATH='<cargo-home>\bin;'+$env:PATH
|
| 49 |
+
Set-Location -LiteralPath '<project-directory>'
|
| 50 |
+
cargo fmt --all -- --check
|
| 51 |
+
if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE }
|
| 52 |
+
cargo check
|
| 53 |
+
if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE }
|
| 54 |
+
cargo clippy --all-targets --all-features -- -D warnings
|
| 55 |
+
if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE }
|
| 56 |
+
cargo test --all
|
| 57 |
+
if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE }
|
| 58 |
+
```
|
| 59 |
+
|
| 60 |
+
然后必须实际启动窗口:
|
| 61 |
+
|
| 62 |
+
```powershell
|
| 63 |
+
cargo run
|
| 64 |
+
```
|
| 65 |
+
|
| 66 |
+
用户确认窗口打开后,再更新 `PROJECT_STATE.md`、`CHANGELOG.md`,最后提交。
|
| 67 |
+
|
| 68 |
+
## 四、目录结构
|
| 69 |
+
|
| 70 |
+
主要目录和文件:
|
| 71 |
+
|
| 72 |
+
- `src/app.rs`:Slint 主窗口绑定和 UI 回调注册。
|
| 73 |
+
- `ui/app-window.slint`:主界面布局。
|
| 74 |
+
- `src/services/`:业务服务。
|
| 75 |
+
- `src/config/`:配置路径和设置。
|
| 76 |
+
- `src/database/`:数据库连接与迁移执行。
|
| 77 |
+
- `migrations/0001_initial.sql`:初始 SQLite schema。
|
| 78 |
+
- `tests/`:集成测试。
|
| 79 |
+
- `PROJECT_STATE.md`:当前项目状态,阶段完成后必须更新。
|
| 80 |
+
- `CHANGELOG.md`:变更记录,阶段完成后必须更新。
|
| 81 |
+
- `DECISIONS.md`:技术决策记录。
|
| 82 |
+
- `docs/`:设计、说明和维护文档。
|
| 83 |
+
- `backups/`:阶段修改前备份。
|
| 84 |
+
|
| 85 |
+
## 五、关键服务
|
| 86 |
+
|
| 87 |
+
### 凭据
|
| 88 |
+
|
| 89 |
+
文件:`src/services/credential_service.rs`
|
| 90 |
+
|
| 91 |
+
Bearer Token 保存到系统 keyring。不要写入普通配置文件、日志或数据库。
|
| 92 |
+
|
| 93 |
+
常量:
|
| 94 |
+
|
| 95 |
+
- `SERVICE_NAME = "XPostArchiver"`
|
| 96 |
+
- `BEARER_TOKEN_ACCOUNT = "x-api-bearer-token"`
|
| 97 |
+
|
| 98 |
+
### X API
|
| 99 |
+
|
| 100 |
+
文件:`src/services/x_api_service.rs`
|
| 101 |
+
|
| 102 |
+
默认 base URL:`https://api.x.com`。
|
| 103 |
+
|
| 104 |
+
测试使用 mock base URL,并有串行保护,避免并发测试互相污染。
|
| 105 |
+
|
| 106 |
+
### 采集任务
|
| 107 |
+
|
| 108 |
+
文件:`src/services/crawl_task_service.rs`
|
| 109 |
+
|
| 110 |
+
负责创建任务和列出最近任务。
|
| 111 |
+
|
| 112 |
+
任务状态存数据库时仍为英文内部值,UI 显示时转成中文。
|
| 113 |
+
|
| 114 |
+
### 帖子采集
|
| 115 |
+
|
| 116 |
+
文件:`src/services/post_fetch_service.rs`
|
| 117 |
+
|
| 118 |
+
负责按任务 ID 拉取公开帖子、保存帖子、保存分页游标、保存媒体元数据,并更新 `crawl_jobs` 计数。
|
| 119 |
+
|
| 120 |
+
X API 或网络失败时写回:
|
| 121 |
+
|
| 122 |
+
- `crawl_jobs.status = 'failed'`
|
| 123 |
+
- `error_count = error_count + 1`
|
| 124 |
+
- `last_error`
|
| 125 |
+
- `finished_at`
|
| 126 |
+
|
| 127 |
+
### 媒体下载
|
| 128 |
+
|
| 129 |
+
文件:`src/services/media_download_service.rs`
|
| 130 |
+
|
| 131 |
+
普通下载处理 `metadata_only` 状态;失败重试会处理 `metadata_only` 和 `failed` 状态。
|
| 132 |
+
|
| 133 |
+
下载成功后:
|
| 134 |
+
|
| 135 |
+
- `download_status = 'downloaded'`
|
| 136 |
+
- `local_relative_path`
|
| 137 |
+
- `downloaded_at`
|
| 138 |
+
- 清空 `last_error`
|
| 139 |
+
|
| 140 |
+
下载失败后:
|
| 141 |
+
|
| 142 |
+
- `download_status = 'failed'`
|
| 143 |
+
- `last_error`
|
| 144 |
+
|
| 145 |
+
### 归档预览和导出
|
| 146 |
+
|
| 147 |
+
文件:`src/services/archive_export_service.rs`
|
| 148 |
+
|
| 149 |
+
当前支持:
|
| 150 |
+
|
| 151 |
+
- 按任务 ID 预览最近帖子。
|
| 152 |
+
- 按任务 ID 导出最多 500 条帖子为 Markdown 文本索引。
|
| 153 |
+
|
| 154 |
+
导出目录来自用户设置的 `export_dir`。
|
| 155 |
+
|
| 156 |
+
## 六、UI 注意事项
|
| 157 |
+
|
| 158 |
+
Slint 主窗口文件:`ui/app-window.slint`。
|
| 159 |
+
|
| 160 |
+
当前窗口只设置:
|
| 161 |
+
|
| 162 |
+
- `min-width: 760px;`
|
| 163 |
+
- `min-height: 560px;`
|
| 164 |
+
|
| 165 |
+
不要同时设置固定 `width`/`height` 和 `min-width`/`min-height`。Slint 会报错:
|
| 166 |
+
|
| 167 |
+
- `Cannot specify both 'height' and 'min-height'`
|
| 168 |
+
- `Cannot specify both 'width' and 'min-width'`
|
| 169 |
+
|
| 170 |
+
Bearer Token 输入框必须保持:
|
| 171 |
+
|
| 172 |
+
```slint
|
| 173 |
+
input-type: InputType.password;
|
| 174 |
+
```
|
| 175 |
+
|
| 176 |
+
## 七、数据库维护注意事项
|
| 177 |
+
|
| 178 |
+
当前只有初始迁移 `0001_initial.sql`。如果后续已经有用户数据库,不要随意修改历史迁移。新增字段或表时,增加新的迁移文件。
|
| 179 |
+
|
| 180 |
+
涉及恢复、删除、覆盖数据库前必须先备份���
|
| 181 |
+
|
| 182 |
+
## 八、Git 和备份习惯
|
| 183 |
+
|
| 184 |
+
每个阶段修改前创建备份,例如:
|
| 185 |
+
|
| 186 |
+
```powershell
|
| 187 |
+
$stamp=Get-Date -Format 'yyyyMMdd-HHmmss'
|
| 188 |
+
$dest="backups\before-some-change-$stamp"
|
| 189 |
+
New-Item -ItemType Directory -Force -Path $dest | Out-Null
|
| 190 |
+
Copy-Item -Recurse -Force src,ui,migrations,tests,PROJECT_STATE.md,CHANGELOG.md,Cargo.toml,Cargo.lock,build.rs $dest
|
| 191 |
+
```
|
| 192 |
+
|
| 193 |
+
阶段完成后小提交。提交前确认 `git status --short`,不要把无关文件混进去。
|
| 194 |
+
|
| 195 |
+
## 九、最近关键提交
|
| 196 |
+
|
| 197 |
+
- `e8e4fca feat: mask bearer token input`
|
| 198 |
+
- `39c3741 feat: show crawl status labels and errors`
|
| 199 |
+
- `d46776e feat: preview and export archived posts`
|
| 200 |
+
- `c1676f0 feat: retry failed media and guard auto crawl`
|
| 201 |
+
|
| 202 |
+
## 十、当前可用能力摘要
|
| 203 |
+
|
| 204 |
+
当前版本已经可以:
|
| 205 |
+
|
| 206 |
+
- 新建/打开 SQLite 数据库并迁移。
|
| 207 |
+
- 选择归档内容、导出、日志、备份、临时目录。
|
| 208 |
+
- 保存或清除 X API Bearer Token 到系统 keyring。
|
| 209 |
+
- 遮罩 Bearer Token 输入框。
|
| 210 |
+
- 联网检查 Bearer Token。
|
| 211 |
+
- 查询公开账号并保存账号资料。
|
| 212 |
+
- 创建采集任务。
|
| 213 |
+
- 手动拉取下一页公开帖子。
|
| 214 |
+
- 后台自动连续采集。
|
| 215 |
+
- 停止自动采集。
|
| 216 |
+
- 防止自动采集重复启动。
|
| 217 |
+
- 显示中文任务状态和失败原因。
|
| 218 |
+
- 保存媒体元数据和帖子媒体关联。
|
| 219 |
+
- 下载待保存媒体。
|
| 220 |
+
- 重试失败媒体。
|
| 221 |
+
- 预览任务帖子。
|
| 222 |
+
- 导出 Markdown 文本索引。
|
| 223 |
+
|
| 224 |
+
## 十一、下一批推荐维护点
|
| 225 |
+
|
| 226 |
+
优先级建议见 `docs/11-后期优化路线.md`。最建议先做:真正可点击任务列表。
|
| 227 |
+
|