mirror of
https://github.com/truewhile/MeBox.git
synced 2026-11-13 19:54:23 +08:00
Compare commits
231 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 048a287315 | |||
| 9f702d9dba | |||
| 96bce1d551 | |||
| 54de991097 | |||
| bf639b5132 | |||
| 5820eacd9a | |||
| 31a31fef03 | |||
| 0a46a3278a | |||
| 4f032e7a56 | |||
| 117e0927e6 | |||
| 94387ea3d7 | |||
| 16582c6098 | |||
| e507ec2333 | |||
| 555a2dcad0 | |||
| dfdcc40128 | |||
| 7de3e58ca3 | |||
| c19c48b737 | |||
| db097a07b0 | |||
| 0e2781aa6e | |||
| f71388b3a9 | |||
| f8c60ce661 | |||
| 9d9d7f6e5c | |||
| 3ea8ef6b38 | |||
| 6e3742b8bd | |||
| 508f01c2e9 | |||
| f5501a7db1 | |||
| 58b3165be1 | |||
| 412c63b79a | |||
| dff5018511 | |||
| a81a3323fb | |||
| 612f57d295 | |||
| 884e8142d0 | |||
| f5c6c1cc50 | |||
| 7dff9439fa | |||
| 95ee8310ee | |||
| 8f2c6a77ba | |||
| 3a597cd169 | |||
| bee57f5039 | |||
| c1d8616999 | |||
| 52b4944d06 | |||
| d1eb0512f2 | |||
| ce6252fecd | |||
| 8c022712e0 | |||
| 565fceb090 | |||
| 5d8d26107b | |||
| 5fb456943f | |||
| c80d721686 | |||
| 8e2ec535ba | |||
| a435a8b57d | |||
| 6b256cb8d4 | |||
| d9daddda10 | |||
| e16a62c96c | |||
| 149311d3ad | |||
| 74a89d4665 | |||
| e24ef30db9 | |||
| fb6ce67ddc | |||
| ea3a49e760 | |||
| bad0f91360 | |||
| 80b977696e | |||
| d6059e65d7 | |||
| 5775a30620 | |||
| 3e34261d49 | |||
| 0d2f3eb639 | |||
| c56263fd57 | |||
| 9c36d30b3b | |||
| 31cc83c081 | |||
| 413121fc21 | |||
| e4b5035a6a | |||
| 6b994b1230 | |||
| 66448c40ac | |||
| c322033642 | |||
| 2ffc4ab306 | |||
| a96494403f | |||
| 289dc2aefe | |||
| cbc5e76b03 | |||
| f94d280b0b | |||
| 5c28233257 | |||
| 695d0d2b36 | |||
| 8c49d13cff | |||
| 4ee829de8e | |||
| a7233eb3a0 | |||
| 66a4ae3bc3 | |||
| 3ee2cfac9f | |||
| f160387e95 | |||
| 30406e2945 | |||
| a5c8b44c4b | |||
| eda1e805ef | |||
| 28d285e8b8 | |||
| d75a1c4248 | |||
| a78041f278 | |||
| d66ae70254 | |||
| 4ceacf84fd | |||
| 7808747414 | |||
| 36a21ce02f | |||
| 52e77c18b4 | |||
| 2f877abd66 | |||
| 5c685a92ee | |||
| 3a86a46b3a | |||
| 2a095b6242 | |||
| 130c44bc53 | |||
| 38a65f2ef9 | |||
| 295e23cb79 | |||
| 6e32d9c1b2 | |||
| 2514e9f208 | |||
| 76c79ba917 | |||
| c4928f60b2 | |||
| abf4e80f89 | |||
| 3dd9d7d92a | |||
| f555fd049a | |||
| 3204a1d7ee | |||
| 36faddad1f | |||
| 5ce1b8846e | |||
| 7d3bf9e961 | |||
| 74825339e2 | |||
| 68cbb70139 | |||
| 92044702ae | |||
| 0201eac24a | |||
| 0ed637cfcf | |||
| 84a5fe3858 | |||
| 474f6fe2d6 | |||
| 60fdebcaa0 | |||
| 45782db6bb | |||
| 48f723762f | |||
| 47e83f22be | |||
| 0e551035d1 | |||
| 62f6757f9d | |||
| a428459833 | |||
| f095c96a24 | |||
| ae05c2673a | |||
| 103a5e472a | |||
| 757009bbfb | |||
| d362d4eee6 | |||
| 593de90ca6 | |||
| 8c0c6c8d7c | |||
| 5be3e316c8 | |||
| 94b90678df | |||
| eaa96ba58a | |||
| 44a2af354e | |||
| 3a80e0e099 | |||
| 12e72b3c2c | |||
| 4fde0062b7 | |||
| de06a7b2d9 | |||
| c2b0f85f89 | |||
| 5c64086828 | |||
| 2c6bfbf747 | |||
| 64229a087e | |||
| 1bd3f5bb60 | |||
| 6c8d6bc70b | |||
| b8f65dc957 | |||
| fa219c6037 | |||
| 9821189ab1 | |||
| 5d4cc0f4ea | |||
| 01c0e9f833 | |||
| 141c2c8456 | |||
| 8a5ca22804 | |||
| 9754c2c392 | |||
| 6b53f6ebd3 | |||
| cdb0c5fe9b | |||
| 11e04196cb | |||
| 29edc90ebc | |||
| 6e18fb01c6 | |||
| 32beac3065 | |||
| 6192e05e66 | |||
| af4c65f15f | |||
| 4bca14699b | |||
| d98944ed63 | |||
| 7dbd05b21e | |||
| 3cc4dbce77 | |||
| 074c147da5 | |||
| 5b8e3dd3d3 | |||
| 2141ee0aed | |||
| 8b80b5f8c5 | |||
| e2af6d9100 | |||
| 805fe48b8e | |||
| d202c81467 | |||
| 07f1b16595 | |||
| 6bd8322cc0 | |||
| c52efcdb15 | |||
| ae41ebb511 | |||
| 24c9717540 | |||
| 539398efb9 | |||
| d989354a16 | |||
| 55a5eb443a | |||
| 17a29d7832 | |||
| 912d86dd8c | |||
| 5342be569e | |||
| 9a2e0b4291 | |||
| 88df42ca5d | |||
| f33aa6798c | |||
| 02b7f7afe9 | |||
| ebb07bc5ed | |||
| 61d05163a5 | |||
| 9387d999c7 | |||
| ffe78bf0c0 | |||
| 2e5a055c0b | |||
| 7110dc62e5 | |||
| 26379d6558 | |||
| 121a8602cf | |||
| 83f4443dc3 | |||
| fc233f01f1 | |||
| f2cafa54c1 | |||
| 703d0b3fc4 | |||
| 4ae0de712c | |||
| 770ec29fba | |||
| ed3b47c532 | |||
| 24bfe99216 | |||
| 431704008a | |||
| ce9ab433cd | |||
| a650e9fb37 | |||
| 1108670ae5 | |||
| e2fde74b75 | |||
| 1bfc5e12e7 | |||
| 9f208cd0a2 | |||
| 9f4b1fed96 | |||
| 08f64d3788 | |||
| 4f5a45b415 | |||
| 7a846ccd45 | |||
| 251afa68a6 | |||
| 93d1065772 | |||
| bbc5af6302 | |||
| 9da2d2601f | |||
| dc08d3eb0a | |||
| cf286869dc | |||
| b6dfc3ff3f | |||
| b3f1ba49fd | |||
| 165c1cec54 | |||
| d49e3d49d2 | |||
| 8e0e77f15c | |||
| ed23ac59d4 | |||
| 10489c6e69 | |||
| d1f43e82af |
@@ -1,16 +0,0 @@
|
||||
{
|
||||
"mcpServers": {
|
||||
"ssh": {
|
||||
"command": "cmd.exe",
|
||||
"args": [
|
||||
"/c",
|
||||
"npx",
|
||||
"-y",
|
||||
"@aiondadotcom/mcp-ssh"
|
||||
],
|
||||
"env": {
|
||||
"ProgramData": "C:\\ProgramData"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,64 +0,0 @@
|
||||
.git
|
||||
.github
|
||||
.gitignore
|
||||
.dockerignore
|
||||
README.md
|
||||
CONTRIBUTING.md
|
||||
LICENSE
|
||||
docs/
|
||||
data/
|
||||
cache/
|
||||
logs/
|
||||
verify-data/
|
||||
verify-cache/
|
||||
verify-media/
|
||||
verify-downloads/
|
||||
.codex-*
|
||||
.codex/
|
||||
.tmp/
|
||||
.tmp_*
|
||||
.tmp-deploy-*
|
||||
.tmp-deploy-data/
|
||||
.mebox.pid
|
||||
*.db
|
||||
*.db-journal
|
||||
*.db-shm
|
||||
*.db-wal
|
||||
*.log
|
||||
.env
|
||||
.env.*
|
||||
config.yaml
|
||||
config/*.yaml
|
||||
!config.example.yaml
|
||||
*.pem
|
||||
*.key
|
||||
*.crt
|
||||
*.p12
|
||||
*.pfx
|
||||
.jwt_secret
|
||||
*.secret
|
||||
secrets.*
|
||||
secret.*
|
||||
api_keys.*
|
||||
apikey.*
|
||||
tokens.*
|
||||
token.*
|
||||
password.*
|
||||
.idea/
|
||||
.vscode/
|
||||
.workbuddy/
|
||||
.dev-cache/
|
||||
.dev-data/
|
||||
node_modules/
|
||||
**/node_modules/
|
||||
web/dist/
|
||||
**/dist/
|
||||
web/.vite/
|
||||
**/.vite/
|
||||
web/coverage/
|
||||
bin/
|
||||
*.exe
|
||||
*.dll
|
||||
*.so
|
||||
*.dylib
|
||||
*~
|
||||
@@ -1,20 +0,0 @@
|
||||
* text=auto
|
||||
|
||||
.gitattributes text eol=lf
|
||||
*.sh text eol=lf
|
||||
*.yml text eol=lf
|
||||
*.yaml text eol=lf
|
||||
Dockerfile text eol=lf
|
||||
|
||||
*.ps1 text eol=crlf
|
||||
|
||||
# GitHub Linguist: keep repository language stats focused on product code
|
||||
# (Go backend + React/TypeScript frontend + Docker packaging). Deployment
|
||||
# helpers, generated lock files, and static brand assets are still tracked but
|
||||
# should not appear as primary project languages.
|
||||
scripts/** linguist-vendored
|
||||
docker-entrypoint.sh linguist-vendored
|
||||
web/package-lock.json linguist-generated
|
||||
web/*.config.js linguist-vendored
|
||||
web/public/** linguist-vendored
|
||||
web/src/**/*.css linguist-vendored
|
||||
@@ -1,52 +0,0 @@
|
||||
---
|
||||
name: Bug 反馈
|
||||
about: 报告可复现的问题、报错、功能异常或回归
|
||||
title: "[Bug] "
|
||||
labels: bug
|
||||
assignees: ""
|
||||
---
|
||||
|
||||
## 问题现象
|
||||
|
||||
请描述实际发生了什么。
|
||||
|
||||
## 期望行为
|
||||
|
||||
请描述你认为正确结果应该是什么。
|
||||
|
||||
## 复现步骤
|
||||
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
## 部署方式
|
||||
|
||||
- 部署方式:Docker 第一档 / 第二档 / 第三档 / 裸机 / 其他
|
||||
- 镜像或版本:
|
||||
- NAS / 系统:
|
||||
- Docker 版本:
|
||||
- Docker Compose 版本:
|
||||
- 浏览器:
|
||||
|
||||
## 关键配置
|
||||
|
||||
请贴出相关配置片段,例如路径映射、媒体库路径、下载器保存路径、站点类型等。
|
||||
|
||||
请务必隐藏 Cookie、API Key、Passkey、密码、Token 和私有下载链接。
|
||||
|
||||
```yaml
|
||||
# docker-compose.yml 相关片段
|
||||
```
|
||||
|
||||
## 日志 / 任务详情
|
||||
|
||||
请附上应用日志、任务队列详情、浏览器控制台错误或网络请求错误。
|
||||
|
||||
```text
|
||||
|
||||
```
|
||||
|
||||
## 补充信息
|
||||
|
||||
截图、录屏、相关 Issue、你已经尝试过的排查步骤。
|
||||
@@ -1,5 +0,0 @@
|
||||
blank_issues_enabled: true
|
||||
contact_links:
|
||||
- name: Telegram MeBox 交流群
|
||||
url: https://t.me/MeBox
|
||||
about: 适合快速交流部署经验、使用问题和排查线索。
|
||||
@@ -1,29 +0,0 @@
|
||||
---
|
||||
name: 功能建议
|
||||
about: 提出新功能、体验改进或兼容性需求
|
||||
title: "[Feature] "
|
||||
labels: enhancement
|
||||
assignees: ""
|
||||
---
|
||||
|
||||
## 需求背景
|
||||
|
||||
这个功能解决什么问题?当前使用流程哪里不方便?
|
||||
|
||||
## 期望方案
|
||||
|
||||
请描述你希望 MeBox 如何工作。
|
||||
|
||||
## 使用场景
|
||||
|
||||
- 部署环境:
|
||||
- 相关页面或模块:
|
||||
- 受影响用户:
|
||||
|
||||
## 可接受的替代方案
|
||||
|
||||
如果有其他实现方式或临时解决办法,也请写出来。
|
||||
|
||||
## 补充信息
|
||||
|
||||
截图、竞品参考、API 文档、相关讨论链接等。
|
||||
@@ -1,4 +0,0 @@
|
||||
name: MeBox CodeQL
|
||||
|
||||
paths-ignore:
|
||||
- internal/service/fileid_other.go
|
||||
@@ -1,40 +0,0 @@
|
||||
## 背景
|
||||
|
||||
说明这个 PR 解决的问题、关联 Issue 或用户场景。
|
||||
|
||||
> 请确认本 PR 基于本仓库最新 `main` 的独立分支或 fork 分支提交,未直接向 `main` 推送,也未夹带个人部署魔改配置。
|
||||
|
||||
## 改动摘要
|
||||
|
||||
-
|
||||
|
||||
## 验证
|
||||
|
||||
- [ ] `go test ./...`
|
||||
- [ ] `npm --prefix web run build`
|
||||
- [ ] `git diff --check`
|
||||
- [ ] 其他:
|
||||
|
||||
## 风险与兼容性
|
||||
|
||||
- 是否影响 Docker / NAS 路径映射:
|
||||
- 是否影响数据库迁移或数据结构:
|
||||
- 是否影响下载器、订阅、站点 API 或限流:
|
||||
- 是否包含敏感信息脱敏:
|
||||
|
||||
## 截图 / 日志
|
||||
|
||||
涉及 UI、任务队列、错误提示、设置页时请附截图或日志片段。
|
||||
|
||||
```text
|
||||
|
||||
```
|
||||
|
||||
## 提交前检查
|
||||
|
||||
- [ ] 分支已同步最新 `main`,不是直接在 `main` 上提交。
|
||||
- [ ] PR 范围聚焦,没有夹带无关重构。
|
||||
- [ ] 未提交个人部署配置、私有路径、API Key、Cookie、Token 或私有镜像标签。
|
||||
- [ ] 用户可见错误有清晰提示或日志。
|
||||
- [ ] 新行为有测试覆盖,或已说明无法覆盖的原因。
|
||||
- [ ] 文档、示例配置、README 已按需同步。
|
||||
@@ -1,268 +0,0 @@
|
||||
name: Build & Publish
|
||||
|
||||
# 版本策略(version 分支托管,main 零污染):
|
||||
# - VERSION 文件单独存放在 version 分支,CI 构建时读取并自增写回 version 分支,
|
||||
# main 分支不再出现任何 CI 提交,本地推送永不与远程冲突。
|
||||
# - push 到 main:版本号自动 patch+1,发布 latest + 版本镜像、GitHub Release、
|
||||
# 多平台单文件二进制,并部署服务器。
|
||||
# - push tag v*:正式发版,版本号取 tag 名(不 bump version 分支),其余同上。
|
||||
# - 手动触发:版本号在 version 分支当前值上自增,等同 push main 全量发布。
|
||||
# 查看当前版本号:git show origin/version:VERSION
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
tags: ['v*']
|
||||
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: write # 读写 version 分支、发布 Release 与上传二进制需要
|
||||
packages: write
|
||||
|
||||
jobs:
|
||||
build-image:
|
||||
runs-on: ubuntu-latest
|
||||
outputs:
|
||||
version: ${{ steps.version.outputs.version }}
|
||||
release_tag: ${{ steps.version.outputs.release_tag }}
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
# 1. 解析版本号:tag 触发取 tag 名(去掉 v 前缀);其余场景读 version 分支并 patch+1
|
||||
- name: Resolve version
|
||||
id: version
|
||||
run: |
|
||||
if [ "${{ github.ref_type }}" = "tag" ]; then
|
||||
VERSION="${GITHUB_REF_NAME#v}"
|
||||
else
|
||||
git fetch origin version
|
||||
BASE=$(git show FETCH_HEAD:VERSION 2>/dev/null || echo "0.0.0")
|
||||
MAJOR=$(echo "$BASE" | cut -d. -f1)
|
||||
MINOR=$(echo "$BASE" | cut -d. -f2)
|
||||
PATCH=$(echo "$BASE" | cut -d. -f3)
|
||||
VERSION="${MAJOR}.${MINOR}.$((PATCH + 1))"
|
||||
fi
|
||||
echo "version=${VERSION}" >> "$GITHUB_OUTPUT"
|
||||
echo "release_tag=mebox-v${VERSION}" >> "$GITHUB_OUTPUT"
|
||||
echo "new_version=${VERSION}" >> "$GITHUB_OUTPUT"
|
||||
|
||||
# 2. 把新版本号写回 version 分支(clone 单分支写入,冲突时 rebase 重试)
|
||||
# tag 触发的正式发版版本号来自 tag 本身,跳过自增。
|
||||
- name: Bump version branch
|
||||
if: github.ref_type != 'tag'
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
run: |
|
||||
REPO="https://x-access-token:${GH_TOKEN}@github.com/${{ github.repository }}.git"
|
||||
git clone --depth 1 --branch version "$REPO" "$RUNNER_TEMP/version-branch"
|
||||
cd "$RUNNER_TEMP/version-branch"
|
||||
git config user.name "github-actions[bot]"
|
||||
git config user.email "github-actions[bot]@users.noreply.github.com"
|
||||
echo "${{ steps.version.outputs.new_version }}" > VERSION
|
||||
git commit -am "chore: bump version to ${{ steps.version.outputs.new_version }}"
|
||||
ok=0
|
||||
for i in 1 2 3 4 5; do
|
||||
if git push origin version; then ok=1; break; fi
|
||||
git pull --rebase origin version || true
|
||||
sleep 5
|
||||
done
|
||||
[ "$ok" = "1" ] || { echo "::error::version 分支推送冲突,重试 5 次仍失败"; exit 1; }
|
||||
|
||||
# 3. 设置 Docker QEMU 和 Buildx
|
||||
- uses: docker/setup-qemu-action@v3
|
||||
- uses: docker/setup-buildx-action@v3
|
||||
|
||||
# 3. 登录 GHCR
|
||||
- name: Log in to GHCR
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
registry: ghcr.io
|
||||
username: ${{ github.actor }}
|
||||
password: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
# 4. 提取镜像元数据
|
||||
- name: Extract image metadata
|
||||
id: meta
|
||||
uses: docker/metadata-action@v5
|
||||
with:
|
||||
images: ghcr.io/${{ github.repository_owner }}/mebox
|
||||
tags: |
|
||||
type=raw,value=latest
|
||||
type=raw,value=${{ steps.version.outputs.version }}
|
||||
|
||||
# 5. 构建并推送
|
||||
- name: Build & push
|
||||
uses: docker/build-push-action@v6
|
||||
with:
|
||||
context: .
|
||||
platforms: linux/amd64,linux/arm64
|
||||
push: true
|
||||
provenance: false
|
||||
sbom: false
|
||||
tags: ${{ steps.meta.outputs.tags }}
|
||||
labels: ${{ steps.meta.outputs.labels }}
|
||||
build-args: |
|
||||
VERSION=${{ steps.version.outputs.release_tag }}
|
||||
cache-from: type=gha
|
||||
cache-to: type=gha,mode=max
|
||||
|
||||
# 单文件可执行构建:把前端打包进二进制(go:embed),交叉编译 Windows /
|
||||
# Linux / macOS 的 amd64 / arm64 产物,作为 GitHub Release 附件发布。
|
||||
build-frontend:
|
||||
needs: [build-image]
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version-file: '.nvmrc'
|
||||
cache: 'npm'
|
||||
cache-dependency-path: web/package-lock.json
|
||||
- name: Install
|
||||
working-directory: web
|
||||
run: npm ci
|
||||
- name: Build SPA
|
||||
working-directory: web
|
||||
run: npm run build
|
||||
- name: Upload web/dist
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: web-dist
|
||||
path: web/dist
|
||||
retention-days: 1
|
||||
|
||||
# 先创建(幂等)空的 GitHub Release,供后续 build-binaries 并行上传附件,
|
||||
# 也避免矩阵各 job 并发 upload 时 release 尚不存在而互相竞争。
|
||||
publish-create-release:
|
||||
needs: [build-image]
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Create release
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
RELEASE_TAG: ${{ needs.build-image.outputs.release_tag }}
|
||||
run: |
|
||||
set -eux
|
||||
# tag push 时 tag 已存在;手动触发时基于当前 main 创建 tag(幂等)
|
||||
if ! git rev-parse "$RELEASE_TAG" >/dev/null 2>&1; then
|
||||
git tag "$RELEASE_TAG"
|
||||
git push origin "$RELEASE_TAG"
|
||||
fi
|
||||
gh release create "$RELEASE_TAG" \
|
||||
--title "MeBox ${{ needs.build-image.outputs.version }}" \
|
||||
--notes "自动化发布 ${{ needs.build-image.outputs.version }}" \
|
||||
--verify-tag --latest || true
|
||||
|
||||
build-binaries:
|
||||
needs: [build-image, build-frontend, publish-create-release]
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
include:
|
||||
- goos: linux
|
||||
goarch: amd64
|
||||
ext: ""
|
||||
- goos: linux
|
||||
goarch: arm64
|
||||
ext: ""
|
||||
- goos: windows
|
||||
goarch: amd64
|
||||
ext: .exe
|
||||
- goos: windows
|
||||
goarch: arm64
|
||||
ext: .exe
|
||||
- goos: darwin
|
||||
goarch: amd64
|
||||
ext: ""
|
||||
- goos: darwin
|
||||
goarch: arm64
|
||||
ext: ""
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-go@v5
|
||||
with:
|
||||
go-version: '1.26'
|
||||
cache: true
|
||||
- name: Download web/dist
|
||||
uses: actions/download-artifact@v4
|
||||
with:
|
||||
name: web-dist
|
||||
path: web/dist
|
||||
- name: Build binary
|
||||
run: |
|
||||
LDFLAGS="-s -w -X main.version=${{ needs.build-image.outputs.release_tag }}"
|
||||
if [ "${{ matrix.goos }}" = "windows" ]; then
|
||||
LDFLAGS="$LDFLAGS -H=windowsgui"
|
||||
fi
|
||||
CGO_ENABLED=0 GOOS=${{ matrix.goos }} GOARCH=${{ matrix.goarch }} \
|
||||
go build -trimpath -ldflags="$LDFLAGS" \
|
||||
-o "dist/mebox-${{ matrix.goos }}-${{ matrix.goarch }}${{ matrix.ext }}" ./cmd/server
|
||||
- name: Package
|
||||
run: |
|
||||
mkdir -p package/mebox
|
||||
cp "dist/mebox-${{ matrix.goos }}-${{ matrix.goarch }}${{ matrix.ext }}" package/mebox/mebox${{ matrix.ext }}
|
||||
cp README.md package/mebox/ 2>/dev/null || true
|
||||
if [ "${{ matrix.goos }}" = "windows" ]; then
|
||||
(cd package && zip -r "../mebox_${{ matrix.goos }}_${{ matrix.goarch }}.zip" mebox)
|
||||
else
|
||||
tar -czf "mebox_${{ matrix.goos }}_${{ matrix.goarch }}.tar.gz" -C package mebox
|
||||
fi
|
||||
- name: Upload to GitHub Release
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
RELEASE_TAG: ${{ needs.build-image.outputs.release_tag }}
|
||||
run: |
|
||||
set -eux
|
||||
PKG="mebox_${{ matrix.goos }}_${{ matrix.goarch }}.zip"
|
||||
TAR="mebox_${{ matrix.goos }}_${{ matrix.goarch }}.tar.gz"
|
||||
# 并发上传到同一 release 各自文件,--clobber 幂等覆盖
|
||||
if [ -f "$PKG" ]; then
|
||||
for i in 1 2 3; do gh release upload "$RELEASE_TAG" "$PKG" --clobber && break || sleep 5; done
|
||||
fi
|
||||
if [ -f "$TAR" ]; then
|
||||
for i in 1 2 3; do gh release upload "$RELEASE_TAG" "$TAR" --clobber && break || sleep 5; done
|
||||
fi
|
||||
|
||||
deploy:
|
||||
name: Deploy to Server
|
||||
needs: [build-image]
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Deploy via SSH
|
||||
uses: appleboy/ssh-action@v1.0.3
|
||||
with:
|
||||
host: ${{ secrets.SERVER_HOST }}
|
||||
username: ${{ secrets.SERVER_USER }}
|
||||
password: ${{ secrets.SERVER_PASSWORD }}
|
||||
port: ${{ secrets.SERVER_PORT }}
|
||||
script: |
|
||||
set -e
|
||||
echo "==== 开始部署 MeBox ===="
|
||||
cd /root/dockerData/mebox
|
||||
|
||||
# 判断 compose 命令版本兼容性(docker compose 或 docker-compose)
|
||||
if docker compose version >/dev/null 2>&1; then
|
||||
COMPOSE_CMD="docker compose"
|
||||
elif command -v docker-compose >/dev/null 2>&1; then
|
||||
COMPOSE_CMD="docker-compose"
|
||||
else
|
||||
echo "错误: 未找到 docker compose 或 docker-compose"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "正在拉取最新镜像..."
|
||||
$COMPOSE_CMD pull
|
||||
|
||||
echo "正在重启服务..."
|
||||
$COMPOSE_CMD up -d
|
||||
|
||||
echo "清理旧的无用镜像..."
|
||||
docker image prune -f
|
||||
|
||||
echo "==== 部署完成并已启动 ===="
|
||||
@@ -1,140 +0,0 @@
|
||||
# Beta 分支自动构建流水线
|
||||
#
|
||||
# 触发:push 到 beta 分支 / PR 到 beta / 手动触发。
|
||||
# 产出:
|
||||
# 1. 前端 + 后端编译验证(go vet / go test / go build)
|
||||
# 2. 多平台可执行二进制 artifact(linux/amd64、linux/arm64、windows/amd64)
|
||||
# 3. ghcr.io/{owner}/mebox 多架构 Docker 镜像(linux/amd64 + linux/arm64),
|
||||
# 标签:beta(滚动)+ {基版本}-beta.{短 SHA}(本次构建,只增不改)
|
||||
#
|
||||
# 与 main 分支发布流(Auto-docker-publish.yml)的关系:镜像的构建方式、标签策略
|
||||
# 和基版本号来源(version 分支)与发布流保持一致,区别是 beta 不做版本递增、
|
||||
# 不打 release tag、不发布 GitHub Release、不部署服务器。
|
||||
|
||||
name: Beta Build
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [beta]
|
||||
pull_request:
|
||||
branches: [beta]
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
packages: write
|
||||
|
||||
jobs:
|
||||
# ─────────────────────────────────────────────────────────────────────────────
|
||||
# 1) 编译验证 + 多平台二进制产物
|
||||
# ─────────────────────────────────────────────────────────────────────────────
|
||||
test-and-build:
|
||||
name: Test & build artifacts
|
||||
runs-on: ubuntu-latest
|
||||
outputs:
|
||||
version: ${{ steps.version.outputs.version }}
|
||||
binary_version: ${{ steps.version.outputs.binary_version }}
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
# 基版本号与发布流同源:读 version 分支上由 main 发布流水线维护的 VERSION。
|
||||
# beta 只读不自增,避免与 main 的发布流程争抢版本号。
|
||||
- name: Resolve beta version
|
||||
id: version
|
||||
run: |
|
||||
git fetch origin version || true
|
||||
BASE_VERSION=$(git show FETCH_HEAD:VERSION 2>/dev/null || echo "0.0.0")
|
||||
SHA_SHORT=${GITHUB_SHA:0:7}
|
||||
echo "version=${BASE_VERSION}-beta.${SHA_SHORT}" >> "$GITHUB_OUTPUT"
|
||||
echo "binary_version=mebox-v${BASE_VERSION}-beta.${SHA_SHORT}" >> "$GITHUB_OUTPUT"
|
||||
|
||||
# The binary embeds the SPA (web/dist) via go:embed, so dist must exist
|
||||
# before the Go toolchain touches the web package.
|
||||
- uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version-file: '.nvmrc'
|
||||
cache: 'npm'
|
||||
cache-dependency-path: web/package-lock.json
|
||||
- name: Build SPA
|
||||
working-directory: web
|
||||
run: |
|
||||
npm ci
|
||||
npm run build
|
||||
|
||||
- uses: actions/setup-go@v5
|
||||
with:
|
||||
go-version: '1.26'
|
||||
cache: true
|
||||
|
||||
- name: go vet
|
||||
run: go vet ./...
|
||||
|
||||
- name: go test
|
||||
run: go test ./...
|
||||
|
||||
- name: go build (host)
|
||||
run: go build ./...
|
||||
|
||||
# 多平台可执行文件(嵌入刚构建的 web/dist),版本号写入口径与发布流一致
|
||||
- name: Build linux/amd64
|
||||
run: CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -trimpath -ldflags="-s -w -X main.version=${{ steps.version.outputs.binary_version }}" -o dist/mebox-beta-linux-amd64 ./cmd/server
|
||||
- name: Build linux/arm64
|
||||
run: CGO_ENABLED=0 GOOS=linux GOARCH=arm64 go build -trimpath -ldflags="-s -w -X main.version=${{ steps.version.outputs.binary_version }}" -o dist/mebox-beta-linux-arm64 ./cmd/server
|
||||
- name: Build windows/amd64
|
||||
run: CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build -trimpath -ldflags="-s -w -H=windowsgui -X main.version=${{ steps.version.outputs.binary_version }}" -o dist/mebox-beta-windows-amd64.exe ./cmd/server
|
||||
|
||||
- name: Upload artifacts
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: mebox-beta-binaries
|
||||
path: dist/*
|
||||
if-no-files-found: error
|
||||
|
||||
# ─────────────────────────────────────────────────────────────────────────────
|
||||
# 2) Beta Docker 镜像(ghcr.io/{owner}/mebox:beta + :{基版本}-beta.{短 SHA})
|
||||
# 构建步骤与 Auto-docker-publish.yml 的 build-image 一致,只是不带 deploy。
|
||||
# ─────────────────────────────────────────────────────────────────────────────
|
||||
docker-beta:
|
||||
name: Build & push beta Docker image
|
||||
needs: test-and-build
|
||||
runs-on: ubuntu-latest
|
||||
# PR 事件不推送镜像,仅 push beta / 手动触发时推送
|
||||
if: github.event_name != 'pull_request'
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- uses: docker/setup-qemu-action@v3
|
||||
- uses: docker/setup-buildx-action@v3
|
||||
|
||||
- name: Log in to GHCR
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
registry: ghcr.io
|
||||
username: ${{ github.actor }}
|
||||
password: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Extract image metadata
|
||||
id: meta
|
||||
uses: docker/metadata-action@v5
|
||||
with:
|
||||
images: ghcr.io/${{ github.repository_owner }}/mebox
|
||||
tags: |
|
||||
type=raw,value=beta
|
||||
type=raw,value=${{ needs.test-and-build.outputs.version }}
|
||||
|
||||
- name: Build & push
|
||||
uses: docker/build-push-action@v6
|
||||
with:
|
||||
context: .
|
||||
platforms: linux/amd64,linux/arm64
|
||||
push: true
|
||||
provenance: false
|
||||
sbom: false
|
||||
tags: ${{ steps.meta.outputs.tags }}
|
||||
labels: ${{ steps.meta.outputs.labels }}
|
||||
build-args: |
|
||||
VERSION=${{ needs.test-and-build.outputs.binary_version }}
|
||||
cache-from: type=gha
|
||||
cache-to: type=gha,mode=max
|
||||
@@ -1,117 +0,0 @@
|
||||
name: CI
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
pull_request:
|
||||
branches: [main]
|
||||
|
||||
jobs:
|
||||
backend:
|
||||
name: Backend (Go)
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- uses: actions/setup-go@v5
|
||||
with:
|
||||
go-version: '1.26'
|
||||
cache: true
|
||||
|
||||
# The binary embeds the SPA (web/dist) via go:embed, so the dist must exist
|
||||
# before the Go toolchain touches the `web` package.
|
||||
- uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version-file: '.nvmrc'
|
||||
cache: 'npm'
|
||||
cache-dependency-path: web/package-lock.json
|
||||
- name: Build SPA
|
||||
working-directory: web
|
||||
run: |
|
||||
npm ci
|
||||
npm run build
|
||||
|
||||
- name: go vet
|
||||
run: go vet ./...
|
||||
|
||||
- name: go build
|
||||
run: go build ./...
|
||||
|
||||
- name: go test
|
||||
run: go test ./...
|
||||
|
||||
database-compatibility:
|
||||
name: SQLite / PostgreSQL ${{ matrix.postgres }}
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
matrix:
|
||||
postgres: [16, 17]
|
||||
services:
|
||||
postgres:
|
||||
image: postgres:${{ matrix.postgres }}-alpine
|
||||
env:
|
||||
POSTGRES_USER: mebox
|
||||
POSTGRES_PASSWORD: mebox-test-only
|
||||
POSTGRES_DB: mebox_test
|
||||
ports:
|
||||
- 5432:5432
|
||||
options: >-
|
||||
--health-cmd "pg_isready -U mebox -d mebox_test"
|
||||
--health-interval 5s
|
||||
--health-timeout 5s
|
||||
--health-retries 10
|
||||
env:
|
||||
MEBOX_TEST_POSTGRES_DSN: postgres://mebox:mebox-test-only@127.0.0.1:5432/mebox_test?sslmode=disable
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- uses: actions/setup-go@v5
|
||||
with:
|
||||
go-version: '1.26'
|
||||
cache: true
|
||||
|
||||
- name: Database regression tests
|
||||
run: go test ./internal/database ./internal/repository -count=1
|
||||
|
||||
frontend:
|
||||
name: Frontend (Node)
|
||||
runs-on: ubuntu-latest
|
||||
defaults:
|
||||
run:
|
||||
working-directory: web
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version-file: '.nvmrc'
|
||||
cache: 'npm'
|
||||
cache-dependency-path: web/package-lock.json
|
||||
|
||||
- name: Install
|
||||
run: npm ci
|
||||
|
||||
- name: Type-check & build
|
||||
run: npm run build
|
||||
|
||||
smoke:
|
||||
name: Deployment smoke test
|
||||
runs-on: ubuntu-latest
|
||||
needs: [backend, frontend]
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Validate single-image compose
|
||||
run: docker compose -f docker-compose.simple.yml config --quiet
|
||||
- name: Validate tier 1 compose
|
||||
run: docker compose -f docker-compose.yml config --quiet
|
||||
- name: Validate tier 2 compose
|
||||
run: docker compose -f docker-compose.standard.yml config --quiet
|
||||
- name: Validate tier 3 compose
|
||||
run: docker compose -f docker-compose.search.yml config --quiet
|
||||
ci-success:
|
||||
name: CI Success
|
||||
runs-on: ubuntu-latest
|
||||
needs: [backend, frontend, database-compatibility, smoke]
|
||||
if: success()
|
||||
steps:
|
||||
- run: echo "CI passed, ready for release"
|
||||
@@ -1,101 +0,0 @@
|
||||
name: Publish Docker image
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
version:
|
||||
description: 'Image tag to publish, for example MeBox-v0.0.32'
|
||||
required: true
|
||||
type: string
|
||||
ref:
|
||||
description: 'Git ref to build from'
|
||||
required: false
|
||||
default: main
|
||||
type: string
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
packages: write
|
||||
|
||||
jobs:
|
||||
docker:
|
||||
runs-on: ubuntu-latest
|
||||
env:
|
||||
RELEASE_VERSION: ${{ github.event_name == 'workflow_dispatch' && inputs.version || github.ref_name }}
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
ref: ${{ github.event_name == 'workflow_dispatch' && inputs.ref || github.ref }}
|
||||
|
||||
- uses: docker/setup-qemu-action@v3
|
||||
- uses: docker/setup-buildx-action@v3
|
||||
|
||||
- name: Log in to GHCR
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
registry: ghcr.io
|
||||
username: ${{ github.actor }}
|
||||
password: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Extract image metadata
|
||||
id: meta
|
||||
uses: docker/metadata-action@v5
|
||||
with:
|
||||
# 自动使用当前仓库所有者
|
||||
images: ghcr.io/${{ github.repository_owner }}/mebox
|
||||
tags: |
|
||||
type=raw,value=latest
|
||||
type=raw,value=${{ env.RELEASE_VERSION }}
|
||||
|
||||
- name: Build & push
|
||||
uses: docker/build-push-action@v6
|
||||
with:
|
||||
context: .
|
||||
platforms: linux/amd64,linux/arm64
|
||||
push: true
|
||||
provenance: false
|
||||
sbom: false
|
||||
tags: ${{ steps.meta.outputs.tags }}
|
||||
labels: ${{ steps.meta.outputs.labels }}
|
||||
build-args: |
|
||||
VERSION=${{ env.RELEASE_VERSION }}
|
||||
cache-from: type=gha
|
||||
cache-to: type=gha,mode=max
|
||||
|
||||
deploy:
|
||||
name: Deploy to Server
|
||||
needs: [docker]
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Deploy via SSH
|
||||
uses: appleboy/ssh-action@v1.0.3
|
||||
with:
|
||||
host: ${{ secrets.SERVER_HOST }}
|
||||
username: ${{ secrets.SERVER_USER }}
|
||||
password: ${{ secrets.SERVER_PASSWORD }}
|
||||
port: ${{ secrets.SERVER_PORT }}
|
||||
script: |
|
||||
set -e
|
||||
echo "==== 开始部署 MeBox ===="
|
||||
cd /root/dockerData/mebox
|
||||
|
||||
if docker compose version >/dev/null 2>&1; then
|
||||
COMPOSE_CMD="docker compose"
|
||||
elif command -v docker-compose >/dev/null 2>&1; then
|
||||
COMPOSE_CMD="docker-compose"
|
||||
else
|
||||
echo "错误: 未找到 docker compose 或 docker-compose"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "正在拉取最新镜像..."
|
||||
$COMPOSE_CMD pull
|
||||
|
||||
echo "正在重启服务..."
|
||||
$COMPOSE_CMD up -d
|
||||
|
||||
echo "清理旧的无用镜像..."
|
||||
docker image prune -f
|
||||
|
||||
echo "==== 部署完成并已启动 ===="
|
||||
|
||||
-84
@@ -1,84 +0,0 @@
|
||||
# Binaries
|
||||
bin/
|
||||
*.exe
|
||||
*.dll
|
||||
*.so
|
||||
*.dylib
|
||||
|
||||
# Test binary, built with `go test -c`
|
||||
*.test
|
||||
*.out
|
||||
|
||||
# Go workspace
|
||||
go.work
|
||||
|
||||
# Dependency directories
|
||||
node_modules/
|
||||
|
||||
# Build artifacts
|
||||
web/dist/
|
||||
web/.vite/
|
||||
web/coverage/
|
||||
web/tsconfig.tsbuildinfo
|
||||
dist-release/
|
||||
|
||||
# Data / runtime
|
||||
data/
|
||||
cache/
|
||||
logs/
|
||||
.tmp-deploy-data/
|
||||
.tmp-deploy-smoke-data/
|
||||
.tmp-deploy-smoke-cache/
|
||||
.tmp-deploy-cache/
|
||||
.tmp-deploy-server.*
|
||||
.tmp-live-server.*
|
||||
.mebox.pid
|
||||
*.log
|
||||
*.db
|
||||
*.db-journal
|
||||
*.db-shm
|
||||
*.db-wal
|
||||
|
||||
# Editor / OS
|
||||
.idea/
|
||||
.vscode/
|
||||
.DS_Store
|
||||
Thumbs.db
|
||||
|
||||
# Env files
|
||||
.env
|
||||
.env.local
|
||||
.env.*.local
|
||||
|
||||
# Local configs (keep examples)
|
||||
config/secrets.yaml
|
||||
config.yaml
|
||||
|
||||
# WorkBuddy workspace (local AI assistant memory)
|
||||
.workbuddy/
|
||||
|
||||
# Editor backups
|
||||
*~
|
||||
.tmp_*
|
||||
|
||||
# Runtime / local-only artifacts (清理补充)
|
||||
.tmp/
|
||||
.tmp-live-backups/
|
||||
.tmp-*
|
||||
.codex-*
|
||||
.codex/
|
||||
downloads/
|
||||
media/
|
||||
*.pid
|
||||
|
||||
# 本地开发运行产物
|
||||
.agents/
|
||||
.claude/
|
||||
.dev-cache/
|
||||
.dev-data/
|
||||
.dev-logs/
|
||||
tools/
|
||||
verify-cache/
|
||||
verify-data/
|
||||
.zcode/
|
||||
.tmp-src
|
||||
-114
@@ -1,114 +0,0 @@
|
||||
# Binaries
|
||||
bin/
|
||||
*.exe
|
||||
*.dll
|
||||
*.so
|
||||
*.dylib
|
||||
|
||||
# Test binary, built with `go test -c`
|
||||
*.test
|
||||
*.out
|
||||
|
||||
# Go workspace
|
||||
go.work
|
||||
|
||||
# Dependency directories
|
||||
node_modules/
|
||||
|
||||
# Build artifacts
|
||||
web/dist/
|
||||
web/.vite/
|
||||
web/coverage/
|
||||
web/tsconfig.tsbuildinfo
|
||||
dist-release/
|
||||
|
||||
# Data / runtime
|
||||
data/
|
||||
cache/
|
||||
logs/
|
||||
.tmp-deploy-data/
|
||||
.tmp-deploy-smoke-data/
|
||||
.tmp-deploy-smoke-cache/
|
||||
.tmp-deploy-cache/
|
||||
.tmp-deploy-server.*
|
||||
.tmp-live-server.*
|
||||
.mebox.pid
|
||||
*.log
|
||||
*.db
|
||||
*.db-journal
|
||||
*.db-shm
|
||||
*.db-wal
|
||||
|
||||
# Editor / OS
|
||||
.idea/
|
||||
.vscode/
|
||||
.DS_Store
|
||||
Thumbs.db
|
||||
|
||||
# Env files
|
||||
.env
|
||||
.env.local
|
||||
.env.*.local
|
||||
|
||||
# Local configs (keep examples)
|
||||
config/secrets.yaml
|
||||
config.yaml
|
||||
|
||||
# WorkBuddy workspace (local AI assistant memory)
|
||||
.workbuddy/
|
||||
|
||||
# Editor backups
|
||||
*~
|
||||
.tmp_*
|
||||
|
||||
# Runtime / local-only artifacts (清理补充)
|
||||
.tmp/
|
||||
.tmp-live-backups/
|
||||
.tmp-*
|
||||
.codex-*
|
||||
.codex/
|
||||
downloads/
|
||||
media/
|
||||
*.pid
|
||||
|
||||
# 本地开发运行产物
|
||||
.agents/
|
||||
.claude/
|
||||
.dev-cache/
|
||||
.dev-data/
|
||||
.dev-logs/
|
||||
tools/
|
||||
verify-cache/
|
||||
verify-data/
|
||||
.zcode/
|
||||
|
||||
# ===== ↑ 以上同步自 .gitignore(「从 .gitignore 同步」只重写以上部分)=====
|
||||
.git/
|
||||
.hg/
|
||||
.svn/
|
||||
bower_components/
|
||||
jspm_packages/
|
||||
__pycache__/
|
||||
site-packages/
|
||||
venv/
|
||||
coverage/
|
||||
htmlcov/
|
||||
lcov-report/
|
||||
cmakefiles/
|
||||
cmake-build-*/
|
||||
bazel-*/
|
||||
pods/
|
||||
deriveddata/
|
||||
storybook-static/
|
||||
playwright-report/
|
||||
test-results/
|
||||
allure-results/
|
||||
allure-report/
|
||||
cdk.out/
|
||||
*.egg-info/
|
||||
*.dist-info/
|
||||
eggs/
|
||||
pip-wheel-metadata/
|
||||
wheels/
|
||||
# ----- ↑ 以上为 ZCode 默认排除规则(自定义规则请写在本行下方,不会被同步/恢复改动)-----
|
||||
# 自定义规则写在下方(本行提示可删除)
|
||||
@@ -1,96 +0,0 @@
|
||||
## 删除用户云下载任务
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-------------|:----------------------------------|
|
||||
| 接口名称 | 删除用户云下载任务 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /del_task |
|
||||
| 请求方法 | POST |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
删除当前授权用户的指定云下载任务,可选择同时删除对应源文件。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/offline/del_task
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
POST
|
||||
Content-Type: multipart/form-data
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:----------------|:-------|:-----|:-------|:---------------------------|:-------------|
|
||||
| info_hash | string | 是 | - | 需删除的任务Hash | `<info_hash>` |
|
||||
| del_source_file | int | 否 | 0 | 是否删除源文件,1=删除 0=不删除 | 0 |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl 'https://proapi.115.com/open/offline/del_task' \
|
||||
-H 'Authorization: Bearer <access_token>' \
|
||||
--form-string 'info_hash=<info_hash>' \
|
||||
--form-string 'del_source_file=0'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:--------|:--------|:----------------------|
|
||||
| state | boolean | 操作结果状态 |
|
||||
| message | string | 返回信息 |
|
||||
| code | int | 错误码 |
|
||||
| data | object[] | 返回数据,成功时为空数组 |
|
||||
|
||||
#### 响应的 code 字段(错误码)说明
|
||||
|
||||
| 错误码 | 说明 | 解决方案 |
|
||||
|:-------|:---------|:-------------------------|
|
||||
| 990002 | 参数错误 | 检查 `info_hash` 参数 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0,
|
||||
"data": []
|
||||
}
|
||||
```
|
||||
|
||||
### 业务规则
|
||||
|
||||
- 未传 `del_source_file` 时默认不删除源文件。
|
||||
- `del_source_file=1` 会删除任务对应的源文件,操作前需确认影响范围。
|
||||
|
||||
### 性能与安全说明
|
||||
|
||||
- 用户身份由 Bearer access_token 解析,请求参数不能指定115账号。
|
||||
- 接口按应用、用户和接口维度执行频率限制。
|
||||
|
||||
### 注意事项
|
||||
|
||||
- 删除结果以响应中的 `state`、`code` 和 `message` 字段为准。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,111 +0,0 @@
|
||||
## 添加云下载BT任务
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-------------|:----------------------------------|
|
||||
| 接口名称 | 添加云下载BT任务 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /add_task_bt |
|
||||
| 请求方法 | POST |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
根据已解析的BT种子信息添加云下载BT任务。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/offline/add_task_bt
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
POST
|
||||
Content-Type: multipart/form-data
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:-------------|:-------|:-----|:-------|:----------------------------------|:----------------|
|
||||
| info_hash | string | 是 | - | BT任务Hash | `<info_hash>` |
|
||||
| wanted | string | 是 | - | 选中下载的文件索引,使用半角逗号分隔 | `<file_indexes>` |
|
||||
| save_path | string | 是 | - | BT任务文件保存路径 | `A/B` |
|
||||
| torrent_sha1 | string | 是 | - | BT种子SHA1 | `<torrent_sha1>` |
|
||||
| pick_code | string | 是 | - | BT种子文件提取码 | `<pick_code>` |
|
||||
| wp_path_id | string | 否 | 0 | 保存目标文件夹ID | 0 |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl 'https://proapi.115.com/open/offline/add_task_bt' \
|
||||
-H 'Authorization: Bearer <access_token>' \
|
||||
--form-string 'info_hash=<info_hash>' \
|
||||
--form-string 'wanted=<file_indexes>' \
|
||||
--form-string 'save_path=A/B' \
|
||||
--form-string 'torrent_sha1=<torrent_sha1>' \
|
||||
--form-string 'pick_code=<pick_code>' \
|
||||
--form-string 'wp_path_id=0'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:--------|:--------|:----------------------|
|
||||
| state | boolean | 操作结果状态 |
|
||||
| message | string | 返回信息 |
|
||||
| code | int | 错误码 |
|
||||
| data | object[] | 返回数据,成功时为空数组 |
|
||||
|
||||
#### 响应的 code 字段(错误码)说明
|
||||
|
||||
| 错误码 | 说明 | 解决方案 |
|
||||
|:--------|:---------------------|:-------------------------------|
|
||||
| 20018 | 文件不存在或已删除 | 检查提取码、文件归属和种子SHA1 |
|
||||
| 91006 | 存储空间不足 | 扩充存储空间后重试 |
|
||||
| 990002 | 参数错误 | 检查必填参数 |
|
||||
| 1000012 | 云下载配额已用完 | 购买配额或获得更多配额后重试 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0,
|
||||
"data": []
|
||||
}
|
||||
```
|
||||
|
||||
### 业务规则
|
||||
|
||||
- `wanted` 可以为 `0`,但不能是空字符串。
|
||||
- 种子文件需属于当前授权用户、位于指定存储区域,并且文件SHA1与 `torrent_sha1` 一致。
|
||||
- 不传 `wp_path_id` 时默认保存到根目录;`save_path` 是相对于 `wp_path_id` 所在文件夹的路径。例如,`wp_path_id` 不传或传云下载文件夹ID且 `save_path=A/B` 时,最终路径为根目录下的 `A/B/`。
|
||||
- 添加任务前会检查当前授权账号的剩余存储空间;空间不足时不扣减云下载配额。
|
||||
- 云下载服务返回状态码 `10007` 或 `10010` 时,接口统一返回错误码 `1000012`。
|
||||
|
||||
### 性能与安全说明
|
||||
|
||||
- 用户身份由 Bearer access_token 解析,请求参数不能指定115账号。
|
||||
- 接口按应用、用户和接口维度执行频率限制。
|
||||
- 种子文件必须属于当前授权账号,并且文件SHA1与 `torrent_sha1` 一致。
|
||||
|
||||
### 注意事项
|
||||
|
||||
- 任务处理结果以响应中的 `data` 字段为准。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,115 +0,0 @@
|
||||
## 添加云下载链接任务
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-------------|:----------------------------------|
|
||||
| 接口名称 | 添加云下载链接任务 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /add_task_urls |
|
||||
| 请求方法 | POST |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
批量添加云下载链接任务。多个链接使用换行符分隔,支持HTTP(S)、FTP、磁力链和电驴链接。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/offline/add_task_urls
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
POST
|
||||
Content-Type: multipart/form-data
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:-----------|:-------|:-----|:-------|:----------------------------------------|:----------------|
|
||||
| urls | string | 是 | - | 云下载链接,多个链接使用换行符分隔 | `<download_url>` |
|
||||
| wp_path_id | string | 否 | 0 | 保存目标文件夹ID;不传或传0时保存到根目录 | 0 |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl 'https://proapi.115.com/open/offline/add_task_urls' \
|
||||
-H 'Authorization: Bearer <access_token>' \
|
||||
--form-string 'urls=<download_url>' \
|
||||
--form-string 'wp_path_id=0'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:-----------------|:---------|:-------------------------------|
|
||||
| state | boolean | 操作结果状态 |
|
||||
| message | string | 返回信息 |
|
||||
| code | int | 错误码 |
|
||||
| data | object[] | 各链接任务的添加结果 |
|
||||
| data[].state | boolean | 链接任务添加状态 |
|
||||
| data[].code | int | 链接任务状态码 |
|
||||
| data[].message | string | 链接任务状态描述 |
|
||||
| data[].info_hash | string | 链接任务SHA1,仅任务成功时返回 |
|
||||
| data[].url | string | 链接任务URL |
|
||||
|
||||
#### 响应的 code 字段(错误码)说明
|
||||
|
||||
| 错误码 | 说明 | 解决方案 |
|
||||
|:--------|:---------------------------|:-----------------------------|
|
||||
| 91006 | 存储空间不足 | 扩充存储空间后重试 |
|
||||
| 980004 | 操作失败 | 稍后重试 |
|
||||
| 990002 | 参数错误 | 检查必填参数 |
|
||||
| 1000011 | 链接数量超过115个 | 将链接拆分为每批不超过115个 |
|
||||
| 1000012 | 云下载配额已用完 | 购买配额或获得更多配额后重试 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0,
|
||||
"data": [
|
||||
{
|
||||
"state": true,
|
||||
"code": 0,
|
||||
"message": "",
|
||||
"info_hash": "",
|
||||
"url": ""
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### 业务规则
|
||||
|
||||
- 服务端按换行符拆分并清理链接,单次最多提交115个链接。
|
||||
- 添加任务前会检查当前授权账号的剩余存储空间;空间不足时不扣减云下载配额。
|
||||
- 云下载服务返回状态码 `10007` 或 `10010` 时,接口统一返回错误码 `1000012`。
|
||||
|
||||
### 性能与安全说明
|
||||
|
||||
- 用户身份由 Bearer access_token 解析,请求参数不能指定115账号。
|
||||
- 接口按应用、用户和接口维度执行频率限制。
|
||||
- 本接口限制单批链接数量,避免不受控的批量请求。
|
||||
|
||||
### 注意事项
|
||||
|
||||
- 任务处理结果以响应中的 `data` 字段为准。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,104 +0,0 @@
|
||||
## 清空云下载任务
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-------------|:----------------------------------|
|
||||
| 接口名称 | 清空云下载任务 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /clear_task |
|
||||
| 请求方法 | POST |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
按指定类型清空当前授权用户的云下载任务。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/offline/clear_task
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
POST
|
||||
Content-Type: multipart/form-data
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:-------|:-----|:-----|:-------|:-----------------------|:----------|
|
||||
| flag | int | 是 | - | 清空任务类型,见下方枚举表格 | 1 |
|
||||
|
||||
#### 请求参数中的 flag 参数枚举
|
||||
|
||||
| 值 | 说明 | 备注 |
|
||||
|:---|:-----------------------------|:-----|
|
||||
| 0 | 清空已完成任务 | - |
|
||||
| 1 | 清空全部任务 | - |
|
||||
| 2 | 清空失败任务 | - |
|
||||
| 3 | 清空进行中任务 | - |
|
||||
| 4 | 清空已完成任务并删除对应源文件 | - |
|
||||
| 5 | 清空全部任务并删除对应源文件 | - |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl 'https://proapi.115.com/open/offline/clear_task' \
|
||||
-H 'Authorization: Bearer <access_token>' \
|
||||
--form-string 'flag=1'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:--------|:--------|:-----------------|
|
||||
| state | boolean | 操作结果状态 |
|
||||
| message | string | 返回信息 |
|
||||
| code | int | 错误码 |
|
||||
| data | object[] | 返回数据,成功时为空数组 |
|
||||
|
||||
#### 响应的 code 字段(错误码)说明
|
||||
|
||||
| 错误码 | 说明 | 解决方案 |
|
||||
|:-------|:---------|:--------------------------|
|
||||
| 990002 | 参数错误 | 检查 `flag` 是否为0至5的整数 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0,
|
||||
"data": []
|
||||
}
|
||||
```
|
||||
|
||||
### 业务规则
|
||||
|
||||
- `flag=4` 或 `flag=5` 会同时删除对应源文件,操作前需确认清理范围。
|
||||
|
||||
### 性能与安全说明
|
||||
|
||||
- 用户身份由 Bearer access_token 解析,请求参数不能指定115账号。
|
||||
- 接口按应用、用户和接口维度执行频率限制。
|
||||
|
||||
### 注意事项
|
||||
|
||||
- 清空结果以响应中的 `state`、`code` 和 `message` 字段为准。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,101 +0,0 @@
|
||||
## 获取云下载配额信息
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-------------|:----------------------------------|
|
||||
| 接口名称 | 获取云下载配额信息 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /get_quota_info |
|
||||
| 请求方法 | GET |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
获取当前授权用户各类云下载配额的使用情况和过期明细。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/offline/get_quota_info
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
GET
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
无。
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl 'https://proapi.115.com/open/offline/get_quota_info' \
|
||||
-H 'Authorization: Bearer <access_token>'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:--------------------------------------------|:---------|:---------------------|
|
||||
| state | boolean | 状态,true表示成功 |
|
||||
| message | string | 返回信息 |
|
||||
| code | int | 错误码 |
|
||||
| data | object | 云下载配额数据 |
|
||||
| data.package | object[] | 配额类型列表 |
|
||||
| data.package[].surplus | int | 该类型剩余配额 |
|
||||
| data.package[].used | int | 该类型已用配额 |
|
||||
| data.package[].count | int | 该类型总配额 |
|
||||
| data.package[].name | string | 该类型配额名称 |
|
||||
| data.package[].expire_info | object[] | 该类型配额过期明细 |
|
||||
| data.package[].expire_info[].surplus | int | 明细项剩余配额 |
|
||||
| data.package[].expire_info[].expire_time | int | 明细项过期时间 |
|
||||
| data.count | int | 用户总配额数量 |
|
||||
| data.surplus | int | 用户总剩余配额数量 |
|
||||
| data.used | int | 用户总已用配额数量 |
|
||||
|
||||
#### 响应的 code 字段(错误码)说明
|
||||
|
||||
| 错误码 | 说明 | 解决方案 |
|
||||
|:-------|:---------|:-------------|
|
||||
| 990002 | 参数错误 | 检查授权信息 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0,
|
||||
"data": {
|
||||
"package": [],
|
||||
"count": 0,
|
||||
"surplus": 0,
|
||||
"used": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 性能与安全说明
|
||||
|
||||
- 用户身份由 Bearer access_token 解析,请求参数不能指定115账号。
|
||||
- 接口按应用、用户和接口维度执行频率限制。
|
||||
|
||||
### 注意事项
|
||||
|
||||
- 云下载配额以响应中的 `data` 字段为准。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,136 +0,0 @@
|
||||
## 获取用户云下载任务列表
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-------------|:----------------------------------|
|
||||
| 接口名称 | 获取用户云下载任务列表 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /get_task_list |
|
||||
| 请求方法 | GET |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
分页获取当前授权用户的云下载任务列表。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/offline/get_task_list
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
GET
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:-------|:-----|:-----|:-------|:---------|:----------|
|
||||
| page | int | 否 | 1 | 页码 | 1 |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl -G 'https://proapi.115.com/open/offline/get_task_list' \
|
||||
-H 'Authorization: Bearer <access_token>' \
|
||||
--data-urlencode 'page=1'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:----------------------------|:---------|:--------------------------------------|
|
||||
| state | boolean | 状态,true表示成功 |
|
||||
| message | string | 返回信息 |
|
||||
| code | int | 错误码 |
|
||||
| data | object | 分页任务数据 |
|
||||
| data.page | int | 当前页码 |
|
||||
| data.page_count | int | 总页数 |
|
||||
| data.count | int | 任务总数 |
|
||||
| data.tasks | object[] | 云下载任务列表 |
|
||||
| data.tasks[].info_hash | string | 任务SHA1 |
|
||||
| data.tasks[].add_time | int | 任务添加时间戳 |
|
||||
| data.tasks[].percentDone | int | 任务下载进度 |
|
||||
| data.tasks[].size | int | 任务总大小,单位为字节 |
|
||||
| data.tasks[].name | string | 任务名称 |
|
||||
| data.tasks[].last_update | int | 任务最后更新时间戳 |
|
||||
| data.tasks[].file_id | string | 任务源文件或文件夹ID |
|
||||
| data.tasks[].delete_file_id | string | 删除任务并删除源文件时需传递的文件或文件夹ID |
|
||||
| data.tasks[].status | int | 任务状态,见下方枚举表格 |
|
||||
| data.tasks[].url | string | 链接任务URL |
|
||||
| data.tasks[].wp_path_id | string | 任务源文件所在父文件夹ID |
|
||||
| data.tasks[].def2 | int | 视频清晰度,见下方枚举表格 |
|
||||
| data.tasks[].play_long | int | 视频时长 |
|
||||
| data.tasks[].can_appeal | int | 是否可以申诉 |
|
||||
|
||||
#### 响应的 data.tasks[].status 字段枚举
|
||||
|
||||
| 值 | 说明 | 备注 |
|
||||
|:---|:---------|:-----|
|
||||
| -1 | 下载失败 | - |
|
||||
| 0 | 分配中 | - |
|
||||
| 1 | 下载中 | - |
|
||||
| 2 | 下载成功 | - |
|
||||
|
||||
#### 响应的 data.tasks[].def2 字段枚举
|
||||
|
||||
| 值 | 说明 | 备注 |
|
||||
|:----|:------|:-----|
|
||||
| 1 | 标清 | - |
|
||||
| 2 | 高清 | - |
|
||||
| 3 | 超清 | - |
|
||||
| 4 | 1080P | - |
|
||||
| 5 | 4K | - |
|
||||
| 100 | 原画 | - |
|
||||
|
||||
#### 响应的 code 字段(错误码)说明
|
||||
|
||||
| 错误码 | 说明 | 解决方案 |
|
||||
|:-------|:---------|:---------------|
|
||||
| 990002 | 参数错误 | 检查授权信息 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0,
|
||||
"data": {
|
||||
"page": 1,
|
||||
"page_count": 0,
|
||||
"count": 0,
|
||||
"tasks": []
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 业务规则
|
||||
|
||||
- 未传 `page` 或参数值为空时,默认查询第1页。
|
||||
|
||||
### 性能与安全说明
|
||||
|
||||
- 用户身份由 Bearer access_token 解析,请求参数不能指定115账号。
|
||||
- 接口按应用、用户和接口维度执行频率限制。
|
||||
- 任务列表按 `page` 分页,实际返回数量以响应为准。
|
||||
|
||||
### 注意事项
|
||||
|
||||
- 云下载任务状态和字段以响应中的 `data` 字段为准。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,118 +0,0 @@
|
||||
## 解析BT种子
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-------------|:----------------------------------|
|
||||
| 接口名称 | 解析BT种子 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /torrent |
|
||||
| 请求方法 | POST |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
解析已上传的BT种子文件,返回种子任务信息和文件列表。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/offline/torrent
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
POST
|
||||
Content-Type: multipart/form-data
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:-------------|:-------|:-----|:-------|:---------------|:----------------|
|
||||
| torrent_sha1 | string | 是 | - | BT种子文件SHA1 | `<torrent_sha1>` |
|
||||
| pick_code | string | 是 | - | BT种子文件提取码 | `<pick_code>` |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl 'https://proapi.115.com/open/offline/torrent' \
|
||||
-H 'Authorization: Bearer <access_token>' \
|
||||
--form-string 'torrent_sha1=<torrent_sha1>' \
|
||||
--form-string 'pick_code=<pick_code>'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:-------------------------------|:---------|:---------------------|
|
||||
| state | boolean | 状态,true表示成功 |
|
||||
| message | string | 返回信息 |
|
||||
| code | int | 错误码 |
|
||||
| data | object | 种子解析结果 |
|
||||
| data.file_size | int | 任务大小 |
|
||||
| data.torrent_name | string | 任务名称 |
|
||||
| data.file_count | int | 文件数量 |
|
||||
| data.info_hash | string | 任务SHA1 |
|
||||
| data.torrent_filelist | object[] | 文件列表 |
|
||||
| data.torrent_filelist[].size | int | 文件大小 |
|
||||
| data.torrent_filelist[].path | string | 文件路径 |
|
||||
| data.torrent_filelist[].wanted | int | 文件是否默认选中 |
|
||||
|
||||
#### 响应的 code 字段(错误码)说明
|
||||
|
||||
| 错误码 | 说明 | 解决方案 |
|
||||
|:-------|:---------------------|:---------------------------------|
|
||||
| 20018 | 文件不存在或已删除 | 检查提取码、文件归属和种子SHA1 |
|
||||
| 990002 | 参数错误 | 检查必填参数 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0,
|
||||
"data": {
|
||||
"file_size": 0,
|
||||
"torrent_name": "",
|
||||
"file_count": 0,
|
||||
"info_hash": "",
|
||||
"torrent_filelist": [
|
||||
{
|
||||
"size": 0,
|
||||
"path": "",
|
||||
"wanted": 0
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 业务规则
|
||||
|
||||
- 种子文件需属于当前授权用户、位于指定存储区域,并且文件SHA1与 `torrent_sha1` 一致。
|
||||
- 现有开放平台文档建议先将种子文件上传至“云下载/种子文件”文件夹,但该目录不是硬性要求。
|
||||
|
||||
### 性能与安全说明
|
||||
|
||||
- 用户身份由 Bearer access_token 解析,请求参数不能指定115账号。
|
||||
- 接口按应用、用户和接口维度执行频率限制。
|
||||
- 种子文件必须属于当前授权账号,并且文件SHA1与 `torrent_sha1` 一致。
|
||||
|
||||
### 注意事项
|
||||
|
||||
- 种子解析结果以响应中的 `data` 字段为准。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,172 +0,0 @@
|
||||
## 开发者商业价值转化:推广产品得收益
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-------|:--------------------|
|
||||
| 文档名称 | 开发者商业价值转化:推广产品得收益 |
|
||||
| 文档版本 | v1.0 |
|
||||
|
||||
## 一、简介
|
||||
|
||||
为帮助开发者实现商业价值转化,115生活开放平台推出“推广产品得收益”计划,通过“推广有奖、收益共享”的方式,与开发者共同构建可持续发展的开放生态。
|
||||
|
||||
开发者接入标准化服务接口后,可以在用户需要升级使用权限、扩充长期存储空间或增加云下载配额时,引导用户购买对应的 115 增值服务,并基于用户实际购买的产品获取相应推广收益。
|
||||
|
||||
## 二、服务形式说明
|
||||
|
||||
### 1. 标准化服务接口
|
||||
|
||||
标准化服务接口覆盖以下核心场景。
|
||||
|
||||
#### 1.1. VIP 服务
|
||||
|
||||
适用于用户对应功能使用权限不足的场景:
|
||||
|
||||
- 视频播放权限升级:解决非 VIP 用户不支持在线预览视频、年费VIP以下用户不支持视频 4K 超轻转码等权限限制。
|
||||
- 大文件上传权限升级:解决月费VIP以下用户不支持上传 115GB 大文件等权限限制。
|
||||
|
||||
开发者可以引导用户升级至更高的 VIP 类型,以获取对应使用权限。
|
||||
|
||||
#### 1.2. 长期存储空间扩容服务
|
||||
|
||||
适用于用户存储空间不足的场景,可解决因空间容量不足导致文件上传、复制及添加云下载失败等问题。
|
||||
|
||||
开发者可以引导用户购买 VIP 服务以获取更多长期存储空间,或单独购买长期存储空间进行扩容。
|
||||
|
||||
#### 1.3. 云下载配额
|
||||
|
||||
适用于用户云下载配额不足的场景,可解决因服务配额不足导致添加云下载失败等问题。
|
||||
|
||||
开发者可以引导用户升级至更高的 VIP 类型以获取更多云下载配额,或单独购买云下载配额。
|
||||
|
||||
### 2. 收益获取模式
|
||||
|
||||
用户通过开发者应用进入购买页面并成功购买以下任一服务产品后,开发者可以获得对应推广收益:
|
||||
|
||||
- 115生活 VIP 服务,包括月费VIP、年费VIP等。
|
||||
- 长期存储空间扩容。
|
||||
- 云下载配额。
|
||||
|
||||
VIP 服务购买页面示例:
|
||||
|
||||

|
||||
|
||||
长期存储空间扩容购买页面示例:
|
||||
|
||||

|
||||
|
||||
## 三、接入流程
|
||||
|
||||
### 1. 成为开发者
|
||||
|
||||
已成为 115 生活开发者的用户可以直接进行接口接入;未注册的开发者,请先参考[接入流程](../接入指南/接入流程.md)完成注册。
|
||||
|
||||
### 2. 接口接入
|
||||
|
||||
开发者可以调用“获取产品列表地址”接口取得购买页面地址,并在对应业务场景中引导用户访问。
|
||||
|
||||
#### 接口信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-------|:------------|
|
||||
| 接口名称 | 获取产品列表地址 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /vip/qr_url |
|
||||
| 请求方法 | GET |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
该接口用于获取 115 生活开放平台增值服务产品列表地址。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/vip/qr_url
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
GET
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:-------------------|:-------|:---|:-----|:---------------------------|:--------------------------------------------------------|
|
||||
| default_product_id | int | 否 | null | 打开产品列表时默认选中的产品 ID | 月费:`5`;年费:`1`;尝鲜 1 天:`101`;长期VIP(至尊版):`24072401` |
|
||||
| open_device | string | 是 | - | 设备号 | `DEVICE_ID_PLACEHOLDER` |
|
||||
| hide_title | int | 否 | 0 | 是否隐藏购买页推荐人信息:0-不隐藏;1-隐藏 | `0` |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl -G 'https://proapi.115.com/open/vip/qr_url' \
|
||||
-H 'Authorization: Bearer ACCESS_TOKEN_PLACEHOLDER' \
|
||||
--data-urlencode 'default_product_id=1' \
|
||||
--data-urlencode 'open_device=DEVICE_ID_PLACEHOLDER' \
|
||||
--data-urlencode 'hide_title=0'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:----------------|:--------|:--------------|
|
||||
| state | boolean | 状态码,true 表示成功 |
|
||||
| message | string | 响应信息 |
|
||||
| code | int | 错误码 |
|
||||
| data | object | 响应数据 |
|
||||
| data.qrcode_url | string | 开放平台产品列表地址 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0,
|
||||
"data": {
|
||||
"qrcode_url": "PRODUCT_LIST_URL_PLACEHOLDER"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 注意事项
|
||||
|
||||
- 接口根据 `access_token` 识别授权信息,调用方无需额外传入 115 账号和 AppID。
|
||||
- `open_device` 不能为空;未传或传入空值时,接口返回参数错误。
|
||||
- `default_product_id` 未传或为空时,服务端不指定默认产品。
|
||||
- `hide_title` 大于 0 时,服务端会将该参数传递给产品列表服务。
|
||||
- `access_token` 属于敏感凭证,不得写入公开仓库、客户端日志或公开沟通内容。
|
||||
|
||||
### 3. 场景触发与收益
|
||||
|
||||
完成接口接入后,开发者可以在用户使用权限不足、长期存储空间不足或云下载配额不足时触发对应引导。用户完成购买后,开发者可以获得对应推广收益。
|
||||
|
||||
## 四、收益管理与结算
|
||||
|
||||
### 1. 收益查看与提现
|
||||
|
||||
开发者可以登录“115生活-生活-联盟”,或直接访问[115联盟](https://union.115.com/),查看收益明细等推广收益情况并进行提现操作。
|
||||
|
||||

|
||||
|
||||
### 2. 规则说明
|
||||
|
||||
收益计算方式、结算方式和提现流程等详情,参见[联盟规则](https://union.115.com/?ac=help&i=10)。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----------------|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
| 2026年08月05日(周三) 17:30:01 | 恢复业务说明、接入流程及示例图片 |
|
||||
| 2026年08月19日(周三) 11:00:08 | 长期VIP默认产品名称改为至尊版 |
|
||||
@@ -1,79 +0,0 @@
|
||||
## 删除或清空回收站
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-----------|:--------------------------------|
|
||||
| 接口名称 | 删除或清空回收站 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /del |
|
||||
| 请求方法 | POST |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
批量彻底删除回收站中的文件(夹),或在不传 `tid` 时清空回收站。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/rb/del
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
POST
|
||||
Content-Type: multipart/form-data
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:----|:-------|:---|:----|:--------------------------------|:------|
|
||||
| tid | string | 否 | "" | 需要删除的回收站ID,多个ID用半角逗号分隔,最多 1150 个;不传时清空回收站 | 1,2,3,4 |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl 'https://proapi.115.com/open/rb/del' \
|
||||
-H 'Authorization: Bearer access_token' \
|
||||
--form-string 'tid=1,2,3,4'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:--------|:---------|:--------------|
|
||||
| state | boolean | 状态码,true 表示成功 |
|
||||
| message | string | 错误信息 |
|
||||
| code | int | 错误码 |
|
||||
| data | string[] | 响应数据 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0,
|
||||
"data": []
|
||||
}
|
||||
```
|
||||
|
||||
### 注意事项
|
||||
|
||||
- `access_token` 由开放平台授权流程获取,并通过 `Authorization` 请求头传递。
|
||||
- 不传 `tid` 会清空当前授权用户的整个回收站,操作后无法恢复。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,80 +0,0 @@
|
||||
## 删除文件
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-----------|:--------------------------------|
|
||||
| 接口名称 | 删除文件 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /delete |
|
||||
| 请求方法 | POST |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
批量删除文件(夹),删除操作异步执行并将目标移入回收站。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/ufile/delete
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
POST
|
||||
Content-Type: multipart/form-data
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:----------|:-------|:---|:----|:-----------------------|:-------------------------------------------|
|
||||
| file_ids | string | 是 | - | 需要删除的文件(夹)ID,多个ID用半角逗号分隔 | 3073323042143855813,3073323042143855822 |
|
||||
| parent_id | string | 否 | 0 | 待删除文件(夹)所在的父目录ID | 3073311192547189943 |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl 'https://proapi.115.com/open/ufile/delete' \
|
||||
-H 'Authorization: Bearer access_token' \
|
||||
--form-string 'file_ids=3073323042143855813,3073323042143855822' \
|
||||
--form-string 'parent_id=3073311192547189943'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:--------|:---------|:-----------------|
|
||||
| state | boolean | 状态码,true 表示请求已受理 |
|
||||
| message | string | 错误信息 |
|
||||
| code | int | 错误码 |
|
||||
| data | string[] | 响应数据 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0,
|
||||
"data": []
|
||||
}
|
||||
```
|
||||
|
||||
### 注意事项
|
||||
|
||||
- `access_token` 由开放平台授权流程获取,并通过 `Authorization` 请求头传递。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,126 +0,0 @@
|
||||
## 回收站列表
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-----------|:--------------------------------|
|
||||
| 接口名称 | 回收站列表 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /list |
|
||||
| 请求方法 | GET |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
分页获取当前授权用户的回收站文件(夹)列表。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/rb/list
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
GET
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:-------|:----|:---|:----|:--------|:------|
|
||||
| limit | int | 否 | 30 | 单页记录数 | 最大 200 |
|
||||
| offset | int | 否 | 0 | 数据显示偏移量 | 0 |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl -G 'https://proapi.115.com/open/rb/list' \
|
||||
-H 'Authorization: Bearer access_token' \
|
||||
--data-urlencode 'limit=30' \
|
||||
--data-urlencode 'offset=0'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:----------------------|:--------|:-------------------------------|
|
||||
| state | boolean | 状态码,true 表示成功 |
|
||||
| message | string | 错误信息 |
|
||||
| code | int | 错误码 |
|
||||
| data | object | 响应数据 |
|
||||
| data.offset | int | 数据显示偏移量 |
|
||||
| data.limit | int | 单页记录数 |
|
||||
| data.count | string | 回收站文件(夹)总数 |
|
||||
| data.rb_pass | int | 是否设置回收站密码:1-是,0-否 |
|
||||
| data.{回收站ID} | object | 以回收站ID为键的文件(夹)信息 |
|
||||
| data.{回收站ID}.id | string | 回收站ID |
|
||||
| data.{回收站ID}.file_name | string | 文件(夹)名称 |
|
||||
| data.{回收站ID}.type | string | 类型:1-文件,2-文件夹 |
|
||||
| data.{回收站ID}.file_size | string | 文件大小,单位为字节 |
|
||||
| data.{回收站ID}.dtime | string | 删除时间 |
|
||||
| data.{回收站ID}.thumb_url | string | 缩略图地址 |
|
||||
| data.{回收站ID}.status | string | 还原状态:-1-还原中,0-正常 |
|
||||
| data.{回收站ID}.cid | int | 原文件(夹)的父目录ID |
|
||||
| data.{回收站ID}.parent_name | string | 原文件(夹)的父目录名称 |
|
||||
| data.{回收站ID}.pick_code | string | 文件提取码 |
|
||||
| data.{回收站ID}.isv | int | 是否为视频文件,按文件类型返回 |
|
||||
| data.{回收站ID}.def2 | int | 视频清晰度,按文件类型返回 |
|
||||
| data.{回收站ID}.ico | string | 文件扩展名,按文件类型返回 |
|
||||
| data.{回收站ID}.muc | string | 音频封面地址,按文件类型返回 |
|
||||
| data.{回收站ID}.d_img | string | 文档缩略图地址,按文件类型返回 |
|
||||
| data.{回收站ID}.play_long | int | 音视频时长,按文件类型返回 |
|
||||
| data.{回收站ID}.sha1 | string | 文件 SHA1 值,按文件类型返回 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0,
|
||||
"data": {
|
||||
"offset": 0,
|
||||
"limit": 30,
|
||||
"count": "0",
|
||||
"rb_pass": 0,
|
||||
"3074054555277845747": {
|
||||
"id": "3074054555277845747",
|
||||
"file_name": "",
|
||||
"type": "1",
|
||||
"file_size": "0",
|
||||
"dtime": "",
|
||||
"thumb_url": "",
|
||||
"status": "0",
|
||||
"cid": 0,
|
||||
"parent_name": "",
|
||||
"pick_code": "",
|
||||
"isv": 0,
|
||||
"def2": 0,
|
||||
"ico": "",
|
||||
"muc": "",
|
||||
"d_img": "",
|
||||
"play_long": 0,
|
||||
"sha1": ""
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 注意事项
|
||||
|
||||
- `access_token` 由开放平台授权流程获取,并通过 `Authorization` 请求头传递。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
| 2026年08月05日(周三) 17:15:28 | 补充单页记录数上限 |
|
||||
@@ -1,78 +0,0 @@
|
||||
## 回收站还原
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-----------|:--------------------------------|
|
||||
| 接口名称 | 回收站还原 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /revert |
|
||||
| 请求方法 | POST |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
批量还原回收站中的文件(夹)。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/rb/revert
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
POST
|
||||
Content-Type: multipart/form-data
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:----|:-------|:---|:----|:---------------------------|:--------------|
|
||||
| tid | string | 是 | - | 需要还原的回收站ID,多个ID用半角逗号分隔,最多 1150 个 | 111,222,333,444 |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl 'https://proapi.115.com/open/rb/revert' \
|
||||
-H 'Authorization: Bearer access_token' \
|
||||
--form-string 'tid=111,222,333,444'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:--------|:---------|:--------------|
|
||||
| state | boolean | 状态码,true 表示成功 |
|
||||
| message | string | 错误信息 |
|
||||
| code | int | 错误码 |
|
||||
| data | string[] | 响应数据 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0,
|
||||
"data": []
|
||||
}
|
||||
```
|
||||
|
||||
### 注意事项
|
||||
|
||||
- `access_token` 由开放平台授权流程获取,并通过 `Authorization` 请求头传递。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,87 +0,0 @@
|
||||
## 文件(夹)更新
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-----------|:--------------------------------|
|
||||
| 接口名称 | 文件(夹)更新 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /update |
|
||||
| 请求方法 | POST |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
更新文件(夹)名称或星标状态。`file_name` 与 `star` 至少传入一个。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/ufile/update
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
POST
|
||||
Content-Type: multipart/form-data
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:---------|:-------|:---|:----|:----------------------|:------------------|
|
||||
| file_id | string | 是 | - | 需要更新的文件(夹)ID | 3073323042143855813 |
|
||||
| file_name | string | 否 | null | 新的文件(夹)名称,文件夹名称限制 255 字节 | 新的名字 |
|
||||
| star | int | 否 | null | 是否星标:1-星标,0-取消星标 | 1 |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl 'https://proapi.115.com/open/ufile/update' \
|
||||
-H 'Authorization: Bearer access_token' \
|
||||
--form-string 'file_id=3073323042143855813' \
|
||||
--form-string 'file_name=新的名字' \
|
||||
--form-string 'star=1'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:---------------|:--------|:------------------|
|
||||
| state | boolean | 状态码,true 表示成功 |
|
||||
| message | string | 错误信息 |
|
||||
| code | int | 错误码 |
|
||||
| data | object | 响应数据 |
|
||||
| data.file_name | string | 更新后的文件(夹)名称 |
|
||||
| data.star | int | 更新后的星标状态:1-星标,0-取消星标 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0,
|
||||
"data": {
|
||||
"file_name": "新的名字",
|
||||
"star": 1
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 注意事项
|
||||
|
||||
- `access_token` 由开放平台授权流程获取,并通过 `Authorization` 请求头传递。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,41 +0,0 @@
|
||||
# 上传流程
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:---------|:------------------------------|
|
||||
| 文档名称 | 上传流程 |
|
||||
| 文档版本 | v1.0 |
|
||||
| 适用场景 | 115开放平台文件上传 |
|
||||
|
||||
### 文档说明
|
||||
|
||||
本文档说明 115 开放平台的文件秒传、普通上传和断点续传流程。
|
||||
|
||||
## 流程概览
|
||||
|
||||
1. 请求「文件上传」接口初始化上传。
|
||||
2. 若响应中 `status=2`,表示秒传成功,上传流程结束。
|
||||
3. 若响应提示需要二次认证,按 `sign_check` 指定的字节范围计算大写 SHA1,然后携带 `sign_key` 和 `sign_val` 重新请求「文件上传」接口。
|
||||
4. 若 `status=1`,携带初始化响应中的 `bucket`、`object`、`callback` 及「获取上传凭证」接口返回的凭证,向对象存储上传文件。
|
||||
5. 需要续传时,携带初始化响应中的 `pick_code` 及待上传文件信息请求「断点续传」接口,获取新的对象存储上传参数。
|
||||
6. 对象存储返回上传成功后,普通上传或断点续传完成。
|
||||
|
||||
## 相关接口
|
||||
|
||||
- [文件上传](文件上传.md)
|
||||
- [获取上传凭证](获取上传凭证.md)
|
||||
- [断点续传](断点续传.md)
|
||||
- [阿里云 OSS 上传文件说明](https://help.aliyun.com/zh/oss/user-guide/upload-objects-to-oss/)
|
||||
|
||||
## 注意事项
|
||||
|
||||
- 对象存储上传不请求 `proapi.115.com`,应使用「获取上传凭证」和上传调度接口返回的域名、对象标识、临时凭证与回调参数发起请求。
|
||||
- `sign_check` 的起止字节均在 SHA1 计算范围内。例如 `0-99` 表示计算共 100 字节的内容。
|
||||
- 调用开放平台接口时必须携带 `Authorization: Bearer access_token`,并妥善保管临时上传凭证。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,141 +0,0 @@
|
||||
## 文件上传
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:---------|:------------------------------|
|
||||
| 接口名称 | 文件上传 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /upload/init |
|
||||
| 请求方法 | POST |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
初始化断点续传调度,完成秒传判定、二次认证调度或返回对象存储上传参数。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/upload/init
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
POST
|
||||
Content-Type: multipart/form-data
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:----------|:-----|:---|:----|:---------------------------|:--------------------|
|
||||
| file_name | string | 是 | - | 文件名 | 图片.jpg |
|
||||
| file_size | int | 是 | - | 文件大小,单位为字节 | 5335 |
|
||||
| target | string | 是 | - | 文件上传目标 | `U_1_0`,格式为 `U_1_<文件夹ID>` |
|
||||
| fileid | string | 是 | - | 文件 SHA1 值 | `<FILE_SHA1>` |
|
||||
| preid | string | 否 | "" | 文件前 128 KiB 内容的 SHA1 值 | `<PREID_SHA1>` |
|
||||
| path | string | 否 | "" | 上传路径 | "" |
|
||||
| pick_code | string | 否 | "" | 上传任务唯一标识,用于续传 | `<PICK_CODE>` |
|
||||
| topupload | int | 否 | "" | 上传调度文件类型标记,见下方枚举表格 | 0 |
|
||||
| sign_key | string | 否 | "" | 二次认证标识 | `<SIGN_KEY>` |
|
||||
| sign_val | string | 否 | "" | 根据 `sign_check` 计算的大写 SHA1 值 | `<SIGN_VAL>` |
|
||||
|
||||
#### 请求参数中的 topupload 字段枚举
|
||||
|
||||
| 值 | 说明 | 备注 |
|
||||
|:---|:---------------------------|:---|
|
||||
| -1 | 没有上传调度文件类型标记 | - |
|
||||
| 0 | 单文件上传任务,记录一条独立上传记录 | - |
|
||||
| 1 | 文件夹任务的第一个子文件,记录一次文件夹上传 | - |
|
||||
| 2 | 文件夹任务的其他子文件,不单独记录上传记录 | - |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl 'https://proapi.115.com/open/upload/init' \
|
||||
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
||||
-F 'file_name=图片.jpg' \
|
||||
-F 'file_size=5335' \
|
||||
-F 'target=U_1_0' \
|
||||
-F 'fileid=<FILE_SHA1>' \
|
||||
-F 'topupload=0'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:--------------------------|:------|:----------------------------------------|
|
||||
| state | boolean | 状态码,是表示成功,否表示异常 |
|
||||
| message | string | 异常信息 |
|
||||
| code | int | 异常码 |
|
||||
| data | object | 上传调度数据 |
|
||||
| data.status | int | 上传状态:1-非秒传 2-秒传 |
|
||||
| data.code | int | 上传调度状态码 |
|
||||
| data.pick_code | string | 上传任务唯一标识,用于续传 |
|
||||
| data.target | string | 文件上传目标 |
|
||||
| data.bucket | string | 对象存储 bucket |
|
||||
| data.object | string | OSS 对象标识 |
|
||||
| data.callback | object | 上传完成回调数据 |
|
||||
| data.callback.callback | string | 上传完成回调信息 |
|
||||
| data.callback.callback_var | string | 上传完成回调参数 |
|
||||
| data.sign_key | string | 本次二次认证的 SHA1 标识 |
|
||||
| data.sign_check | string | 二次认证所需本地文件 SHA1 计算的字节范围 |
|
||||
| data.file_id | string | 秒传成功时新增文件 ID |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0,
|
||||
"data": {
|
||||
"status": 1,
|
||||
"code": 0,
|
||||
"pick_code": "",
|
||||
"target": "U_1_0",
|
||||
"bucket": "",
|
||||
"object": "",
|
||||
"callback": {
|
||||
"callback": "",
|
||||
"callback_var": ""
|
||||
},
|
||||
"sign_key": "",
|
||||
"sign_check": "",
|
||||
"file_id": ""
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 业务规则
|
||||
|
||||
- `target` 必须匹配 `U_1_<数字文件夹ID>`;`U_1_0` 表示网盘根目录。
|
||||
- 非 VIP 用户单文件大小不得超过 5 GiB;尝鲜VIP、体验VIP用户单文件大小不得超过 15 GiB。
|
||||
- 上传前会检查用户剩余空间和盗播上传封禁状态。
|
||||
- 二次认证调度结果见下表。
|
||||
|
||||
| code | status | 说明 | 后续处理 |
|
||||
|:-----|:-------|:---------|:------|
|
||||
| 700 | 6 | 签名认证后失败 | 按 `sign_check` 截取包含起止字节的文件内容计算大写 SHA1,再传入 `sign_key` 和 `sign_val` |
|
||||
| 701 | 7 | 需要认证签名 | 按 `sign_check` 截取包含起止字节的文件内容计算大写 SHA1,再传入 `sign_key` 和 `sign_val` |
|
||||
| 702 | 8 | 签名认证失败 | 按 `sign_check` 截取包含起止字节的文件内容计算大写 SHA1,再传入 `sign_key` 和 `sign_val` |
|
||||
|
||||
### 注意事项
|
||||
|
||||
- `sign_check` 格式为 `起始字节-结束字节`,起止字节均包含在 SHA1 计算范围内;例如 `2392148-2392298` 需计算该范围内文件内容的 SHA1。
|
||||
- 省略 `topupload` 时,服务端会将其归一化为空字符串;显式传入枚举值时会归一化为整数。
|
||||
- 请妥善保管 `access_token`、上传凭证与回调数据,不要在日志或客户端可见信息中输出。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,110 +0,0 @@
|
||||
## 断点续传
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:---------|:------------------------------|
|
||||
| 接口名称 | 断点续传 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /upload/resume |
|
||||
| 请求方法 | POST |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
根据已有上传任务和待上传文件信息,获取断点续传所需的对象存储上传参数。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/upload/resume
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
POST
|
||||
Content-Type: multipart/form-data
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:----------|:-----|:---|:----|:------------------|:--------------------|
|
||||
| file_size | int | 是 | - | 文件大小,单位为字节 | 5335 |
|
||||
| target | string | 是 | - | 文件上传目标 | `U_1_0`,格式为 `U_1_<文件夹ID>` |
|
||||
| fileid | string | 是 | - | 文件 SHA1 值 | `<FILE_SHA1>` |
|
||||
| pick_code | string | 是 | - | 上传任务唯一标识 | `<PICK_CODE>` |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl 'https://proapi.115.com/open/upload/resume' \
|
||||
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
||||
-F 'file_size=5335' \
|
||||
-F 'target=U_1_0' \
|
||||
-F 'fileid=<FILE_SHA1>' \
|
||||
-F 'pick_code=<PICK_CODE>'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:--------------------------|:------|:----------------------|
|
||||
| state | boolean | 状态码,是表示成功,否表示异常 |
|
||||
| message | string | 异常信息 |
|
||||
| code | int | 异常码 |
|
||||
| data | object | 续传调度数据 |
|
||||
| data.version | string | 上传接口版本 |
|
||||
| data.target | string | 文件上传目标 |
|
||||
| data.pick_code | string | 上传任务唯一标识 |
|
||||
| data.bucket | string | 对象存储 bucket |
|
||||
| data.object | string | OSS 对象标识 |
|
||||
| data.callback | object | 上传完成回调数据 |
|
||||
| data.callback.callback | string | 上传完成回调信息 |
|
||||
| data.callback.callback_var | string | 上传完成回调参数 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0,
|
||||
"data": {
|
||||
"version": "",
|
||||
"target": "U_1_0",
|
||||
"pick_code": "",
|
||||
"bucket": "",
|
||||
"object": "",
|
||||
"callback": {
|
||||
"callback": "",
|
||||
"callback_var": ""
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 业务规则
|
||||
|
||||
- `target` 必须匹配 `U_1_<数字文件夹ID>`;`U_1_0` 表示网盘根目录。
|
||||
- 非 VIP 用户单文件大小不得超过 5 GiB;尝鲜VIP、体验VIP用户单文件大小不得超过 15 GiB。
|
||||
- 续传前会检查用户剩余空间和盗播上传封禁状态。
|
||||
- 上游调度结果的 `status` 只有为 1 或 2 时才按成功响应返回续传参数。
|
||||
|
||||
### 注意事项
|
||||
|
||||
- `pick_code` 必须来自原上传初始化调度响应,并与当前文件信息匹配。
|
||||
- 请妥善保管 `access_token`、上传凭证与回调数据,不要在日志或客户端可见信息中输出。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,87 +0,0 @@
|
||||
## 获取上传凭证
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:---------|:------------------------------|
|
||||
| 接口名称 | 获取上传凭证 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /upload/get_token |
|
||||
| 请求方法 | GET |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
获取对象存储上传域名和临时上传凭证。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/upload/get_token
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
GET
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
无
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl 'https://proapi.115.com/open/upload/get_token' \
|
||||
-H 'Authorization: Bearer <ACCESS_TOKEN>'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:-------------------|:------|:---------------|
|
||||
| state | boolean | 状态码,是表示成功,否表示异常 |
|
||||
| message | string | 异常信息 |
|
||||
| code | int | 异常码 |
|
||||
| data | object | 上传凭证数据 |
|
||||
| data.endpoint | string | 上传域名 |
|
||||
| data.AccessKeySecret | string | 临时上传凭证密钥 |
|
||||
| data.SecurityToken | string | 临时安全令牌 |
|
||||
| data.Expiration | string | 上传凭证过期时间 |
|
||||
| data.AccessKeyId | string | 临时上传凭证 ID |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0,
|
||||
"data": {
|
||||
"endpoint": "",
|
||||
"AccessKeySecret": "",
|
||||
"SecurityToken": "",
|
||||
"Expiration": "",
|
||||
"AccessKeyId": ""
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 注意事项
|
||||
|
||||
- 网页版文档中的密钥字段名存在拼写误差,服务端实际返回字段为 `AccessKeySecret`。
|
||||
- 上传凭证为敏感信息,仅用于当前上传流程;不要写入日志、持久化存储或对外暴露。
|
||||
- 服务端通过当前 `access_token` 识别用户,不接收用户账号请求参数。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,84 +0,0 @@
|
||||
## 文件复制
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-----------|:---------------------------------|
|
||||
| 接口名称 | 文件复制 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /copy |
|
||||
| 请求方法 | POST |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
将一个或多个文件、文件夹复制到指定目录。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/ufile/copy
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
POST
|
||||
Content-Type: multipart/form-data
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:--------|:-------|:---|:----|:------------------------------------|:--------------------|
|
||||
| pid | string | 否 | "0" | 目标目录ID,根目录ID为 `0` | 1054251402869818368 |
|
||||
| file_id | string | 是 | - | 待复制的文件或文件夹ID,多个ID使用半角逗号分隔 | 2323423573680609857 |
|
||||
| nodupli | int | 否 | 0 | 目标目录是否不允许同名:0-允许,1-不允许 | 1 |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl 'https://proapi.115.com/open/ufile/copy' \
|
||||
-H 'Authorization: Bearer access_token' \
|
||||
--form-string 'pid=1054251402869818368' \
|
||||
--form-string 'file_id=2323423573680609857' \
|
||||
--form-string 'nodupli=1'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:--------|:---------|:--------------------|
|
||||
| state | boolean | 接口状态,true表示成功 |
|
||||
| message | string | 异常信息 |
|
||||
| code | int | 异常码 |
|
||||
| data | object[] | 响应数据 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0,
|
||||
"data": []
|
||||
}
|
||||
```
|
||||
|
||||
### 注意事项
|
||||
|
||||
- `pid` 不传或传 `0` 时复制到根目录。
|
||||
- 接口受文件操作频率限制;触发限制时返回异常。
|
||||
- `user_id` 由服务端根据 access token 获取,无需传入。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,121 +0,0 @@
|
||||
## 文件搜索
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-----------|:---------------------------------|
|
||||
| 接口名称 | 文件搜索 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /search |
|
||||
| 请求方法 | GET |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
根据文件名搜索文件或文件夹,支持按目录、文件标签、时间范围和文件类型筛选。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/ufile/search
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
GET
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:------------|:-------|:---|:----|:----------------------------------------------------------|:---------|
|
||||
| search_value | string | 否 | "" | 搜索关键词;与 `file_label` 至少传一个,最多取前40个字符 | "文件" |
|
||||
| limit | int | 否 | 20 | 单页记录数;`offset + limit` 最大不超过10000 | 20 |
|
||||
| offset | int | 否 | 0 | 数据显示偏移量 | 0 |
|
||||
| file_label | string | 否 | "" | 文件标签;与 `search_value` 至少传一个 | "1" |
|
||||
| cid | int | 否 | 0 | 目标目录ID;`-1` 表示不返回任何列表内容 | 0 |
|
||||
| gte_day | string | 否 | "" | 搜索结果匹配的开始日期 | 2020-11-19 |
|
||||
| lte_day | string | 否 | "" | 搜索结果匹配的结束日期 | 2020-11-20 |
|
||||
| fc | int | 否 | 0 | 显示类型:1-只显示文件夹,2-只显示文件,0-全部 | 0 |
|
||||
| type | int | 否 | 0 | 一级筛选大分类,见下方枚举表格 | 1 |
|
||||
| suffix | string | 否 | "" | 一级筛选选择“其他”时填写的后缀名 | "pdf" |
|
||||
|
||||
#### 请求参数中的 type 字段枚举
|
||||
|
||||
| 值 | 说明 | 备注 |
|
||||
|:--|:----|:---|
|
||||
| 1 | 文档 | - |
|
||||
| 2 | 图片 | - |
|
||||
| 3 | 音频 | - |
|
||||
| 4 | 视频 | - |
|
||||
| 5 | 压缩包 | - |
|
||||
| 6 | 应用 | - |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl -G 'https://proapi.115.com/open/ufile/search' \
|
||||
-H 'Authorization: Bearer access_token' \
|
||||
--data-urlencode 'search_value=文件' \
|
||||
--data-urlencode 'limit=20' \
|
||||
--data-urlencode 'offset=0'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:-------------------|:---------|:----------------------------------------|
|
||||
| count | int | 符合条件的文件或文件夹总数 |
|
||||
| data | object[] | 文件或文件夹列表 |
|
||||
| data[].file_id | string | 文件或文件夹ID |
|
||||
| data[].user_id | string | 115账号 |
|
||||
| data[].sha1 | string | 文件SHA-1值 |
|
||||
| data[].file_name | string | 文件或文件夹名称 |
|
||||
| data[].file_size | string | 文件大小 |
|
||||
| data[].user_ptime | string | 上传时间 |
|
||||
| data[].user_utime | string | 更新时间 |
|
||||
| data[].pick_code | string | 文件提取码 |
|
||||
| data[].parent_id | string | 父目录ID |
|
||||
| data[].area_id | string | 文件状态:1-正常,7-已删除(回收站),120-彻底删除 |
|
||||
| data[].is_private | int | 文件是否隐藏:0-未隐藏,1-已隐藏 |
|
||||
| data[].file_category | string | 文件属性:1-文件,0-文件夹 |
|
||||
| data[].ico | string | 文件后缀 |
|
||||
| limit | int | 分页数量 |
|
||||
| offset | int | 偏移量 |
|
||||
| state | boolean | 接口状态,true表示成功 |
|
||||
| message | string | 异常信息 |
|
||||
| code | int | 异常码 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"count": 0,
|
||||
"data": [],
|
||||
"limit": 20,
|
||||
"offset": 0,
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0
|
||||
}
|
||||
```
|
||||
|
||||
### 注意事项
|
||||
|
||||
- `search_value` 与 `file_label` 至少传一个;搜索关键词最多取前40个字符。
|
||||
- 当 `offset + limit` 超过10000时,服务端按 `offset=0`、`limit=115` 查询。
|
||||
- 搜索结果会过滤不属于正常区域的文件;当前账号未开启隐藏文件展示时,也会过滤隐藏文件。
|
||||
- `user_id` 由服务端根据 access token 获取,无需传入。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,91 +0,0 @@
|
||||
## 文件移动
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-----------|:---------------------------------|
|
||||
| 接口名称 | 文件移动 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /move |
|
||||
| 请求方法 | POST |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
将一个或多个文件、文件夹移动到指定目录。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/ufile/move
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
POST
|
||||
Content-Type: multipart/form-data
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:---------|:-------|:---|:----|:------------------------------------|:----------------------------------------|
|
||||
| file_ids | string | 是 | - | 待移动的文件或文件夹ID,多个ID使用半角逗号分隔 | 3073323042143855813,3073323042143855822 |
|
||||
| to_cid | string | 否 | "0" | 目标目录ID;`0` 表示根目录,非 `0` 时必须指向正常可用的目录 | 3073311192547189943 |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl 'https://proapi.115.com/open/ufile/move' \
|
||||
-H 'Authorization: Bearer access_token' \
|
||||
--form-string 'file_ids=3073323042143855813,3073323042143855822' \
|
||||
--form-string 'to_cid=3073311192547189943'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:--------|:---------|:--------------------|
|
||||
| state | boolean | 接口状态,true表示成功 |
|
||||
| message | string | 异常信息 |
|
||||
| code | int | 异常码 |
|
||||
| data | object[] | 响应数据 |
|
||||
|
||||
#### 响应的 code 字段(错误码)说明
|
||||
|
||||
| 错误码 | 说明 | 解决方案 |
|
||||
|:-------|:-----------------------------------|:-----------------------------|
|
||||
| 20009 | 目标目录不存在或目标ID不是目录 | 确认 to_cid 指向存在的目录 |
|
||||
| 20018 | 目标目录不在正常区域或已经删除 | 选择正常可用的目标目录 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0,
|
||||
"data": []
|
||||
}
|
||||
```
|
||||
|
||||
### 注意事项
|
||||
|
||||
- `to_cid` 不传或传 `0` 时移动到根目录。
|
||||
- `to_cid` 非 `0` 时,目标必须是正常可用的目录;目标不存在、不是目录或已经删除时,移动失败。
|
||||
- 接口受文件操作频率限制;触发限制时返回异常。
|
||||
- `user_id` 由服务端根据 access token 获取,无需传入。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:---------------------------------|:---------------------------------------|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
| 2026年08月14日(周五) 15:38:44 | 补充移动目标目录有效性约束及错误码 |
|
||||
@@ -1,86 +0,0 @@
|
||||
## 新建文件夹
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-----------|:---------------------------------|
|
||||
| 接口名称 | 新建文件夹 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /add |
|
||||
| 请求方法 | POST |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
在指定父目录下新建文件夹。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/folder/add
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
POST
|
||||
Content-Type: multipart/form-data
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:---------|:-------|:---|:----|:---------------------------|:--------------------|
|
||||
| pid | string | 否 | "0" | 父目录ID,根目录ID为 `0` | 3073323042143855813 |
|
||||
| file_name | string | 是 | - | 文件夹名称,最多255个字符 | 新建文件夹名称 |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl 'https://proapi.115.com/open/folder/add' \
|
||||
-H 'Authorization: Bearer access_token' \
|
||||
--form-string 'pid=3073323042143855813' \
|
||||
--form-string 'file_name=新建文件夹名称'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:---------------|:--------|:----------------------|
|
||||
| state | boolean | 接口状态,true表示成功 |
|
||||
| message | string | 异常信息 |
|
||||
| code | int | 异常码 |
|
||||
| data | object | 响应数据 |
|
||||
| data.file_name | string | 新建的文件夹名称 |
|
||||
| data.file_id | string | 新建的文件夹ID |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0,
|
||||
"data": {
|
||||
"file_name": "",
|
||||
"file_id": ""
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 注意事项
|
||||
|
||||
- `pid` 不传或传 `0` 时在根目录下新建文件夹。
|
||||
- `user_id` 由服务端根据 access token 获取,无需传入。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,114 +0,0 @@
|
||||
## 按ID获取
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-----------|:---------------------------------|
|
||||
| 接口名称 | 按ID获取 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /get_info |
|
||||
| 请求方法 | GET |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
根据文件或文件夹ID获取详情。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/folder/get_info
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
GET
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:---------|:-------|:---|:----|:----------|:--------------------|
|
||||
| file_id | string | 是 | - | 文件或文件夹ID | 1288444975268439877 |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl -G 'https://proapi.115.com/open/folder/get_info' \
|
||||
-H 'Authorization: Bearer access_token' \
|
||||
--data-urlencode 'file_id=1288444975268439877'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:----------------------|:---------|:----------------------------------------|
|
||||
| state | boolean | 接口状态,true表示成功 |
|
||||
| message | string | 异常信息 |
|
||||
| code | int | 异常码 |
|
||||
| data | object | 文件或文件夹详情 |
|
||||
| data.count | int | 包含的文件总数 |
|
||||
| data.size | string | 文件或文件夹总大小 |
|
||||
| data.size_byte | int | 文件或文件夹总大小,单位为字节 |
|
||||
| data.folder_count | int | 包含的文件夹总数 |
|
||||
| data.play_long | int | 视频时长;`-1` 表示正在统计,其他数值单位为秒 |
|
||||
| data.show_play_long | int | 是否开启展示视频时长 |
|
||||
| data.ptime | string | 上传时间 |
|
||||
| data.utime | string | 修改时间 |
|
||||
| data.file_name | string | 文件或文件夹名称 |
|
||||
| data.pick_code | string | 文件提取码 |
|
||||
| data.sha1 | string | 文件SHA-1值 |
|
||||
| data.file_id | string | 文件或文件夹ID |
|
||||
| data.is_mark | string | 是否星标 |
|
||||
| data.open_time | int | 文件或文件夹最近打开时间 |
|
||||
| data.file_category | string | 文件属性:1-文件,0-文件夹 |
|
||||
| data.paths | object[] | 文件或文件夹所在路径 |
|
||||
| data.paths[].file_id | string | 父目录ID |
|
||||
| data.paths[].file_name | string | 父目录名称 |
|
||||
| data.paths[].iss | int | 父目录共享状态标识 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0,
|
||||
"data": {
|
||||
"count": 0,
|
||||
"size": "",
|
||||
"size_byte": 0,
|
||||
"folder_count": 0,
|
||||
"play_long": 0,
|
||||
"show_play_long": 0,
|
||||
"ptime": "",
|
||||
"utime": "",
|
||||
"file_name": "",
|
||||
"pick_code": "",
|
||||
"sha1": "",
|
||||
"file_id": "",
|
||||
"is_mark": "",
|
||||
"open_time": 0,
|
||||
"file_category": "",
|
||||
"paths": []
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 注意事项
|
||||
|
||||
- 文件或文件夹已进入回收站或被彻底删除时,接口返回异常。
|
||||
- `user_id` 由服务端根据 access token 获取,无需传入。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,115 +0,0 @@
|
||||
## 按路径获取
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-----------|:---------------------------------|
|
||||
| 接口名称 | 按路径获取 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /get_info |
|
||||
| 请求方法 | POST |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
根据文件或文件夹路径获取详情。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/folder/get_info
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
POST
|
||||
Content-Type: multipart/form-data
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:----|:-------|:---|:----|:----------------------------------------------------------------|:-------------------|
|
||||
| path | string | 是 | - | 文件路径,支持 `/`、`>` 两种分隔符;路径需以分隔符开头,并用同一分隔符分隔目录层级 | /a/b/c.png 或 >a>b>c |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl 'https://proapi.115.com/open/folder/get_info' \
|
||||
-H 'Authorization: Bearer access_token' \
|
||||
--form-string 'path=/a/b/c.png'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:----------------------|:---------|:----------------------------------------|
|
||||
| state | boolean | 接口状态,true表示成功 |
|
||||
| message | string | 异常信息 |
|
||||
| code | int | 异常码 |
|
||||
| data | object | 文件或文件夹详情 |
|
||||
| data.count | int | 包含的文件总数 |
|
||||
| data.size | string | 文件或文件夹总大小 |
|
||||
| data.size_byte | int | 文件或文件夹总大小,单位为字节 |
|
||||
| data.folder_count | int | 包含的文件夹总数 |
|
||||
| data.play_long | int | 视频时长;`-1` 表示正在统计,其他数值单位为秒 |
|
||||
| data.show_play_long | int | 是否开启展示视频时长 |
|
||||
| data.ptime | string | 上传时间 |
|
||||
| data.utime | string | 修改时间 |
|
||||
| data.file_name | string | 文件或文件夹名称 |
|
||||
| data.pick_code | string | 文件提取码 |
|
||||
| data.sha1 | string | 文件SHA-1值 |
|
||||
| data.file_id | string | 文件或文件夹ID |
|
||||
| data.is_mark | string | 是否星标 |
|
||||
| data.open_time | int | 文件或文件夹最近打开时间 |
|
||||
| data.file_category | string | 文件属性:1-文件,0-文件夹 |
|
||||
| data.paths | object[] | 文件或文件夹所在路径 |
|
||||
| data.paths[].file_id | string | 父目录ID |
|
||||
| data.paths[].file_name | string | 父目录名称 |
|
||||
| data.paths[].iss | int | 父目录共享状态标识 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0,
|
||||
"data": {
|
||||
"count": 0,
|
||||
"size": "",
|
||||
"size_byte": 0,
|
||||
"folder_count": 0,
|
||||
"play_long": 0,
|
||||
"show_play_long": 0,
|
||||
"ptime": "",
|
||||
"utime": "",
|
||||
"file_name": "",
|
||||
"pick_code": "",
|
||||
"sha1": "",
|
||||
"file_id": "",
|
||||
"is_mark": "",
|
||||
"open_time": 0,
|
||||
"file_category": "",
|
||||
"paths": []
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 注意事项
|
||||
|
||||
- 文件或文件夹已进入回收站或被彻底删除时,接口返回异常。
|
||||
- `user_id` 由服务端根据 access token 获取,无需传入。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,98 +0,0 @@
|
||||
## 获取文件下载地址
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-----------|:--------------------------------|
|
||||
| 接口名称 | 获取文件下载地址 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /downurl |
|
||||
| 请求方法 | POST |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
根据文件提取码获取文件下载地址。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/ufile/downurl
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
POST
|
||||
Content-Type: multipart/form-data
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:---------|:-------|:---|:----|:------|:-----------------|
|
||||
| pick_code | string | 是 | - | 文件提取码,多个提取码用半角逗号分隔 | dtctprlmfkl4exiok |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl 'https://proapi.115.com/open/ufile/downurl' \
|
||||
-H 'Authorization: Bearer access_token' \
|
||||
--form-string 'pick_code=dtctprlmfkl4exiok'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:---------------------------|:--------|:---------------------------|
|
||||
| state | boolean | 状态码,true 表示成功 |
|
||||
| message | string | 错误信息 |
|
||||
| code | int | 错误码 |
|
||||
| errno | int | 下载地址获取失败时返回的错误码 |
|
||||
| data | object | 响应数据 |
|
||||
| data.{文件ID} | object | 以文件ID为键的文件下载信息 |
|
||||
| data.{文件ID}.file_name | string | 文件名 |
|
||||
| data.{文件ID}.file_size | int | 文件大小,单位为字节 |
|
||||
| data.{文件ID}.pick_code | string | 文件提取码 |
|
||||
| data.{文件ID}.sha1 | string | 文件 SHA1 值 |
|
||||
| data.{文件ID}.url | object | 下载地址信息 |
|
||||
| data.{文件ID}.url.url | string | 文件下载地址 |
|
||||
| data.can_appeal | boolean | 文件违规时是否可以申诉,按错误场景返回 |
|
||||
| data.want_appeal_id | string | 文件违规时的申诉标识,按错误场景返回 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0,
|
||||
"data": {
|
||||
"2323423573680609857": {
|
||||
"file_name": "",
|
||||
"file_size": 0,
|
||||
"pick_code": "",
|
||||
"sha1": "",
|
||||
"url": {
|
||||
"url": ""
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 注意事项
|
||||
|
||||
- `access_token` 由开放平台授权流程获取,并通过 `Authorization` 请求头传递。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,204 +0,0 @@
|
||||
## 获取文件列表
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-----------|:---------------------------------|
|
||||
| 接口名称 | 获取文件列表 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /files |
|
||||
| 请求方法 | GET |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
获取指定目录中的文件和文件夹列表,支持分页、排序以及按文件类型、后缀名和星标状态筛选。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/ufile/files
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
GET
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:-----------|:-------|:---|:----------|:-------------------------------------------------------|:----------|
|
||||
| cid | string | 否 | "0" | 目录ID,对应 `parent_id`;根目录ID为 `0` | "0" |
|
||||
| type | int | 否 | 0 | 文件类型,见下方枚举表格 | 1 |
|
||||
| limit | int | 否 | 20 | 查询数量,最大1150 | 20 |
|
||||
| offset | int | 否 | 0 | 查询起始位置 | 0 |
|
||||
| suffix | string | 否 | "" | 文件后缀名 | "pdf" |
|
||||
| asc | int | 否 | 0 | 排序方向:1-升序,0-降序 | 0 |
|
||||
| o | string | 否 | user_ptime | 排序字段,见下方枚举表格 | file_name |
|
||||
| custom_order | int | 否 | 0 | 排序模式,见下方枚举表格 | 0 |
|
||||
| stdir | int | 否 | 0 | 筛选文件时是否显示文件夹:1-显示,0-不显示 | 1 |
|
||||
| star | int | 否 | 0 | 星标筛选:1-仅显示星标文件,0-全部 | 0 |
|
||||
| cur | int | 否 | 0 | 是否只显示当前文件夹内的文件:1-是,0-否 | 1 |
|
||||
| show_dir | int | 否 | 0 | 是否显示目录:1-是,0-否 | 0 |
|
||||
|
||||
#### 请求参数中的 type 字段枚举
|
||||
|
||||
| 值 | 说明 | 备注 |
|
||||
|:--|:----|:---|
|
||||
| 1 | 文档 | - |
|
||||
| 2 | 图片 | - |
|
||||
| 3 | 音频 | - |
|
||||
| 4 | 视频 | - |
|
||||
| 5 | 压缩包 | - |
|
||||
| 6 | 应用 | - |
|
||||
| 7 | 书籍 | - |
|
||||
|
||||
#### 请求参数中的 o 字段枚举
|
||||
|
||||
| 值 | 说明 | 备注 |
|
||||
|:-----------|:-------|:---|
|
||||
| file_name | 文件名 | - |
|
||||
| file_size | 文件大小 | - |
|
||||
| user_ptime | 上传时间 | 默认值 |
|
||||
| user_utime | 更新时间 | - |
|
||||
| file_type | 文件类型 | - |
|
||||
|
||||
#### 请求参数中的 custom_order 字段枚举
|
||||
|
||||
| 值 | 说明 | 备注 |
|
||||
|:--|:----------------------|:---|
|
||||
| 0 | 使用记忆排序,自定义排序失效 | 默认值 |
|
||||
| 1 | 使用自定义排序,不使用记忆排序 | - |
|
||||
| 2 | 使用自定义排序,非文件夹置顶 | - |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl -G 'https://proapi.115.com/open/ufile/files' \
|
||||
-H 'Authorization: Bearer access_token' \
|
||||
--data-urlencode 'cid=0' \
|
||||
--data-urlencode 'limit=20' \
|
||||
--data-urlencode 'offset=0'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:----------------------|:---------|:----------------------------------------------------------|
|
||||
| data | object[] | 文件和文件夹列表 |
|
||||
| data[].fid | string | 文件或文件夹ID |
|
||||
| data[].aid | string | 文件状态:1-正常,7-已删除(回收站),120-彻底删除 |
|
||||
| data[].pid | string | 父目录ID |
|
||||
| data[].fc | string | 文件分类:0-文件夹,1-文件 |
|
||||
| data[].fn | string | 文件或文件夹名称 |
|
||||
| data[].fco | string | 文件夹封面 |
|
||||
| data[].ism | string | 是否星标,1表示星标 |
|
||||
| data[].isp | int | 是否加密,1表示加密 |
|
||||
| data[].pc | string | 文件提取码 |
|
||||
| data[].upt | int | 修改时间 |
|
||||
| data[].uet | int | 修改时间 |
|
||||
| data[].uppt | int | 上传时间 |
|
||||
| data[].cm | int | 特殊目录标识 |
|
||||
| data[].fdesc | string | 文件备注 |
|
||||
| data[].ispl | int | 是否统计文件夹下视频时长 |
|
||||
| data[].fl | object[] | 文件标签 |
|
||||
| data[].fl[].id | string | 文件标签ID |
|
||||
| data[].fl[].name | string | 文件标签名称 |
|
||||
| data[].fl[].sort | string | 文件标签排序 |
|
||||
| data[].fl[].color | string | 文件标签颜色 |
|
||||
| data[].fl[].is_default | int | 文件标签类型:0-最近使用,1-非最近使用,2-默认标签 |
|
||||
| data[].fl[].update_time | int | 文件标签更新时间 |
|
||||
| data[].fl[].create_time | int | 文件标签创建时间 |
|
||||
| data[].sha1 | string | 文件SHA-1值 |
|
||||
| data[].fs | int | 文件大小,单位为字节 |
|
||||
| data[].fta | string | 文件状态:0或2-未上传完成,1-已上传完成 |
|
||||
| data[].ico | string | 文件后缀名 |
|
||||
| data[].fatr | string | 音频长度 |
|
||||
| data[].isv | int | 是否为视频 |
|
||||
| data[].def | int | 视频清晰度:1-标清,2-高清,3-超清,4-1080P,5-4K,100-原画 |
|
||||
| data[].def2 | int | 视频清晰度:1-标清,2-高清,3-超清,4-1080P,5-4K,100-原画 |
|
||||
| data[].play_long | int | 音视频时长,单位为秒 |
|
||||
| data[].v_img | string | 视频缩略图地址 |
|
||||
| data[].thumb | string | 图片缩略图地址 |
|
||||
| data[].uo | string | 原图地址 |
|
||||
| count | int | 当前目录文件数量 |
|
||||
| sys_count | int | 系统文件夹数量 |
|
||||
| offset | int | 偏移量 |
|
||||
| limit | int | 分页数量 |
|
||||
| aid | string | 文件状态:1-正常,7-已删除(回收站),120-彻底删除 |
|
||||
| cid | int | 父目录ID |
|
||||
| is_asc | int | 排序方向:1-升序,0-降序 |
|
||||
| min_size | int | 最小文件大小筛选值 |
|
||||
| max_size | int | 最大文件大小筛选值 |
|
||||
| sys_dir | string | 系统目录 |
|
||||
| hide_data | string | 是否返回文件数据 |
|
||||
| record_open_time | string | 是否记录文件夹打开时间 |
|
||||
| star | int | 是否星标:1-星标,0-未星标 |
|
||||
| type | int | 一级筛选大分类,见请求参数中的 `type` 字段枚举 |
|
||||
| suffix | string | 一级筛选选择“其他”时填写的后缀名 |
|
||||
| path | object[] | 父目录树 |
|
||||
| path[].name | string | 父目录名称 |
|
||||
| path[].aid | int | 父目录文件状态 |
|
||||
| path[].cid | int | 父目录ID |
|
||||
| path[].pid | int | 上级父目录ID |
|
||||
| path[].isp | int | 父目录是否加密 |
|
||||
| path[].p_cid | string | 父目录路径标识 |
|
||||
| path[].fv | string | 父目录属性 |
|
||||
| cur | int | 是否只显示当前文件夹内的文件 |
|
||||
| stdir | int | 筛选文件时是否显示文件夹 |
|
||||
| fields | string | 指定返回字段 |
|
||||
| order | string | 实际使用的排序字段 |
|
||||
| state | boolean | 接口状态,true表示成功 |
|
||||
| code | int | 异常码 |
|
||||
| message | string | 异常信息 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"data": [],
|
||||
"count": 0,
|
||||
"sys_count": 0,
|
||||
"offset": 0,
|
||||
"limit": 20,
|
||||
"aid": "1",
|
||||
"cid": 0,
|
||||
"is_asc": 0,
|
||||
"min_size": 0,
|
||||
"max_size": 0,
|
||||
"sys_dir": "",
|
||||
"hide_data": "",
|
||||
"record_open_time": "",
|
||||
"star": 0,
|
||||
"type": 0,
|
||||
"suffix": "",
|
||||
"path": [],
|
||||
"cur": 0,
|
||||
"stdir": 0,
|
||||
"fields": "",
|
||||
"order": "user_ptime",
|
||||
"state": true,
|
||||
"code": 0,
|
||||
"message": ""
|
||||
}
|
||||
```
|
||||
|
||||
### 注意事项
|
||||
|
||||
- `limit` 最大为1150。
|
||||
- 当 `cid` 指向不存在或已删除的目录时,接口返回异常;当目录为加密目录时,不返回目录内容。
|
||||
- `user_id` 由服务端根据 access token 获取,无需传入。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,140 +0,0 @@
|
||||
## 用户信息
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:---------|:------------------------------|
|
||||
| 接口名称 | 用户信息 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /user/info |
|
||||
| 请求方法 | GET |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
获取当前授权用户的基本信息、网盘空间信息、VIP 等级信息以及第三方畅用权益信息。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/user/info
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
GET
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
无
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl 'https://proapi.115.com/open/user/info' \
|
||||
-H 'Authorization: Bearer <ACCESS_TOKEN>'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:----------------------------------------|:------|:----------------------------------------|
|
||||
| state | boolean | 状态码,是表示成功,否表示异常 |
|
||||
| message | string | 异常信息 |
|
||||
| code | int | 异常码 |
|
||||
| data | object | 响应数据 |
|
||||
| data.user_id | int | 用户115账号 |
|
||||
| data.user_name | string | 用户名称 |
|
||||
| data.user_face_s | string | 小尺寸用户头像 |
|
||||
| data.user_face_m | string | 中尺寸用户头像 |
|
||||
| data.user_face_l | string | 大尺寸用户头像 |
|
||||
| data.rt_space_info | object | 用户实时空间信息 |
|
||||
| data.rt_space_info.all_total | object | 用户总空间 |
|
||||
| data.rt_space_info.all_total.size | int | 用户总空间大小,单位为字节 |
|
||||
| data.rt_space_info.all_total.size_format | string | 用户总空间大小,格式化文本 |
|
||||
| data.rt_space_info.all_remain | object | 用户剩余空间 |
|
||||
| data.rt_space_info.all_remain.size | int | 用户剩余空间大小,单位为字节 |
|
||||
| data.rt_space_info.all_remain.size_format | string | 用户剩余空间大小,格式化文本 |
|
||||
| data.rt_space_info.all_use | object | 用户已使用空间 |
|
||||
| data.rt_space_info.all_use.size | int | 用户已使用空间大小,单位为字节 |
|
||||
| data.rt_space_info.all_use.size_format | string | 用户已使用空间大小,格式化文本 |
|
||||
| data.vip_info | object | 用户 VIP 等级信息 |
|
||||
| data.vip_info.level_name | string | VIP 等级名称,见下方枚举表格 |
|
||||
| data.vip_info.expire | int | VIP 过期时间戳,无 VIP 时为 0 |
|
||||
| data.vip_info.tp_rights | object | 第三方畅用权益信息 |
|
||||
| data.vip_info.tp_rights.is_tp_rights | int | 是否具有当前应用的第三方畅用权益:0-否 1-是 |
|
||||
| data.vip_info.tp_rights.tp_rights_time | int | 第三方畅用权益过期时间戳,无有效权益时为 0 |
|
||||
|
||||
#### 响应的 data.vip_info.level_name 字段枚举
|
||||
|
||||
| 值 | 说明 | 备注 |
|
||||
|:----------|:---|:---|
|
||||
| 原石会员 | 原石用户 | 无有效 VIP 等级时的服务端固定返回值 |
|
||||
| 尝鲜VIP | 尝鲜VIP | - |
|
||||
| 体验VIP | 体验VIP | - |
|
||||
| 月费VIP | 月费VIP | - |
|
||||
| 年费VIP | 年费VIP | - |
|
||||
| 长期VIP(高级版) | 长期VIP(高级版) | - |
|
||||
| 长期VIP(特级版) | 长期VIP(特级版) | - |
|
||||
| 长期VIP(超级版) | 长期VIP(超级版) | - |
|
||||
| 长期VIP(至尊版) | 长期VIP(至尊版) | - |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0,
|
||||
"data": {
|
||||
"user_id": 0,
|
||||
"user_name": "",
|
||||
"user_face_s": "",
|
||||
"user_face_m": "",
|
||||
"user_face_l": "",
|
||||
"rt_space_info": {
|
||||
"all_total": {
|
||||
"size": 0,
|
||||
"size_format": ""
|
||||
},
|
||||
"all_remain": {
|
||||
"size": 0,
|
||||
"size_format": ""
|
||||
},
|
||||
"all_use": {
|
||||
"size": 0,
|
||||
"size_format": ""
|
||||
}
|
||||
},
|
||||
"vip_info": {
|
||||
"expire": 0,
|
||||
"level_name": "原石会员",
|
||||
"tp_rights": {
|
||||
"is_tp_rights": 0,
|
||||
"tp_rights_time": 0
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 注意事项
|
||||
|
||||
- `access_token` 决定当前用户和开放应用,接口不接收用户账号请求参数。
|
||||
- `rt_space_info` 为实时空间数据,`all_use` 由总空间减去剩余空间计算得出。
|
||||
- 请妥善保管 `access_token`,不要在日志或客户端可见信息中输出。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
| 2026年08月18日(周二) 14:40:25 | 更新四种长期VIP等级名称枚举 |
|
||||
@@ -1,88 +0,0 @@
|
||||
## 提交视频转码
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-------------|:--------------------------------|
|
||||
| 接口名称 | 提交视频转码 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /video_push |
|
||||
| 请求方法 | POST |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
按 VIP 等级或消耗枫币提交视频加速转码。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/video/video_push
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
POST
|
||||
Content-Type: multipart/form-data
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:----------|:-------|:---|:----|:----------------------------------------|:-----------------|
|
||||
| pick_code | string | 是 | - | 视频文件提取码 | b53gu6z3hvqji8wrm |
|
||||
| op | string | 是 | - | 加速转码方式,`vip_push`:按 VIP 等级加速;`pay_push`:消耗枫币加速 | vip_push |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl 'https://proapi.115.com/open/video/video_push' \
|
||||
-H 'Authorization: Bearer <access_token>' \
|
||||
-F 'pick_code=b53gu6z3hvqji8wrm' \
|
||||
-F 'op=vip_push'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:------|:---------|:----------------------|
|
||||
| state | boolean | 操作结果状态,true:成功;false:失败 |
|
||||
| message | string | 返回信息,成功时为空字符串 |
|
||||
| code | int | 错误码 |
|
||||
| data | object[] | 响应数据,成功时为空数组 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0,
|
||||
"data": []
|
||||
}
|
||||
```
|
||||
|
||||
### 业务规则
|
||||
|
||||
- 仅支持为当前授权用户所属的视频文件提交加速转码。
|
||||
- 已完成转码的视频无需重复提交。
|
||||
- 两种加速转码方式均要求当前用户具备 VIP 权益;`pay_push` 在枫币余额不足时提交失败。
|
||||
- 提交成功后,系统通知转码服务重新计算排队信息,并在 3 小时内记录已加速状态。
|
||||
|
||||
### 注意事项
|
||||
|
||||
- `access_token` 通过 `Authorization` 请求头传递,请将请求示例中的占位符替换为实际访问令牌。
|
||||
- 请勿对同一视频重复提交加速转码。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,125 +0,0 @@
|
||||
## 获取视频在线播放地址
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-------------|:--------------------------------|
|
||||
| 接口名称 | 获取视频在线播放地址 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /play |
|
||||
| 请求方法 | GET |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
获取指定视频的在线播放地址、清晰度、音轨及文件基础信息。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/video/play
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
GET
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:----------|:-------|:---|:----|:----------|:-----------------|
|
||||
| pick_code | string | 是 | - | 视频文件提取码 | b53gu6z3hvqji8wrm |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl -G 'https://proapi.115.com/open/video/play' \
|
||||
-H 'Authorization: Bearer <access_token>' \
|
||||
--data-urlencode 'pick_code=b53gu6z3hvqji8wrm'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:---------------------------------|:---------|:----------------------------------------|
|
||||
| state | boolean | 操作结果状态,true:成功;false:失败 |
|
||||
| message | string | 返回信息,成功时为空字符串 |
|
||||
| code | int | 错误码 |
|
||||
| data | object | 视频播放及文件数据 |
|
||||
| data.file_id | string | 文件ID |
|
||||
| data.parent_id | string | 文件父目录ID |
|
||||
| data.file_name | string | 文件名称 |
|
||||
| data.file_size | string | 文件大小,单位为字节 |
|
||||
| data.file_sha1 | string | 文件哈希值 |
|
||||
| data.file_type | string | 文件类型 |
|
||||
| data.is_private | string | 文件是否加密隐藏,0:否;1:是 |
|
||||
| data.play_long | string | 视频时长 |
|
||||
| data.user_def | int | 记忆的清晰度,1:标清;2:高清;3:超清;4:1080P;5:4K;100:原画 |
|
||||
| data.user_rotate | int | 记忆的视频旋转角度,取值为 0、90、180、270 |
|
||||
| data.user_turn | int | 视频翻转方向,0:不翻转;1:水平翻转;2:垂直翻转 |
|
||||
| data.multitrack_list | object | 多音轨列表,键为音轨序号 |
|
||||
| data.multitrack_list.*.title | string | 音轨标题 |
|
||||
| data.multitrack_list.*.is_selected | string | 音轨是否为上次选中,1:是 |
|
||||
| data.multitrack_list.*.sync_time | string | 音轨同步时间 |
|
||||
| data.definition_list | object | 清晰度列表,键为清晰度值,值为清晰度名称 |
|
||||
| data.definition_list_new | object | 新版清晰度列表,键为清晰度值,值为清晰度名称 |
|
||||
| data.video_url | object[] | 各清晰度的播放地址信息 |
|
||||
| data.video_url[].url | string | 播放地址 |
|
||||
| data.video_url[].height | int | 视频高度 |
|
||||
| data.video_url[].width | int | 视频宽度 |
|
||||
| data.video_url[].definition | int | 视频清晰度 |
|
||||
| data.video_url[].title | string | 视频清晰度名称 |
|
||||
| data.video_url[].definition_n | int | 新版视频清晰度 |
|
||||
| data.video_push_state | boolean | 视频尚未完成转码时是否已提交加速转码,仅对应失败响应返回 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0,
|
||||
"data": {
|
||||
"file_id": "",
|
||||
"parent_id": "",
|
||||
"file_name": "",
|
||||
"file_size": "0",
|
||||
"file_sha1": "",
|
||||
"file_type": "",
|
||||
"is_private": "0",
|
||||
"play_long": "0",
|
||||
"user_def": 0,
|
||||
"user_rotate": 0,
|
||||
"user_turn": 0,
|
||||
"multitrack_list": {},
|
||||
"definition_list": {},
|
||||
"definition_list_new": {},
|
||||
"video_url": []
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 业务规则
|
||||
|
||||
- 切换音轨时,在返回的播放地址后增加整型参数 `audio_track`,参数值取 `multitrack_list` 对应的键;音轨下标从 `0` 开始。
|
||||
- 年费VIP以下用户不支持播放 4K 视频;选择 4K 清晰度时会返回引导升级的视频地址。
|
||||
- 接口不返回下载地址字段 `down_url`。
|
||||
|
||||
### 注意事项
|
||||
|
||||
- `access_token` 通过 `Authorization` 请求头传递,请将请求示例中的占位符替换为实际访问令牌。
|
||||
- 播放地址具有时效性,请勿缓存或向无关方披露。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,96 +0,0 @@
|
||||
## 获取视频播放进度
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-------------|:--------------------------------|
|
||||
| 接口名称 | 获取视频播放进度 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /history |
|
||||
| 请求方法 | GET |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
获取指定视频已记录的播放进度。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/video/history
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
GET
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:----------|:-------|:---|:----|:----------|:-----------------|
|
||||
| pick_code | string | 是 | - | 视频文件提取码 | b53gu6z3hvqji8wrm |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl -G 'https://proapi.115.com/open/video/history' \
|
||||
-H 'Authorization: Bearer <access_token>' \
|
||||
--data-urlencode 'pick_code=b53gu6z3hvqji8wrm'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:-------------|:--------|:-----------------------------|
|
||||
| state | boolean | 操作结果状态,true:成功;false:失败 |
|
||||
| message | string | 返回信息,成功时为空字符串 |
|
||||
| code | int | 错误码 |
|
||||
| data | object | 播放进度数据;没有记录时为空数组 |
|
||||
| data.add_time | int | 记录添加时间,Unix 时间戳 |
|
||||
| data.file_id | string | 文件ID |
|
||||
| data.file_name | string | 文件名称 |
|
||||
| data.hash | string | 文件哈希值 |
|
||||
| data.pick_code | string | 文件提取码 |
|
||||
| data.time | int | 已播放时长,单位为秒 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0,
|
||||
"data": {
|
||||
"add_time": 0,
|
||||
"file_id": "",
|
||||
"file_name": "",
|
||||
"hash": "",
|
||||
"pick_code": "b53gu6z3hvqji8wrm",
|
||||
"time": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 业务规则
|
||||
|
||||
- 接口只返回当前 `pick_code` 对应的单条播放进度记录。
|
||||
- 视频是否播放完毕可通过文件列表中的 `played_end` 字段查看,`1` 表示已播放完毕。
|
||||
|
||||
### 注意事项
|
||||
|
||||
- `access_token` 通过 `Authorization` 请求头传递,请将请求示例中的占位符替换为实际访问令牌。
|
||||
- `pick_code` 对应的文件不存在或不在有效文件区域时,接口返回失败。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,119 +0,0 @@
|
||||
## 视频字幕列表
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-------------|:--------------------------------|
|
||||
| 接口名称 | 视频字幕列表 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /subtitle |
|
||||
| 请求方法 | GET |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
获取指定视频的自动载入字幕和可用字幕列表。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/video/subtitle
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
GET
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:----------|:-------|:---|:----|:----------|:-----------------|
|
||||
| pick_code | string | 是 | - | 视频文件提取码 | b53gu6z3hvqji8wrm |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl -G 'https://proapi.115.com/open/video/subtitle' \
|
||||
-H 'Authorization: Bearer <access_token>' \
|
||||
--data-urlencode 'pick_code=b53gu6z3hvqji8wrm'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:----------------------------|:---------|:----------------------------|
|
||||
| state | boolean | 操作结果状态,true:成功;false:失败 |
|
||||
| message | string | 返回信息,成功时为空字符串 |
|
||||
| code | int | 错误码 |
|
||||
| data | object | 响应数据 |
|
||||
| data.autoload | object | 默认自动载入的字幕;无可用字幕时为空数组 |
|
||||
| data.autoload.sid | string | 字幕标识 |
|
||||
| data.autoload.language | string | 字幕语言 |
|
||||
| data.autoload.title | string | 字幕标题 |
|
||||
| data.autoload.url | string | 字幕文件地址 |
|
||||
| data.autoload.type | string | 字幕文件类型 |
|
||||
| data.autoload.key | string | 内置字幕键,仅内置字幕返回 |
|
||||
| data.autoload.sha1 | string | 字幕文件哈希值 |
|
||||
| data.autoload.file_id | string | 外挂或内嵌字幕文件ID |
|
||||
| data.autoload.file_name | string | 外挂或内嵌字幕文件名 |
|
||||
| data.autoload.pick_code | string | 外挂或内嵌字幕文件提取码 |
|
||||
| data.autoload.caption_map_id | string | 内嵌字幕映射ID |
|
||||
| data.autoload.is_caption_map | int | 是否为内嵌字幕,0:否;1:是 |
|
||||
| data.autoload.sync_time | float | 字幕同步时间 |
|
||||
| data.autoload.from | int | 记忆字幕来源标识 |
|
||||
| data.autoload.user_sub | int | 是否为用户记忆字幕,1:是 |
|
||||
| data.list | object[] | 字幕列表 |
|
||||
| data.list[].sid | string | 字幕标识 |
|
||||
| data.list[].language | string | 字幕语言 |
|
||||
| data.list[].title | string | 字幕标题 |
|
||||
| data.list[].url | string | 字幕文件地址 |
|
||||
| data.list[].type | string | 字幕文件类型 |
|
||||
| data.list[].key | string | 内置字幕键,仅内置字幕返回 |
|
||||
| data.list[].sha1 | string | 字幕文件哈希值 |
|
||||
| data.list[].file_id | string | 外挂或内嵌字幕文件ID |
|
||||
| data.list[].file_name | string | 外挂或内嵌字幕文件名 |
|
||||
| data.list[].pick_code | string | 外挂或内嵌字幕文件提取码 |
|
||||
| data.list[].caption_map_id | string | 内嵌字幕映射ID |
|
||||
| data.list[].is_caption_map | int | 是否为内嵌字幕,0:否;1:是 |
|
||||
| data.list[].sync_time | float | 字幕同步时间 |
|
||||
| data.list[].from | int | 记忆字幕来源标识 |
|
||||
| data.list[].user_sub | int | 是否为用户记忆字幕,1:是 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0,
|
||||
"data": {
|
||||
"autoload": [],
|
||||
"list": []
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 业务规则
|
||||
|
||||
- 用户记忆字幕不在列表中时会被前置;其余字幕按同目录同名外挂字幕、内嵌字幕、内置字幕、其他外挂字幕的顺序组合。
|
||||
- 存在用户记忆字幕时优先将其作为自动载入字幕;否则依次选择内嵌字幕、同名外挂字幕或内置字幕。
|
||||
- 字幕项来源不同,部分来源专属字段可能不返回。
|
||||
|
||||
### 注意事项
|
||||
|
||||
- `access_token` 通过 `Authorization` 请求头传递,请将请求示例中的占位符替换为实际访问令牌。
|
||||
- 字幕文件地址具有时效性,请以本次接口返回值为准。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,89 +0,0 @@
|
||||
## 记忆视频播放进度
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-------------|:--------------------------------|
|
||||
| 接口名称 | 记忆视频播放进度 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /history |
|
||||
| 请求方法 | POST |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
记录指定视频的播放进度及是否播放完毕。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://proapi.115.com/open/video/history
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
POST
|
||||
Content-Type: multipart/form-data
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
Authorization: Bearer access_token
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:----------|:-------|:---|:----|:-------------------|:-----------------|
|
||||
| pick_code | string | 是 | - | 视频文件提取码 | b53gu6z3hvqji8wrm |
|
||||
| time | int | 否 | 0 | 视频播放进度,单位为秒 | 10 |
|
||||
| watch_end | int | 否 | 0 | 是否播放完毕,0:否;1:是 | 0 |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl 'https://proapi.115.com/open/video/history' \
|
||||
-H 'Authorization: Bearer <access_token>' \
|
||||
-F 'pick_code=b53gu6z3hvqji8wrm' \
|
||||
-F 'time=10' \
|
||||
-F 'watch_end=0'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:------|:---------|:----------------------|
|
||||
| state | boolean | 操作结果状态,true:成功;false:失败 |
|
||||
| message | string | 返回信息,成功时为空字符串 |
|
||||
| code | int | 错误码 |
|
||||
| data | object[] | 响应数据,成功时为空数组 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": true,
|
||||
"message": "",
|
||||
"code": 0,
|
||||
"data": []
|
||||
}
|
||||
```
|
||||
|
||||
### 业务规则
|
||||
|
||||
- `time` 和 `watch_end` 均不传时,两个参数均按 `0` 处理,即播放进度为 0 秒且未播放完毕。
|
||||
- 非本人文件不写入播放进度,但接口按操作成功返回。
|
||||
- 同一视频未播放完毕的进度在 5 秒内重复上报时不重复持久化;标记为播放完毕时会立即持久化。
|
||||
|
||||
### 注意事项
|
||||
|
||||
- `access_token` 通过 `Authorization` 请求头传递,请将请求示例中的占位符替换为实际访问令牌。
|
||||
- `pick_code` 必须属于当前授权用户可记录播放进度的视频文件。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,30 +0,0 @@
|
||||
# 开发须知
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-----------|:---------------------------------|
|
||||
| 文档名称 | 开发须知 |
|
||||
| 文档版本 | v1.0 |
|
||||
|
||||
## 注意事项
|
||||
|
||||
为共同建设开放、共赢的合作生态并保障平台服务的可持续发展,开发者在接入平台服务前,须认真阅读并严格遵循《115生活开放平台开发者协议》的相关要求,确保合规运营、维护平台秩序。
|
||||
|
||||
基于平台与用户权益保护原则,平台会持续监测开发者的服务使用行为。如发现违反平台规范的行为,平台将视情节采取包括但不限于服务限流、接口冻结、资质回收等限制措施,并保留依法追责的权利。
|
||||
|
||||
开发者严禁实施包括但不限于以下行为:
|
||||
|
||||
1. **数据隐私违规行为**:侵害用户数据隐私安全,包括未经用户授权或未明确用途,违规收集、下载、存储、传播、加工用户存储数据等。开发者需要确保用户数据的获取与使用全程透明、可追溯。
|
||||
2. **商业利益侵犯行为**:损害 115 科技的商业利益,包括多人共享开发者账号及会员权益、开展竞争关系业务、未经授权获取平台相关服务运营数据等。
|
||||
3. **不当使用行为**:违规或未按要求使用 API 服务,包括违反国家相关政策法规、侵犯第三方合法权益、调用非公开接口、实际用途与申请信息不符等。
|
||||
|
||||
## 限流说明
|
||||
|
||||
为确保系统安全并保障服务稳定运行,115生活开放平台对所有 API 实施频率控制策略。出于安全防护需要,相关策略细则暂不公开,平台会持续动态优化该机制。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,60 +0,0 @@
|
||||
# 授权错误码
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-----------|:---------------------------------|
|
||||
| 文档名称 | 授权错误码 |
|
||||
| 文档版本 | v1.0 |
|
||||
|
||||
| 错误码 | 描述 | 建议 |
|
||||
|:-------|:------------------------------------|:-------------------------------------------------------------|
|
||||
| 40100000 | 参数缺失 | - |
|
||||
| 40101017 | 用户验证失败 | - |
|
||||
| 40110000 | 请求异常,需要重试 | - |
|
||||
| 40140100 | `client_id` 错误 | - |
|
||||
| 40140101 | `code_challenge` 必填 | - |
|
||||
| 40140102 | `code_challenge_method` 必须是 `sha256`、`sha1`、`md5` 之一 | - |
|
||||
| 40140103 | `sign` 必填 | - |
|
||||
| 40140104 | `sign` 签名失败 | - |
|
||||
| 40140105 | 生成二维码失败 | - |
|
||||
| 40140106 | AppID 无效 | - |
|
||||
| 40140107 | 应用不存在 | - |
|
||||
| 40140108 | 应用未审核通过 | - |
|
||||
| 40140109 | 应用已被停用 | - |
|
||||
| 40140110 | 应用已过期 | - |
|
||||
| 40140111 | AppSecret 错误 | - |
|
||||
| 40140112 | `code_verifier` 长度要求为 43 至 128 位 | - |
|
||||
| 40140113 | `code_verifier` 验证失败 | - |
|
||||
| 40140114 | `refresh_token` 格式错误(防篡改) | - |
|
||||
| 40140115 | `refresh_token` 签名校验失败(防篡改) | - |
|
||||
| 40140116 | `refresh_token` 无效(已解除授权) | 重新授权。终态错误,重试不会成功;继续重试将被标记为永久失效,见 `40140137` |
|
||||
| 40140117 | `access_token` 刷新太频繁 | - |
|
||||
| 40140118 | 开发者认证已过期 | - |
|
||||
| 40140119 | `refresh_token` 已过期 | 重新授权。终态错误,重试不会成功;继续重试将被标记为永久失效,见 `40140137` |
|
||||
| 40140120 | `refresh_token` 检验失败(防篡改) | 调用 `/open/refreshToken` 后会重新生成 `refresh_token`,检查本地是否已更新其值。终态错误,持续用旧值重试将被标记为永久失效,见 `40140137` |
|
||||
| 40140121 | `access_token` 刷新失败 | 重试 |
|
||||
| 40140122 | 超出授权应用数量上限 | - |
|
||||
| 40140123 | `access_token` 格式错误(防篡改) | - |
|
||||
| 40140124 | `access_token` 签名校验失败(防篡改) | - |
|
||||
| 40140125 | `access_token` 无效(已过期、已解除授权或授权缓存不存在) | 调用 `/open/refreshToken` 获取新凭证;若 `refresh_token` 无效或已过期,重新授权 |
|
||||
| 40140126 | `access_token` 与当前授权记录不匹配 | 重新读取刷新后保存的最新凭证,禁止使用原 `access_token` 重试;没有可用新凭证时调用 `/open/refreshToken` |
|
||||
| 40140127 | `response_type` 错误 | - |
|
||||
| 40140128 | `redirect_uri` 缺少协议 | - |
|
||||
| 40140129 | `redirect_uri` 缺少域名 | - |
|
||||
| 40140130 | 没有配置重定向域名 | 到应用管理中配置域名 |
|
||||
| 40140131 | `redirect_uri` 域名不合法 | 需要与应用管理中配置的应用域名一致 |
|
||||
| 40140132 | `grant_type` 错误 | - |
|
||||
| 40140133 | `client_secret` 验证失败 | - |
|
||||
| 40140134 | 授权码 `code` 验证失败 | - |
|
||||
| 40140135 | `client_id` 验证失败 | - |
|
||||
| 40140136 | `redirect_uri` 验证失败(防 MITM 攻击) | - |
|
||||
| 40140137 | `refresh_token` 已失效,请停止重试并重新授权(终态) | 同一 `refresh_token` 连续多次以 `40140116`/`40140119`/`40140120` 失败后被服务端标记为永久失效。收到后必须停止用该令牌重试,引导用户重新授权;重新授权产生的新令牌不受影响 |
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
| 2026年08月10日(周一) 10:23:15 | 修正 `40140125`、`40140126` 的原因及处理建议 |
|
||||
| 2026年08月24日(周一) 10:16:52 | 新增终态错误码 `40140137`,补充 `40140116`/`40140119`/`40140120` 的永久失效判定说明 |
|
||||
@@ -1,92 +0,0 @@
|
||||
## 刷新access_token
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-----------|:---------------------------------|
|
||||
| 接口名称 | 刷新access_token |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /refreshToken |
|
||||
| 请求方法 | POST |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
该接口用于通过 `refresh_token` 获取新的 `access_token` 和 `refresh_token`。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://passportapi.115.com/open/refreshToken
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
POST
|
||||
Content-Type: application/x-www-form-urlencoded
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
OAuth 2.0 刷新凭证
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:-------------|:-------|:---|:----|:---------------------|:----------------------------|
|
||||
| refresh_token | string | 是 | - | 用于刷新访问凭证的刷新凭证 | `REFRESH_TOKEN_PLACEHOLDER` |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl 'https://passportapi.115.com/open/refreshToken' \
|
||||
-H 'Content-Type: application/x-www-form-urlencoded' \
|
||||
--data-urlencode 'refresh_token=REFRESH_TOKEN_PLACEHOLDER'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:-------------------|:-------|:------------------------------------|
|
||||
| state | int | 状态码 |
|
||||
| code | int | 错误码 |
|
||||
| message | string | 响应信息 |
|
||||
| data | object | 响应数据 |
|
||||
| data.access_token | string | 新的 `access_token`,同时刷新有效期 |
|
||||
| data.refresh_token | string | 新的 `refresh_token`,其有效期不延长、不改变 |
|
||||
| data.expires_in | int | `access_token` 有效期,单位为秒 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": 1,
|
||||
"code": 0,
|
||||
"message": "",
|
||||
"data": {
|
||||
"access_token": "ACCESS_TOKEN_PLACEHOLDER",
|
||||
"refresh_token": "REFRESH_TOKEN_PLACEHOLDER",
|
||||
"expires_in": 7200
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 注意事项
|
||||
|
||||
- `access_token` 有效期为 7200 秒,调用方应以响应中的 `expires_in` 计算刷新时间。
|
||||
- 同一授权在 60 秒内重复刷新会触发频率控制;多进程或多节点调用方应确保同一授权同一时间只有一个刷新请求。
|
||||
- 调用后会同时生成新的 `access_token` 和 `refresh_token`。调用方必须将两者作为一组原子保存,并停止使用刷新前的旧凭证;刷新凭证本身的有效期不延长、不改变。
|
||||
- 收到 `40140125` 或 `40140126` 时,不要使用原 `access_token` 重复重试。应先读取已保存的最新凭证;没有可用新凭证时,再调用本接口刷新。
|
||||
- `40140116`、`40140119`、`40140120` 是终态错误,用同一个 `refresh_token` 重试永远不会成功。同一 `refresh_token` 连续多次以这三种原因失败会被服务端标记为永久失效,之后每次刷新都直接返回 `40140137`。客户端收到这三种错误或 `40140137` 时必须停止重试,引导用户重新授权;后台常驻程序(如 NAS 同步任务)尤其要实现该逻辑,避免长期无效轮询。
|
||||
- `access_token` 和 `refresh_token` 属于敏感凭证,不得写入公开仓库、客户端日志或公开沟通内容。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
| 2026年08月10日(周一) 10:23:15 | 修正 `access_token` 有效期示例,补充凭证轮换及并发刷新说明 |
|
||||
| 2026年08月24日(周一) 10:16:52 | 新增 `refresh_token` 永久失效判定规则与终态错误码 `40140137` 说明 |
|
||||
@@ -1,88 +0,0 @@
|
||||
## 获取access_token
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-----------|:---------------------------------|
|
||||
| 接口名称 | 获取access_token |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /deviceCodeToToken |
|
||||
| 请求方法 | POST |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
该接口用于在用户确认手机扫码授权后,使用设备码和 PKCE 原始校验值换取 `access_token`。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://passportapi.115.com/open/deviceCodeToToken
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
POST
|
||||
Content-Type: application/x-www-form-urlencoded
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
OAuth 2.0 + PKCE
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:-----------|:-------|:---|:----|:--------------------------------|:---------------------------------------------------------------|
|
||||
| uid | string | 是 | - | 二维码 ID/设备码 | `DEVICE_CODE_PLACEHOLDER` |
|
||||
| code_verifier | string | 是 | - | 计算 `code_challenge` 时使用的原始随机字符串 | `IGKN6CJanWxCDPDhHZJrhswQdlcPBGLqExkhyujysXaQ4fJKBk_6dlPJo47s` |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl 'https://passportapi.115.com/open/deviceCodeToToken' \
|
||||
-H 'Content-Type: application/x-www-form-urlencoded' \
|
||||
--data-urlencode 'uid=DEVICE_CODE_PLACEHOLDER' \
|
||||
--data-urlencode 'code_verifier=IGKN6CJanWxCDPDhHZJrhswQdlcPBGLqExkhyujysXaQ4fJKBk_6dlPJo47s'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:-------------------|:-------|:--------------------------------|
|
||||
| state | int | 状态码 |
|
||||
| code | int | 错误码 |
|
||||
| message | string | 响应信息 |
|
||||
| data | object | 响应数据 |
|
||||
| data.access_token | string | 访问资源接口的凭证 |
|
||||
| data.refresh_token | string | 刷新 `access_token` 的凭证,有效期 1 年 |
|
||||
| data.expires_in | int | `access_token` 有效期,单位为秒 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": 1,
|
||||
"code": 0,
|
||||
"message": "",
|
||||
"data": {
|
||||
"access_token": "ACCESS_TOKEN_PLACEHOLDER",
|
||||
"refresh_token": "REFRESH_TOKEN_PLACEHOLDER",
|
||||
"expires_in": 7200
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 注意事项
|
||||
|
||||
- `code_verifier` 必须与生成 `code_challenge` 时使用的原始值一致。
|
||||
- `access_token` 和 `refresh_token` 属于敏感凭证,不得写入公开仓库、客户端日志或公开沟通内容。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,103 +0,0 @@
|
||||
## 获取设备码和二维码内容
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-----------|:---------------------------------|
|
||||
| 接口名称 | 获取设备码和二维码内容 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /authDeviceCode |
|
||||
| 请求方法 | POST |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
该接口用于 OAuth 2.0 + PKCE 手机扫码授权流程的第一步,获取设备码和二维码内容。此模式适用于无后端服务的第三方客户端,无需提供 AppSecret。
|
||||
|
||||
第三方客户端需要根据响应中的 `data.qrcode` 生成二维码,供 115 客户端扫码授权。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://passportapi.115.com/open/authDeviceCode
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
POST
|
||||
Content-Type: application/x-www-form-urlencoded
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
OAuth 2.0 + PKCE
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:---------------------|:-------|:---|:----|:--------------------------------|:-----------------------------------------------------------|
|
||||
| client_id | string | 是 | - | AppID | `YOUR_APP_ID` |
|
||||
| code_challenge | string | 是 | - | PKCE 挑战码 | `THHodGWg-FZfv8XYz7QArNGIK_aVomSHPldlSOTUtkw` |
|
||||
| code_challenge_method | string | 是 | - | `code_challenge` 的哈希算法,见下方枚举表格 | `sha256` |
|
||||
|
||||
#### 请求参数中的 code_challenge_method 字段枚举
|
||||
|
||||
| 值 | 说明 | 备注 |
|
||||
|:-------|:---------------------------|:---|
|
||||
| md5 | 使用 MD5 计算挑战码 | - |
|
||||
| sha1 | 使用 SHA-1 计算挑战码 | - |
|
||||
| sha256 | 使用 SHA-256 计算挑战码,推荐使用 | - |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl 'https://passportapi.115.com/open/authDeviceCode' \
|
||||
-H 'Content-Type: application/x-www-form-urlencoded' \
|
||||
--data-urlencode 'client_id=YOUR_APP_ID' \
|
||||
--data-urlencode 'code_challenge=THHodGWg-FZfv8XYz7QArNGIK_aVomSHPldlSOTUtkw' \
|
||||
--data-urlencode 'code_challenge_method=sha256'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:-----------|:-----|:------------------------------------------|
|
||||
| state | int | 状态码 |
|
||||
| code | int | 错误码 |
|
||||
| message | string | 响应信息 |
|
||||
| data | object | 响应数据 |
|
||||
| data.uid | string | 设备码,轮询二维码状态时使用 |
|
||||
| data.time | int | 校验时间戳,轮询二维码状态时使用 |
|
||||
| data.qrcode | string | 二维码内容,第三方客户端需要据此生成设备二维码 |
|
||||
| data.sign | string | 校验签名,轮询二维码状态时使用 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": 1,
|
||||
"code": 0,
|
||||
"message": "",
|
||||
"data": {
|
||||
"uid": "DEVICE_CODE_PLACEHOLDER",
|
||||
"time": 0,
|
||||
"qrcode": "QRCODE_CONTENT_PLACEHOLDER",
|
||||
"sign": "SIGN_PLACEHOLDER"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 注意事项
|
||||
|
||||
- `code_verifier` 为长度 43 至 128 位的随机字符串。
|
||||
- `code_challenge` 的计算方式为 `url_safe(base64_encode(hash(code_verifier)))`。哈希结果按二进制数据参与 Base64 编码,算法需要与 `code_challenge_method` 一致。
|
||||
- AppID 等应用凭证请使用实际应用配置,不要在公开仓库或日志中记录敏感凭证。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,89 +0,0 @@
|
||||
## 轮询二维码状态
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-----------|:---------------------------------|
|
||||
| 接口名称 | 轮询二维码状态 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /get/status/ |
|
||||
| 请求方法 | GET |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
该接口用于长轮询设备二维码的扫码和授权状态。当二维码状态没有变化时,接口不会立即响应,直到请求超时或状态发生变化。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://qrcodeapi.115.com/get/status/
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
GET
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
设备码参数校验
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:----|:-------|:---|:----|:------------------------------------|:------------------------|
|
||||
| uid | string | 是 | - | 二维码 ID/设备码,从 `/open/authDeviceCode` 的 `data.uid` 获取 | `DEVICE_CODE_PLACEHOLDER` |
|
||||
| time | int | 是 | - | 校验时间戳,从 `/open/authDeviceCode` 的 `data.time` 获取 | `0` |
|
||||
| sign | string | 是 | - | 校验签名,从 `/open/authDeviceCode` 的 `data.sign` 获取 | `SIGN_PLACEHOLDER` |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl -G 'https://qrcodeapi.115.com/get/status/' \
|
||||
--data-urlencode 'uid=DEVICE_CODE_PLACEHOLDER' \
|
||||
--data-urlencode 'time=0' \
|
||||
--data-urlencode 'sign=SIGN_PLACEHOLDER'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:------------|:-------|:-------------------------------------------|
|
||||
| state | int | 轮询状态:0-二维码无效,结束轮询;1-继续轮询 |
|
||||
| code | int | 错误码 |
|
||||
| message | string | 响应信息 |
|
||||
| data | object | 响应数据;115 客户端扫码或输入设备码后才有值 |
|
||||
| data.msg | string | 操作提示 |
|
||||
| data.status | int | 二维码状态:1-扫码成功,等待确认;2-确认登录或授权,结束轮询 |
|
||||
| data.version | string | 版本信息 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": 1,
|
||||
"code": 0,
|
||||
"message": "",
|
||||
"data": {
|
||||
"msg": "OPERATION_MESSAGE_PLACEHOLDER",
|
||||
"status": 1,
|
||||
"version": "VERSION_PLACEHOLDER"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 注意事项
|
||||
|
||||
- `state=0` 表示二维码无效,应结束轮询;`state=1` 表示继续轮询。
|
||||
- `data.status=1` 表示扫码成功并等待用户确认;`data.status=2` 表示用户已确认登录或授权,应结束轮询并进入换取访问凭证的步骤。
|
||||
- 长轮询超时不等同于授权失败,客户端可以按照自身网络策略重新发起请求。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,95 +0,0 @@
|
||||
## 用授权码换取access_token
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-----------|:---------------------------------|
|
||||
| 接口名称 | 用授权码换取access_token |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /authCodeToToken |
|
||||
| 请求方法 | POST |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
该接口用于通过授权码换取 `access_token`。建议在开发者服务端调用,避免泄露 AppSecret。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://passportapi.115.com/open/authCodeToToken
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
POST
|
||||
Content-Type: application/x-www-form-urlencoded
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
OAuth 2.0 授权码模式
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:-------------|:-------|:---|:----|:------------------------------------|:------------------------------|
|
||||
| client_id | string | 是 | - | AppID | `YOUR_APP_ID` |
|
||||
| client_secret | string | 是 | - | AppSecret | `YOUR_APP_SECRET` |
|
||||
| code | string | 是 | - | 请求授权接口重定向返回的授权码 | `AUTHORIZATION_CODE_PLACEHOLDER` |
|
||||
| redirect_uri | string | 是 | - | 与请求授权时传入的 `redirect_uri` 一致,用于防止 MITM 和 CSRF 攻击 | `https://foo.com?state=123456` |
|
||||
| grant_type | string | 是 | - | 授权类型,固定为 `authorization_code` | `authorization_code` |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl 'https://passportapi.115.com/open/authCodeToToken' \
|
||||
-H 'Content-Type: application/x-www-form-urlencoded' \
|
||||
--data-urlencode 'client_id=YOUR_APP_ID' \
|
||||
--data-urlencode 'client_secret=YOUR_APP_SECRET' \
|
||||
--data-urlencode 'code=AUTHORIZATION_CODE_PLACEHOLDER' \
|
||||
--data-urlencode 'redirect_uri=https://foo.com?state=123456' \
|
||||
--data-urlencode 'grant_type=authorization_code'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:-------------------|:-------|:--------------------------------|
|
||||
| state | int | 状态码:0-失败;1-成功 |
|
||||
| code | int | 错误码 |
|
||||
| message | string | 响应信息 |
|
||||
| data | object | 响应数据 |
|
||||
| data.access_token | string | 访问资源接口的凭证 |
|
||||
| data.refresh_token | string | 刷新 `access_token` 的凭证,有效期 1 年 |
|
||||
| data.expires_in | int | `access_token` 有效期,单位为秒 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": 1,
|
||||
"code": 0,
|
||||
"message": "",
|
||||
"data": {
|
||||
"access_token": "ACCESS_TOKEN_PLACEHOLDER",
|
||||
"refresh_token": "REFRESH_TOKEN_PLACEHOLDER",
|
||||
"expires_in": 7200
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 注意事项
|
||||
|
||||
- 必须在服务端安全保存并使用 AppSecret,不得在客户端代码、公开仓库或日志中泄露。
|
||||
- `redirect_uri` 必须与请求授权时传入的值一致。
|
||||
- `access_token` 和 `refresh_token` 属于敏感凭证,应按照敏感数据规范存储。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,87 +0,0 @@
|
||||
## 请求授权
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-----------|:---------------------------------|
|
||||
| 接口名称 | 请求授权 |
|
||||
| 接口版本 | v1.0 |
|
||||
| 接口路径 | /authorize |
|
||||
| 请求方法 | GET |
|
||||
| 接口状态 | 生产环境 |
|
||||
|
||||
### 接口说明
|
||||
|
||||
该接口用于发起 OAuth 2.0 授权码模式授权,建议由开发者服务端参与授权流程。
|
||||
|
||||
用户未登录时,接口会重定向到登录页面;用户已登录时,接口会自动完成授权并重定向到 `redirect_uri` 指定的地址。
|
||||
|
||||
### 接口地址
|
||||
|
||||
```
|
||||
https://passportapi.115.com/open/authorize
|
||||
```
|
||||
|
||||
### 请求方式
|
||||
|
||||
```
|
||||
GET
|
||||
```
|
||||
|
||||
### 认证方式
|
||||
|
||||
```
|
||||
OAuth 2.0 授权码模式
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
||||
|:-----------|:-------|:---|:----|:-----------------------------------------------|:---------------------|
|
||||
| client_id | string | 是 | - | AppID | `YOUR_APP_ID` |
|
||||
| redirect_uri | string | 是 | - | 授权完成后的重定向地址;接口会附加授权码 `code`,并原样附加请求中的 `state` | `https://foo.com/bar` |
|
||||
| response_type | string | 是 | - | 授权模式,固定为 `code` | `code` |
|
||||
| state | string | 否 | "" | 防止 CSRF 攻击的随机值,重定向时原样返回 | `123456` |
|
||||
|
||||
### 请求示例
|
||||
|
||||
```shell
|
||||
curl -G 'https://passportapi.115.com/open/authorize' \
|
||||
--data-urlencode 'client_id=YOUR_APP_ID' \
|
||||
--data-urlencode 'redirect_uri=https://foo.com/bar' \
|
||||
--data-urlencode 'response_type=code' \
|
||||
--data-urlencode 'state=123456'
|
||||
```
|
||||
|
||||
### 响应字段说明
|
||||
|
||||
接口调用成功时会重定向到 `redirect_uri`,并通过查询参数返回授权码 `code` 和请求中携带的 `state`。接口调用失败时返回以下字段:
|
||||
|
||||
| 字段 | 类型 | 描述 |
|
||||
|:--------|:-------|:------------------|
|
||||
| state | int | 状态码:0-失败;1-成功 |
|
||||
| code | int | 错误码 |
|
||||
| data | object | 响应数据 |
|
||||
| message | string | 响应信息 |
|
||||
|
||||
### 响应示例
|
||||
|
||||
```json
|
||||
{
|
||||
"state": 0,
|
||||
"code": 40140127,
|
||||
"data": {},
|
||||
"message": "response_type 错误"
|
||||
}
|
||||
```
|
||||
|
||||
### 注意事项
|
||||
|
||||
- `redirect_uri` 需要先在[115生活开放平台](https://open.115.com/)的应用管理中配置域名,并在请求时进行 URL 编码。
|
||||
- 强烈建议传入随机 `state`,并在换取 `access_token` 前验证重定向返回的 `state` 与请求值一致,以防止 CSRF 攻击。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,57 +0,0 @@
|
||||
# 接入流程
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-----------|:---------------------------------|
|
||||
| 文档名称 | 接入流程 |
|
||||
| 文档版本 | v1.0 |
|
||||
|
||||
## 1. 注册“115生活”账号
|
||||
|
||||
在使用 115 开放平台服务之前,开发者需要先通过[“115生活”官网](https://115.com/)注册“115生活”账号并登录,完成实名认证。
|
||||
|
||||
## 2. 提交入驻申请
|
||||
|
||||
访问[115生活开放平台](https://open.115.com/),按照页面流程填写相关信息。
|
||||
|
||||
### 2.1 选择开发者身份类型
|
||||
|
||||
开发者可以申请成为“个人开发者”或“企业开发者”。点击页面上方的“切换申请类型”,可以切换身份类型。
|
||||
|
||||
### 2.2 签署协议
|
||||
|
||||
认真阅读并确认相关协议内容;如无异议,勾选“同意”并点击“下一步”。
|
||||
|
||||
### 2.3 填写入驻资料
|
||||
|
||||
按照页面指引填写个人信息、API 对接需求、应用场景等入驻资料,然后点击“下一步”。
|
||||
|
||||
### 2.4 填写认证信息
|
||||
|
||||
根据所选择的开发者身份类型,按照页面指引填写并上传身份认证资料:
|
||||
|
||||
- **个人开发者**:姓名、身份证信息(证件号码、有效期)、证件照片(身份证件正反面照片、本人手持身份证照片)。
|
||||
- **企业开发者**:企业负责人或法人的姓名、联系方式、身份证信息(证件号码、有效期)、证件照片(身份证件正反面照片、加盖公章的营业执照影印件)、统一社会信用代码。
|
||||
|
||||
### 2.5 提交入驻申请
|
||||
|
||||
确认上述信息填写无误后,点击“提交验证”提交入驻申请。平台将在 7 个工作日内完成审核。
|
||||
|
||||
## 3. 创建应用
|
||||
|
||||
入驻申请通过后,进入 115 生活开放平台管理页面,选择“应用管理”,点击“创建应用”,按照页面指引填写应用信息、应用域名、应用描述、接口信息等内容。确认信息填写无误后提交应用申请,平台将在 7 个工作日内完成审核。
|
||||
|
||||
应用审核通过后,开发者可以获取该应用的 AppID、AppKey 和 AppSecret 等接入凭证。请妥善保存这些凭证,不要在客户端代码、公开仓库或沟通内容中泄露。
|
||||
|
||||
## 4. 接口调试
|
||||
|
||||
按照开放平台接口文档完成接入和调用后,即可正式使用开放平台能力。
|
||||
|
||||
开放平台 API 基础域名:`https://proapi.115.com/`
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,23 +0,0 @@
|
||||
# 更新记录
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-----------|:---------------------------------|
|
||||
| 文档名称 | 更新记录 |
|
||||
| 文档版本 | v1.0 |
|
||||
|
||||
## 更新内容
|
||||
|
||||
| 更新模块 | 更新内容 | 更新时间 |
|
||||
|:-----------|:-------------------------|:--------------|
|
||||
| 增值服务产品 | 新增增值服务产品,获得推广收益 | 2025年4月17日周四 |
|
||||
| 视频播放、云下载 | 新增视频播放、云下载接口 | 2025年4月3日周四 |
|
||||
| 接入授权 | 支持 H5 账号密码/短信授权 | 2025年4月2日周三 |
|
||||
| 基本框架 | 新增开放平台文档接口 | 2025年1月22日周三 |
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,30 +0,0 @@
|
||||
# 概述
|
||||
|
||||
### 基本信息
|
||||
|
||||
| 属性 | 内容 |
|
||||
|:-----------|:---------------------------------|
|
||||
| 文档名称 | 概述 |
|
||||
| 文档版本 | v1.0 |
|
||||
|
||||
## 115生活简介
|
||||
|
||||
“115生活”是一款面向个人用户的数字生活平台,提供海量数据的安全存储、多端同步与快速访问。用户不仅可以便捷地管理和使用各类数字资源,还能使用多维社交、生活服务等多元化功能。
|
||||
|
||||
## 115生活开放平台能力说明
|
||||
|
||||
115生活开放平台提供“115生活”数据存储、同步、管理等功能的 API 服务。开发者通过对接 API,可以将“115生活”的存储能力集成到自己的应用中。
|
||||
|
||||
目前已开放以下能力:
|
||||
|
||||
- **用户管理能力**:用户授权与信息查询等。
|
||||
- **文件管理能力**:获取文件列表,查看文件属性,以及文件上传、下载、搜索、移动、删除等。
|
||||
- **视频管理能力**:视频文件的在线转码与播放等。
|
||||
- **云下载服务**:获取云下载任务列表、配额信息,以及添加、删除下载任务等。
|
||||
- **商业价值转化**:开发者参与“推广产品得收益”计划,可基于用户实际购买的产品获取相应推广收益。
|
||||
|
||||
### 修改历史
|
||||
|
||||
| 修改时间 | 修改说明 |
|
||||
|:-----------------------------|:-----|
|
||||
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|
||||
@@ -1,67 +0,0 @@
|
||||
# 115 开放平台文档(离线版)
|
||||
|
||||
> 来源:https://open.115.com/doc/ (115生活开放平台开发者文档)
|
||||
> 抓取时间:2026-09-05,共 42 篇 Markdown 文档,目录结构与官网一致。
|
||||
> 目录索引:[tree-index.json](tree-index.json)(官网原始目录树,程序化遍历可用)。
|
||||
|
||||
## 文档目录
|
||||
|
||||
- [概述](115开放平台/简介/概述.md)
|
||||
- [更新记录](115开放平台/简介/更新记录.md)
|
||||
- [接入流程](115开放平台/接入指南/接入流程.md)
|
||||
- [开发须知](115开放平台/接入指南/开发须知.md)
|
||||
- [授权错误码](115开放平台/接入指南/授权错误码.md)
|
||||
- **接入授权/**
|
||||
- **手机扫码授权PKCE模式/**
|
||||
- [获取设备码和二维码内容](115开放平台/接入指南/接入授权/手机扫码授权PKCE模式/获取设备码和二维码内容.md)
|
||||
- [轮询二维码状态](115开放平台/接入指南/接入授权/手机扫码授权PKCE模式/轮询二维码状态.md)
|
||||
- [获取access_token](115开放平台/接入指南/接入授权/手机扫码授权PKCE模式/获取access_token.md)
|
||||
- **授权码模式/**
|
||||
- [请求授权](115开放平台/接入指南/接入授权/授权码模式/请求授权.md)
|
||||
- [用授权码换取access_token](115开放平台/接入指南/接入授权/授权码模式/用授权码换取access_token.md)
|
||||
- [刷新access_token](115开放平台/接入指南/接入授权/刷新access_token.md)
|
||||
- [开发者商业价值转化:推广产品得收益](115开放平台/API列表/开发者商业价值转化:推广产品得收益.md)
|
||||
- **用户管理/**
|
||||
- [用户信息](115开放平台/API列表/用户管理/用户信息.md)
|
||||
- **文件管理/**
|
||||
- **文件上传/**
|
||||
- [上传流程](115开放平台/API列表/文件管理/文件上传/上传流程.md)
|
||||
- [获取上传凭证](115开放平台/API列表/文件管理/文件上传/获取上传凭证.md)
|
||||
- [文件上传](115开放平台/API列表/文件管理/文件上传/文件上传.md)
|
||||
- [断点续传](115开放平台/API列表/文件管理/文件上传/断点续传.md)
|
||||
- [新建文件夹](115开放平台/API列表/文件管理/新建文件夹.md)
|
||||
- [获取文件列表](115开放平台/API列表/文件管理/获取文件列表.md)
|
||||
- **获取文件(夹)详情/**
|
||||
- [按ID获取](115开放平台/API列表/文件管理/获取文件(夹)详情/按ID获取.md)
|
||||
- [按路径获取](115开放平台/API列表/文件管理/获取文件(夹)详情/按路径获取.md)
|
||||
- [文件搜索](115开放平台/API列表/文件管理/文件搜索.md)
|
||||
- [文件复制](115开放平台/API列表/文件管理/文件复制.md)
|
||||
- [文件移动](115开放平台/API列表/文件管理/文件移动.md)
|
||||
- [获取文件下载地址](115开放平台/API列表/文件管理/获取文件下载地址.md)
|
||||
- [文件(夹)更新](115开放平台/API列表/文件管理/文件(夹)更新.md)
|
||||
- [删除文件](115开放平台/API列表/文件管理/删除文件.md)
|
||||
- [回收站列表](115开放平台/API列表/文件管理/回收站列表.md)
|
||||
- [回收站还原](115开放平台/API列表/文件管理/回收站还原.md)
|
||||
- [删除或清空回收站](115开放平台/API列表/文件管理/删除或清空回收站.md)
|
||||
- **视频播放/**
|
||||
- [记忆视频播放进度](115开放平台/API列表/视频播放/记忆视频播放进度.md)
|
||||
- [视频字幕列表](115开放平台/API列表/视频播放/视频字幕列表.md)
|
||||
- [获取视频播放进度](115开放平台/API列表/视频播放/获取视频播放进度.md)
|
||||
- [获取视频在线播放地址](115开放平台/API列表/视频播放/获取视频在线播放地址.md)
|
||||
- [提交视频转码](115开放平台/API列表/视频播放/提交视频转码.md)
|
||||
- **云下载/**
|
||||
- [解析BT种子](115开放平台/API列表/云下载/解析BT种子.md)
|
||||
- [获取用户云下载任务列表](115开放平台/API列表/云下载/获取用户云下载任务列表.md)
|
||||
- [获取云下载配额信息](115开放平台/API列表/云下载/获取云下载配额信息.md)
|
||||
- [清空云下载任务](115开放平台/API列表/云下载/清空云下载任务.md)
|
||||
- [添加云下载链接任务](115开放平台/API列表/云下载/添加云下载链接任务.md)
|
||||
- [删除用户云下载任务](115开放平台/API列表/云下载/删除用户云下载任务.md)
|
||||
- [添加云下载BT任务](115开放平台/API列表/云下载/添加云下载BT任务.md)
|
||||
|
||||
## API 接口速查
|
||||
|
||||
主要 API 域名与认证方式(详见各文档):
|
||||
|
||||
- 开放 API 基础地址:`https://proapi.115.com/open/...`
|
||||
- 认证方式:`Authorization: Bearer access_token`
|
||||
- OAuth 授权相关文档见 `115开放平台/接入指南/接入授权/`
|
||||
@@ -1,308 +0,0 @@
|
||||
{
|
||||
"name": "doc",
|
||||
"path": "/doc/",
|
||||
"children": [
|
||||
{
|
||||
"name": "115开放平台",
|
||||
"path": "/doc/115开放平台/",
|
||||
"children": [
|
||||
{
|
||||
"name": "简介",
|
||||
"path": "/doc/115开放平台/简介/",
|
||||
"children": [
|
||||
{
|
||||
"name": "概述.md",
|
||||
"path": "/doc/115开放平台/简介/概述.md",
|
||||
"type": "file"
|
||||
},
|
||||
{
|
||||
"name": "更新记录.md",
|
||||
"path": "/doc/115开放平台/简介/更新记录.md",
|
||||
"type": "file"
|
||||
}
|
||||
],
|
||||
"type": "directory"
|
||||
},
|
||||
{
|
||||
"name": "接入指南",
|
||||
"path": "/doc/115开放平台/接入指南/",
|
||||
"children": [
|
||||
{
|
||||
"name": "接入流程.md",
|
||||
"path": "/doc/115开放平台/接入指南/接入流程.md",
|
||||
"type": "file"
|
||||
},
|
||||
{
|
||||
"name": "开发须知.md",
|
||||
"path": "/doc/115开放平台/接入指南/开发须知.md",
|
||||
"type": "file"
|
||||
},
|
||||
{
|
||||
"name": "授权错误码.md",
|
||||
"path": "/doc/115开放平台/接入指南/授权错误码.md",
|
||||
"type": "file"
|
||||
},
|
||||
{
|
||||
"name": "接入授权",
|
||||
"path": "/doc/115开放平台/接入指南/接入授权/",
|
||||
"children": [
|
||||
{
|
||||
"name": "手机扫码授权PKCE模式",
|
||||
"path": "/doc/115开放平台/接入指南/接入授权/手机扫码授权PKCE模式/",
|
||||
"children": [
|
||||
{
|
||||
"name": "获取设备码和二维码内容.md",
|
||||
"path": "/doc/115开放平台/接入指南/接入授权/手机扫码授权PKCE模式/获取设备码和二维码内容.md",
|
||||
"type": "file"
|
||||
},
|
||||
{
|
||||
"name": "轮询二维码状态.md",
|
||||
"path": "/doc/115开放平台/接入指南/接入授权/手机扫码授权PKCE模式/轮询二维码状态.md",
|
||||
"type": "file"
|
||||
},
|
||||
{
|
||||
"name": "获取access_token.md",
|
||||
"path": "/doc/115开放平台/接入指南/接入授权/手机扫码授权PKCE模式/获取access_token.md",
|
||||
"type": "file"
|
||||
}
|
||||
],
|
||||
"type": "directory"
|
||||
},
|
||||
{
|
||||
"name": "授权码模式",
|
||||
"path": "/doc/115开放平台/接入指南/接入授权/授权码模式/",
|
||||
"children": [
|
||||
{
|
||||
"name": "请求授权.md",
|
||||
"path": "/doc/115开放平台/接入指南/接入授权/授权码模式/请求授权.md",
|
||||
"type": "file"
|
||||
},
|
||||
{
|
||||
"name": "用授权码换取access_token.md",
|
||||
"path": "/doc/115开放平台/接入指南/接入授权/授权码模式/用授权码换取access_token.md",
|
||||
"type": "file"
|
||||
}
|
||||
],
|
||||
"type": "directory"
|
||||
},
|
||||
{
|
||||
"name": "刷新access_token.md",
|
||||
"path": "/doc/115开放平台/接入指南/接入授权/刷新access_token.md",
|
||||
"type": "file"
|
||||
}
|
||||
],
|
||||
"type": "directory"
|
||||
}
|
||||
],
|
||||
"type": "directory"
|
||||
},
|
||||
{
|
||||
"name": "API列表",
|
||||
"path": "/doc/115开放平台/API列表/",
|
||||
"children": [
|
||||
{
|
||||
"name": "开发者商业价值转化:推广产品得收益.md",
|
||||
"path": "/doc/115开放平台/API列表/开发者商业价值转化:推广产品得收益.md",
|
||||
"type": "file"
|
||||
},
|
||||
{
|
||||
"name": "用户管理",
|
||||
"path": "/doc/115开放平台/API列表/用户管理/",
|
||||
"children": [
|
||||
{
|
||||
"name": "用户信息.md",
|
||||
"path": "/doc/115开放平台/API列表/用户管理/用户信息.md",
|
||||
"type": "file"
|
||||
}
|
||||
],
|
||||
"type": "directory"
|
||||
},
|
||||
{
|
||||
"name": "文件管理",
|
||||
"path": "/doc/115开放平台/API列表/文件管理/",
|
||||
"children": [
|
||||
{
|
||||
"name": "文件上传",
|
||||
"path": "/doc/115开放平台/API列表/文件管理/文件上传/",
|
||||
"children": [
|
||||
{
|
||||
"name": "上传流程.md",
|
||||
"path": "/doc/115开放平台/API列表/文件管理/文件上传/上传流程.md",
|
||||
"type": "file"
|
||||
},
|
||||
{
|
||||
"name": "获取上传凭证.md",
|
||||
"path": "/doc/115开放平台/API列表/文件管理/文件上传/获取上传凭证.md",
|
||||
"type": "file"
|
||||
},
|
||||
{
|
||||
"name": "文件上传.md",
|
||||
"path": "/doc/115开放平台/API列表/文件管理/文件上传/文件上传.md",
|
||||
"type": "file"
|
||||
},
|
||||
{
|
||||
"name": "断点续传.md",
|
||||
"path": "/doc/115开放平台/API列表/文件管理/文件上传/断点续传.md",
|
||||
"type": "file"
|
||||
}
|
||||
],
|
||||
"type": "directory"
|
||||
},
|
||||
{
|
||||
"name": "新建文件夹.md",
|
||||
"path": "/doc/115开放平台/API列表/文件管理/新建文件夹.md",
|
||||
"type": "file"
|
||||
},
|
||||
{
|
||||
"name": "获取文件列表.md",
|
||||
"path": "/doc/115开放平台/API列表/文件管理/获取文件列表.md",
|
||||
"type": "file"
|
||||
},
|
||||
{
|
||||
"name": "获取文件(夹)详情",
|
||||
"path": "/doc/115开放平台/API列表/文件管理/获取文件(夹)详情/",
|
||||
"children": [
|
||||
{
|
||||
"name": "按ID获取.md",
|
||||
"path": "/doc/115开放平台/API列表/文件管理/获取文件(夹)详情/按ID获取.md",
|
||||
"type": "file"
|
||||
},
|
||||
{
|
||||
"name": "按路径获取.md",
|
||||
"path": "/doc/115开放平台/API列表/文件管理/获取文件(夹)详情/按路径获取.md",
|
||||
"type": "file"
|
||||
}
|
||||
],
|
||||
"type": "directory"
|
||||
},
|
||||
{
|
||||
"name": "文件搜索.md",
|
||||
"path": "/doc/115开放平台/API列表/文件管理/文件搜索.md",
|
||||
"type": "file"
|
||||
},
|
||||
{
|
||||
"name": "文件复制.md",
|
||||
"path": "/doc/115开放平台/API列表/文件管理/文件复制.md",
|
||||
"type": "file"
|
||||
},
|
||||
{
|
||||
"name": "文件移动.md",
|
||||
"path": "/doc/115开放平台/API列表/文件管理/文件移动.md",
|
||||
"type": "file"
|
||||
},
|
||||
{
|
||||
"name": "获取文件下载地址.md",
|
||||
"path": "/doc/115开放平台/API列表/文件管理/获取文件下载地址.md",
|
||||
"type": "file"
|
||||
},
|
||||
{
|
||||
"name": "文件(夹)更新.md",
|
||||
"path": "/doc/115开放平台/API列表/文件管理/文件(夹)更新.md",
|
||||
"type": "file"
|
||||
},
|
||||
{
|
||||
"name": "删除文件.md",
|
||||
"path": "/doc/115开放平台/API列表/文件管理/删除文件.md",
|
||||
"type": "file"
|
||||
},
|
||||
{
|
||||
"name": "回收站列表.md",
|
||||
"path": "/doc/115开放平台/API列表/文件管理/回收站列表.md",
|
||||
"type": "file"
|
||||
},
|
||||
{
|
||||
"name": "回收站还原.md",
|
||||
"path": "/doc/115开放平台/API列表/文件管理/回收站还原.md",
|
||||
"type": "file"
|
||||
},
|
||||
{
|
||||
"name": "删除或清空回收站.md",
|
||||
"path": "/doc/115开放平台/API列表/文件管理/删除或清空回收站.md",
|
||||
"type": "file"
|
||||
}
|
||||
],
|
||||
"type": "directory"
|
||||
},
|
||||
{
|
||||
"name": "视频播放",
|
||||
"path": "/doc/115开放平台/API列表/视频播放/",
|
||||
"children": [
|
||||
{
|
||||
"name": "记忆视频播放进度.md",
|
||||
"path": "/doc/115开放平台/API列表/视频播放/记忆视频播放进度.md",
|
||||
"type": "file"
|
||||
},
|
||||
{
|
||||
"name": "视频字幕列表.md",
|
||||
"path": "/doc/115开放平台/API列表/视频播放/视频字幕列表.md",
|
||||
"type": "file"
|
||||
},
|
||||
{
|
||||
"name": "获取视频播放进度.md",
|
||||
"path": "/doc/115开放平台/API列表/视频播放/获取视频播放进度.md",
|
||||
"type": "file"
|
||||
},
|
||||
{
|
||||
"name": "获取视频在线播放地址.md",
|
||||
"path": "/doc/115开放平台/API列表/视频播放/获取视频在线播放地址.md",
|
||||
"type": "file"
|
||||
},
|
||||
{
|
||||
"name": "提交视频转码.md",
|
||||
"path": "/doc/115开放平台/API列表/视频播放/提交视频转码.md",
|
||||
"type": "file"
|
||||
}
|
||||
],
|
||||
"type": "directory"
|
||||
},
|
||||
{
|
||||
"name": "云下载",
|
||||
"path": "/doc/115开放平台/API列表/云下载/",
|
||||
"children": [
|
||||
{
|
||||
"name": "解析BT种子.md",
|
||||
"path": "/doc/115开放平台/API列表/云下载/解析BT种子.md",
|
||||
"type": "file"
|
||||
},
|
||||
{
|
||||
"name": "获取用户云下载任务列表.md",
|
||||
"path": "/doc/115开放平台/API列表/云下载/获取用户云下载任务列表.md",
|
||||
"type": "file"
|
||||
},
|
||||
{
|
||||
"name": "获取云下载配额信息.md",
|
||||
"path": "/doc/115开放平台/API列表/云下载/获取云下载配额信息.md",
|
||||
"type": "file"
|
||||
},
|
||||
{
|
||||
"name": "清空云下载任务.md",
|
||||
"path": "/doc/115开放平台/API列表/云下载/清空云下载任务.md",
|
||||
"type": "file"
|
||||
},
|
||||
{
|
||||
"name": "添加云下载链接任务.md",
|
||||
"path": "/doc/115开放平台/API列表/云下载/添加云下载链接任务.md",
|
||||
"type": "file"
|
||||
},
|
||||
{
|
||||
"name": "删除用户云下载任务.md",
|
||||
"path": "/doc/115开放平台/API列表/云下载/删除用户云下载任务.md",
|
||||
"type": "file"
|
||||
},
|
||||
{
|
||||
"name": "添加云下载BT任务.md",
|
||||
"path": "/doc/115开放平台/API列表/云下载/添加云下载BT任务.md",
|
||||
"type": "file"
|
||||
}
|
||||
],
|
||||
"type": "directory"
|
||||
}
|
||||
],
|
||||
"type": "directory"
|
||||
}
|
||||
],
|
||||
"type": "directory"
|
||||
}
|
||||
],
|
||||
"type": "directory"
|
||||
}
|
||||
-123
@@ -1,123 +0,0 @@
|
||||
# 贡献规范
|
||||
|
||||
感谢你愿意帮助 MeBox 变得更稳定。这个项目主要面向 NAS、Docker 部署、媒体库整理、订阅下载和多端播放场景;提交 Issue 或 Pull Request 时,请尽量提供可复现、可验证的信息。
|
||||
|
||||
## Issue 提交规范
|
||||
|
||||
提交 Issue 前,请先确认:
|
||||
|
||||
- 已搜索现有 Issues,避免重复提交同一个问题。
|
||||
- 使用的是最新镜像、最新主分支,或已说明当前版本号 / 镜像摘要。
|
||||
- 如果是部署或运行问题,已附上部署方式和关键配置。
|
||||
|
||||
### Bug Report 必填信息
|
||||
|
||||
- 问题现象:实际发生了什么,是否稳定复现。
|
||||
- 期望行为:你认为正确结果应该是什么。
|
||||
- 复现步骤:从哪个页面、点击什么、填写什么、触发什么任务。
|
||||
- 部署方式:Docker 第一档 / 第二档 / 第三档、裸机运行、反代方式等。
|
||||
- 环境信息:NAS 型号或系统、Docker / Compose 版本、浏览器、MeBox 镜像版本。
|
||||
- 相关配置:路径映射、下载器保存路径、媒体库路径、站点类型等。请隐藏 Cookie、API Key、密码和 Token。
|
||||
- 日志和任务信息:优先提供应用日志、任务队列详情、浏览器控制台错误、网络请求错误。
|
||||
|
||||
### 日志建议
|
||||
|
||||
排查订阅、站点搜索、下载器、整理入库、网盘扫描时,建议临时把日志级别调整为 `info` 或 `debug`,复现后再恢复。
|
||||
|
||||
Docker 部署常用命令:
|
||||
|
||||
```bash
|
||||
docker compose ps
|
||||
docker compose logs --tail=300 mebox
|
||||
docker compose exec mebox sh -lc 'ls -la /data/logs || true'
|
||||
```
|
||||
|
||||
PostgreSQL 部署查询示例:
|
||||
|
||||
```bash
|
||||
docker compose exec postgres psql -U mebox -d mebox -c "select key,value,updated_at from settings order by updated_at desc limit 30;"
|
||||
```
|
||||
|
||||
请勿公开粘贴以下敏感信息:
|
||||
|
||||
- 站点 Cookie、Passkey、API Key、YemaPT Auth Key、M-Team API Key。
|
||||
- qBittorrent / Transmission / Aria2 密码。
|
||||
- Telegram Bot Token。
|
||||
- JWT、数据库密码、私有下载链接。
|
||||
|
||||
## Pull Request 提交规范
|
||||
|
||||
所有非紧急变更都应通过 Pull Request 合入 `main`,不要直接向主分支推送。贡献者可以从 fork 或本仓库的独立分支发起 PR;维护者只有在紧急安全修复、发布流水线修复等特殊场景下,才可以短暂绕过 PR 流程,并需要在提交说明或后续 Issue 中补充原因。
|
||||
|
||||
PR 应该尽量小而清晰。一次 PR 聚焦一个问题或一组强相关改动,避免把无关重构、格式化和功能混在一起。
|
||||
|
||||
### 分支要求
|
||||
|
||||
- 分支从最新 `main` 创建,提交前先同步远端主分支。
|
||||
- 分支名建议使用 `fix/...`、`feat/...`、`docs/...` 或 `test/...`。
|
||||
- 不要在 `main` 上直接开发和提交 PR 内容。
|
||||
- 不要把个人部署配置、NAS 本地路径、私有镜像标签或测试数据提交进 PR。
|
||||
- 如果基于魔改版、私有部署版或临时补丁开发,请先确认改动能在本仓库最新 `main` 上复现和应用,再提交 PR。
|
||||
|
||||
### PR 描述应包含
|
||||
|
||||
- 背景:修复哪个 Issue / 哪个用户场景 / 哪个回归。
|
||||
- 改动摘要:后端、前端、配置、文档分别改了什么。
|
||||
- 验证结果:运行过哪些命令,是否有无法运行的测试。
|
||||
- 风险说明:数据迁移、Docker 配置、路径映射、下载器行为、站点 API 限流等是否受影响。
|
||||
- 截图或录屏:涉及 UI、任务队列、错误提示、设置页时请附上。
|
||||
|
||||
### 推荐验证命令
|
||||
|
||||
根据改动范围选择运行:
|
||||
|
||||
```bash
|
||||
go test ./...
|
||||
npm --prefix web run build
|
||||
git diff --check
|
||||
```
|
||||
|
||||
如果只改动某个模块,可以先跑定向测试,例如:
|
||||
|
||||
```bash
|
||||
go test ./internal/service -run "TestOrganize|TestSubscription|TestMTeam" -count=1
|
||||
go test ./cmd/server -count=1
|
||||
```
|
||||
|
||||
数据库兼容测试默认覆盖 SQLite。连接专用测试 PostgreSQL 后可运行真实的双数据库回归:
|
||||
|
||||
```bash
|
||||
MEBOX_TEST_POSTGRES_DSN='postgres://mebox:test-password@127.0.0.1:5432/mebox_test?sslmode=disable' \
|
||||
go test ./internal/database ./internal/repository -count=1
|
||||
```
|
||||
|
||||
测试账号需要创建、删除 schema 的权限;每个用例使用独立的临时 schema。CI 会分别在 PostgreSQL 16、17 上执行这些检查。
|
||||
|
||||
### 代码要求
|
||||
|
||||
- Go 代码使用 `gofmt`。
|
||||
- 前端 TypeScript 需要通过 `npm --prefix web run build`。
|
||||
- 用户可见错误需要可操作:说明失败原因、下一步怎么查或怎么修。
|
||||
- 后台任务失败不要静默吞掉,应进入任务队列、日志或 API 响应。
|
||||
- Docker/NAS 路径相关改动必须考虑宿主机路径与容器路径映射。
|
||||
- 站点 API、订阅和下载器改动需要注意去重、限流、敏感信息脱敏。
|
||||
|
||||
## Commit Message 建议
|
||||
|
||||
优先使用简短清晰的动词开头:
|
||||
|
||||
```text
|
||||
fix organizer hardlink diagnostics
|
||||
feat(yemapt): add auth-only site adapter
|
||||
docs: add issue and pull request guidelines
|
||||
test: cover subscription restore matching
|
||||
```
|
||||
|
||||
## 维护者合并检查
|
||||
|
||||
合并前建议确认:
|
||||
|
||||
- PR 范围清楚,没有夹带无关改动。
|
||||
- 自动化检查通过,或失败原因已说明。
|
||||
- 修改涉及的用户路径已有日志、错误提示或回归测试。
|
||||
- 文档、示例配置和 README 是否需要同步更新。
|
||||
-98
@@ -1,98 +0,0 @@
|
||||
# syntax=docker/dockerfile:1.6
|
||||
# =============================================================================
|
||||
# Multi-architecture build for MeBox.
|
||||
#
|
||||
# Stage 1 (frontend) : Node 20.19+ -> static SPA bundle
|
||||
# Stage 2 (backend) : Go 1.26 -> single static binary (CGO_ENABLED=0)
|
||||
# Stage 3 (runtime) : Alpine 3.23 -> ffmpeg + tzdata + non-root user
|
||||
#
|
||||
# Build:
|
||||
# docker buildx build --platform linux/amd64,linux/arm64 \
|
||||
# --build-arg VERSION=MeBox-v0.1.16 -t mebox:latest --push .
|
||||
#
|
||||
# Optional Intel VAAPI/QSV runtime packages:
|
||||
# docker buildx build --build-arg WITH_VAAPI=true ...
|
||||
# =============================================================================
|
||||
|
||||
# ---- Stage 1: frontend (always build on the host architecture) -------------
|
||||
FROM --platform=$BUILDPLATFORM node:20.19-alpine AS frontend
|
||||
ARG NPM_CONFIG_REGISTRY=https://registry.npmjs.org/
|
||||
WORKDIR /app/web
|
||||
COPY web/package*.json ./
|
||||
RUN --mount=type=cache,target=/root/.npm \
|
||||
npm ci --registry="${NPM_CONFIG_REGISTRY}"
|
||||
COPY web/ .
|
||||
RUN npm run build
|
||||
|
||||
# ---- Stage 2: backend (cross-compiled to TARGETPLATFORM) -------------------
|
||||
FROM --platform=$BUILDPLATFORM golang:1.26-alpine AS backend
|
||||
ARG TARGETOS
|
||||
ARG TARGETARCH
|
||||
ARG GOPROXY=https://proxy.golang.org,direct
|
||||
ARG VERSION=dev
|
||||
ENV GOPROXY=${GOPROXY}
|
||||
WORKDIR /app
|
||||
COPY go.mod go.sum ./
|
||||
RUN --mount=type=cache,target=/go/pkg/mod \
|
||||
go mod download
|
||||
COPY . .
|
||||
COPY --from=frontend /app/web/dist ./web/dist
|
||||
RUN --mount=type=cache,target=/go/pkg/mod \
|
||||
CGO_ENABLED=0 GOOS=${TARGETOS} GOARCH=${TARGETARCH} \
|
||||
go build -trimpath -ldflags="-s -w -X main.version=${VERSION}" -o mebox ./cmd/server
|
||||
|
||||
# ---- Stage 3: runtime ------------------------------------------------------
|
||||
FROM alpine:3.23
|
||||
ARG WITH_VAAPI=false
|
||||
# Default runtime keeps only the packages needed by normal deployments.
|
||||
# VAAPI/mesa drivers pull a large graphics dependency tree, so they are opt-in
|
||||
# for users who explicitly build an Intel hardware-acceleration image.
|
||||
# NVENC requires the proprietary NVIDIA Container Toolkit on the host only.
|
||||
RUN apk add --no-cache \
|
||||
ffmpeg \
|
||||
docker-cli \
|
||||
tzdata \
|
||||
ca-certificates \
|
||||
su-exec \
|
||||
&& if [ "$WITH_VAAPI" = "true" ]; then \
|
||||
if [ "$(apk --print-arch)" = "x86_64" ]; then \
|
||||
apk add --no-cache intel-media-driver libva-utils mesa-va-gallium; \
|
||||
else \
|
||||
apk add --no-cache libva-utils mesa-va-gallium || true; \
|
||||
fi; \
|
||||
fi \
|
||||
&& rm -rf /var/cache/apk/*
|
||||
|
||||
# Non-root user for the long-running process.
|
||||
RUN addgroup -S mebox && adduser -S mebox -G mebox
|
||||
|
||||
WORKDIR /app
|
||||
COPY --from=backend /app/mebox /usr/local/bin/mebox
|
||||
COPY --from=frontend /app/web/dist /app/web/dist
|
||||
|
||||
RUN mkdir -p /data /cache /media \
|
||||
&& chown -R mebox:mebox /data /cache /media
|
||||
|
||||
# Default environment (overridable via docker-compose / `docker run -e`).
|
||||
ENV MEBOX_APP_PORT=8080 \
|
||||
MEBOX_APP_DATA_DIR=/data \
|
||||
MEBOX_APP_WEB_DIR=/app/web/dist \
|
||||
MEBOX_DATABASE_DB_PATH=/data/mebox.db \
|
||||
MEBOX_CACHE_CACHE_DIR=/cache \
|
||||
MEBOX_LOGGING_LEVEL=info \
|
||||
TZ=Asia/Shanghai
|
||||
|
||||
EXPOSE 8080
|
||||
|
||||
# 探测协议不能写死:开启 HTTPS 后 8080 只接受 TLS。脚本按数据目录里的
|
||||
# .http_scheme 选择协议并在失败时回退,无需用户改配置。
|
||||
HEALTHCHECK --interval=30s --timeout=10s --start-period=30s --retries=3 \
|
||||
CMD ["/usr/local/bin/mebox-healthcheck"]
|
||||
|
||||
# Tiny entrypoint that lets us run as a NAS host UID/GID via PUID/PGID without
|
||||
# rewriting /etc/passwd or /etc/group on every container start.
|
||||
COPY docker-entrypoint.sh /entrypoint.sh
|
||||
COPY docker-healthcheck.sh /usr/local/bin/mebox-healthcheck
|
||||
RUN chmod +x /entrypoint.sh /usr/local/bin/mebox-healthcheck
|
||||
|
||||
CMD ["/entrypoint.sh"]
|
||||
@@ -1,9 +0,0 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
This project is licensed under the GNU GPL v3.0.
|
||||
For the full license text, see https://www.gnu.org/licenses/gpl-3.0.txt
|
||||
@@ -1,285 +0,0 @@
|
||||
# MeBox
|
||||
|
||||
<p align="center">
|
||||
<img src="web/public/brand/logo-192.png" width="96" height="96" alt="MeBox Logo" />
|
||||
</p>
|
||||
|
||||
<h3 align="center">面向 NAS 与家庭影音场景的私人媒体中心</h3>
|
||||
|
||||
<p align="center">
|
||||
<strong>媒体库 · 刮削整理 · 网盘 STRM · 兼容 Emby/Jellyfin 客户端 · 远程 Emby 挂载 · 多用户权限 · Docker 一键部署</strong>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="#项目简介">项目简介</a> ·
|
||||
<a href="#快速开始">快速开始</a> ·
|
||||
<a href="#部署档位">部署档位</a> ·
|
||||
<a href="#鸣谢">鸣谢</a> ·
|
||||
<a href="#开发构建">开发构建</a> ·
|
||||
<a href="README_EN.md">English</a> ·
|
||||
<a href="CONTRIBUTING.md">贡献规范</a> ·
|
||||
<a href="https://t.me/MeBoxGroup">Telegram 群组</a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<img alt="Go" src="https://img.shields.io/badge/Go-1.26+-00ADD8?style=flat-square&logo=go&logoColor=white" />
|
||||
<img alt="React" src="https://img.shields.io/badge/React-18-61DAFB?style=flat-square&logo=react&logoColor=111827" />
|
||||
<img alt="Docker" src="https://img.shields.io/badge/Docker-ready-2496ED?style=flat-square&logo=docker&logoColor=white" />
|
||||
<img alt="License" src="https://img.shields.io/badge/License-GPL--3.0-blue?style=flat-square" />
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
## 项目简介
|
||||
|
||||
**MeBox** 是一个自托管私人媒体管理系统,适合 NAS、小主机、家庭共享和多端播放场景。本项目由 [MediaStationGo](https://github.com/ShukeBta/MediaStationGo) fork 并持续二开维护,在保留「一套服务覆盖网页、手机、电视与第三方播放器」思路的同时,围绕网盘播放、任务队列、远程挂载和权限体系做了大量增强。
|
||||
|
||||
你可以把 MeBox 理解为:
|
||||
|
||||
- 一个带现代 Web UI 的**媒体库后台**
|
||||
- 一个兼容 Emby/Jellyfin 客户端的**协议网关**
|
||||
- 一个连接本地硬盘、下载目录与网盘存储的**整理与播放入口**
|
||||
|
||||
### 核心能力
|
||||
|
||||
| 模块 | 说明 |
|
||||
| --- | --- |
|
||||
| **媒体库** | 电影、电视剧、动漫、综艺、音乐与自定义库;多根目录、扫库、海报墙、继续观看 |
|
||||
| **元数据刮削** | TMDb、Bangumi、Douban、TheTVDB、Fanart 等;支持 NFO、手动匹配、刮削队列 |
|
||||
| **播放** | 网页播放器、HLS 转码、弹幕、字幕、播放配置档、观看历史与收藏 |
|
||||
| **Emby/Jellyfin 客户端兼容** | 内置完整 Emby 服务端协议实现:Infuse、SenPlayer、Fileball、Emby/Jellyfin 官方客户端等可直接把本服务当作 Emby 服务器添加,使用 MeBox 账号登录,海报墙、进度同步、多用户无缝衔接 |
|
||||
| **远程 Emby 挂载** | 将远程 Emby 媒体库挂载到本地界面统一浏览(无需单独开 Emby 客户端) |
|
||||
| **网盘与 STRM** | OpenList、CloudDrive2、115、WebDAV 等;STRM 同步、上传/下载队列、直链/302 播放 |
|
||||
| **下载与整理** | 下载目录定时自动整理(智能分类、自动注册媒体库)、文件管理器(复制/移动/硬链/软链) |
|
||||
| **用户与权限** | 管理员/普通用户、有效期、成人内容开关、播放配置 PIN、细粒度操作权限 |
|
||||
| **运维能力** | 统一任务队列、存储统计、DLNA 投屏、系统设置与日志 |
|
||||
|
||||
### 技术栈
|
||||
|
||||
- **后端**:Go · Gin · GORM · SQLite / PostgreSQL · 可选 Redis · 可选 OpenSearch
|
||||
- **前端**:React 18 · Vite · TypeScript · Tailwind CSS · Zustand
|
||||
- **部署**:Docker Compose 多档模板,支持 amd64 / arm64 镜像与单文件可执行发布
|
||||
|
||||
---
|
||||
|
||||
## 快速开始
|
||||
|
||||
推荐使用 Docker Compose。仓库提供四份**互相独立**的完整模板,无需 `.env` 即可起步。
|
||||
|
||||
```bash
|
||||
mkdir -p MeBox && cd MeBox
|
||||
|
||||
# 最省心:单镜像 + 内置 SQLite
|
||||
curl -fsSL https://raw.githubusercontent.com/truewhile/MeBox/main/docker-compose.simple.yml -o docker-compose.yml
|
||||
|
||||
# 或多用户场景:PostgreSQL 第一档
|
||||
# curl -fsSL https://raw.githubusercontent.com/truewhile/MeBox/main/docker-compose.yml -o docker-compose.yml
|
||||
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
浏览器访问:
|
||||
|
||||
```text
|
||||
http://服务器IP:18080
|
||||
```
|
||||
|
||||
默认账号:`admin` / `admin123`(首次登录后请立即修改密码)
|
||||
|
||||
> 💡 **Emby 用户无缝切换**:MeBox 完整兼容 Emby/Jellyfin 客户端协议。手机、电视、平板上的 Infuse、SenPlayer、Fileball、Emby/Jellyfin 官方客户端,直接按「添加 Emby 服务器」填入 `http://服务器IP:18080`,用 MeBox 账号登录即可,无需改变原有使用习惯。
|
||||
|
||||
镜像地址:
|
||||
|
||||
```text
|
||||
ghcr.io/truewhile/mebox:latest
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 部署档位
|
||||
|
||||
按机器资源选择档位。每份 Compose 文件均可单独使用,**不要**叠加多个 `-f`。
|
||||
|
||||
| 档位 | 配置文件 | 组件 | 适合场景 |
|
||||
| --- | --- | --- | --- |
|
||||
| 单镜像档 | `docker-compose.simple.yml` | MeBox + SQLite | 新手、单人、低配 NAS,只想一个容器跑起来 |
|
||||
| 第一档 | `docker-compose.yml` | MeBox + PostgreSQL | 大多数家庭 NAS,多用户更稳 |
|
||||
| 第二档 | `docker-compose.standard.yml` | + Redis | 多用户、Emby 客户端频繁刷新、首页/列表访问多 |
|
||||
| 第三档 | `docker-compose.search.yml` | + OpenSearch | 超大媒体库、复杂全文搜索(内存占用更高) |
|
||||
|
||||
### 单镜像档要点
|
||||
|
||||
- 只启动 **一个** MeBox 容器,数据在 `./data/mebox.db`
|
||||
- 通常只需改端口与媒体目录挂载
|
||||
- **不要**设置 `MEBOX_DATABASE_DSN`,否则会切到 PostgreSQL
|
||||
|
||||
```yaml
|
||||
ports:
|
||||
- "18080:8080"
|
||||
volumes:
|
||||
- ./data:/data # 必须备份
|
||||
- ./cache:/cache # 可重建
|
||||
- ./media:/media # 改成你的媒体目录
|
||||
```
|
||||
|
||||
网页添加媒体库时填写容器内路径,例如 `/media`、`/media/电影`。
|
||||
|
||||
### PostgreSQL 档位要点
|
||||
|
||||
- 主库在 `./postgres`,配置与密钥在 `./data`
|
||||
- 若存在旧版 `./data/mebox.db`,首次启动会自动迁移到 PostgreSQL
|
||||
- 迁移完成后可将 `MEBOX_DATABASE_DB_PATH` 改为不存在路径,避免重复检查:
|
||||
|
||||
```yaml
|
||||
MEBOX_DATABASE_DB_PATH: /data/no-sqlite-migration.db
|
||||
```
|
||||
|
||||
### 必须备份与可重建
|
||||
|
||||
| 路径 | 说明 |
|
||||
| --- | --- |
|
||||
| `./data` | JWT 密钥、运行配置、SQLite 主库或迁移源 |
|
||||
| `./postgres` | PostgreSQL 主库(PG 档位) |
|
||||
| `./cache` | 海报/转码缓存,可重建 |
|
||||
| `./redis` | 热缓存,可重建 |
|
||||
| `./opensearch` | 搜索索引,可重建 |
|
||||
|
||||
### 更新镜像
|
||||
|
||||
```bash
|
||||
docker compose pull mebox
|
||||
docker compose up -d --no-deps mebox
|
||||
```
|
||||
|
||||
日常更新只拉 `mebox` 服务即可,不要随意 `docker compose pull` 升级 PostgreSQL/Redis/OpenSearch 基础镜像。
|
||||
|
||||
---
|
||||
|
||||
## 路径映射
|
||||
|
||||
Docker 部署最常见的问题是路径填错。记住:
|
||||
|
||||
- `volumes` **左侧**是宿主机真实路径,**右侧**是容器内路径
|
||||
- 网页后台添加媒体库时,应填写**容器内**路径(如 `/media/电影`)
|
||||
- 若使用自动整理/下载入库,`MEBOX_MEDIA_DIR` 与 `MEBOX_DOWNLOAD_DIR` 需与挂载一致
|
||||
|
||||
NAS 示例:
|
||||
|
||||
```yaml
|
||||
volumes:
|
||||
- /vol1/1000/Media:/media
|
||||
- /vol1/1000/Downloads:/downloads
|
||||
environment:
|
||||
MEBOX_MEDIA_DIR: /vol1/1000/Media
|
||||
MEBOX_MEDIA_CONTAINER_DIR: /media
|
||||
MEBOX_DOWNLOAD_DIR: /vol1/1000/Downloads
|
||||
MEBOX_DOWNLOAD_CONTAINER_DIR: /downloads
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 首次使用建议
|
||||
|
||||
1. **创建媒体库** → 填写 `/media/...` → 执行扫库
|
||||
2. **配置元数据源** → 系统设置中添加 TMDb、Bangumi 等 API
|
||||
3. **(可选)配置下载目录自动整理** → 文件管理中将下载目录设为整理源,下载完成后自动分类入库
|
||||
4. **(可选)配置网盘账号** → STRM 管理中添加 OpenList / 115 / WebDAV 等
|
||||
5. **第三方播放器** → 以 Emby 服务器添加 `http://服务器IP:18080`,使用 MeBox 账号登录
|
||||
|
||||
---
|
||||
|
||||
## 常见问题
|
||||
|
||||
**扫库或入库很慢?**
|
||||
先确认路径映射与数据库档位。网盘扫描还受接口限速与目录规模影响;大库可考虑第二档 Redis 或第三档 OpenSearch。
|
||||
|
||||
**下载目录文件没有被自动整理?**
|
||||
确认下载目录已通过 `volumes` 挂进容器,且 `MEBOX_DOWNLOAD_*` 环境变量对应正确。MeBox 负责目录整理入库,qBittorrent 等下载器按普通软件自行部署即可。
|
||||
|
||||
**硬链接失败(cross-device link)?**
|
||||
硬链接要求源与目标在同一文件系统/子卷;跨盘、跨 btrfs 子卷或网盘挂载时请改用复制或软链接。
|
||||
|
||||
**日志保留时间太短?**
|
||||
|
||||
默认应用日志为 `20MB x 5`,容器 stdout 日志为 `20m x 3`。排障时可在 compose 中调大
|
||||
`MEBOX_LOGGING_MAX_SIZE_MB`、`MEBOX_LOGGING_MAX_BACKUPS` 与服务的 `logging.options.max-size/max-file`。
|
||||
|
||||
**第三方播放器连不上?**
|
||||
确认地址为 `http://IP:18080`,使用 MeBox 用户账号;反代部署需正确配置外部 URL 与 HTTPS 头。
|
||||
|
||||
---
|
||||
|
||||
## 开发构建
|
||||
|
||||
后端通过 `go:embed` 嵌入 `web/dist`,**编译前必须先构建前端**。
|
||||
前端构建要求 Node.js `20.19+` 或 `22.12+`。
|
||||
|
||||
```bash
|
||||
npm --prefix web ci
|
||||
npm --prefix web run build
|
||||
|
||||
go test ./...
|
||||
go run ./cmd/server # http://127.0.0.1:8080
|
||||
npm --prefix web run dev # http://127.0.0.1:3000
|
||||
```
|
||||
|
||||
CI 会在 Release 中提供 Windows / Linux / macOS 的 amd64、arm64 单文件可执行程序。
|
||||
|
||||
Windows 本地打包:
|
||||
|
||||
```powershell
|
||||
.\scripts\build-windows.ps1 -Version dev
|
||||
```
|
||||
|
||||
Windows 可执行程序使用项目 Logo,不显示控制台窗口;启动后会常驻系统托盘。托盘菜单可打开 MeBox、切换开机自启、查看日志、重启或退出。
|
||||
|
||||
---
|
||||
|
||||
## 鸣谢
|
||||
|
||||
MeBox 在 [MediaStationGo](https://github.com/ShukeBta/MediaStationGo) 的基础上 fork 并持续演进。感谢上游项目在媒体库架构、Emby 协议兼容和自托管体验上的奠基工作。
|
||||
|
||||
项目中许多网盘同步、STRM 与媒体整理相关的设计与实现,也参考了 [qmediasync](https://github.com/qicfan/qmediasync)。感谢该项目的思路与实践经验。
|
||||
|
||||
---
|
||||
|
||||
## 贡献与反馈
|
||||
|
||||
提交 Issue 或 Pull Request 前,请阅读 [贡献规范](CONTRIBUTING.md) 与 [安全策略](SECURITY.md)。
|
||||
|
||||
- Bug 请附部署方式、复现步骤与相关日志
|
||||
- 功能建议请说明使用场景与期望行为
|
||||
- PR 请从独立分支发起,提交前运行 `go test ./...` 与 `npm --prefix web run build`
|
||||
|
||||
---
|
||||
|
||||
## Star History
|
||||
|
||||
<a href="https://www.star-history.com/?repos=truewhile%2FMeBox&type=date&legend=top-left">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/chart?repos=truewhile/MeBox&type=date&theme=dark&legend=top-left" />
|
||||
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/chart?repos=truewhile/MeBox&type=date&legend=top-left" />
|
||||
<img alt="Star History Chart" src="https://api.star-history.com/chart?repos=truewhile/MeBox&type=date&legend=top-left" />
|
||||
</picture>
|
||||
</a>
|
||||
|
||||
---
|
||||
|
||||
## 许可证
|
||||
|
||||
本项目采用 [GPL-3.0](LICENSE) 许可证。
|
||||
|
||||
---
|
||||
|
||||
## 赞赏
|
||||
|
||||
如果 MeBox 帮你把家庭影音折腾明白了,欢迎请作者喝杯咖啡 ☕
|
||||
|
||||
<p align="center">
|
||||
<img src="docs/images/donation-qr.png" width="320" alt="WhileTrue 的赞赏码" />
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<strong>Telegram 交流群</strong>:<a href="https://t.me/MeBoxGroup">https://t.me/MeBoxGroup</a><br/>
|
||||
使用问题、功能建议、更新动态,欢迎来群里聊
|
||||
</p>
|
||||
-255
@@ -1,255 +0,0 @@
|
||||
# MeBox
|
||||
|
||||
<p align="center">
|
||||
<img src="web/public/brand/logo-192.png" width="96" height="96" alt="MeBox Logo" />
|
||||
</p>
|
||||
|
||||
<h3 align="center">A self-hosted media center for NAS and home theater</h3>
|
||||
|
||||
<p align="center">
|
||||
<strong>Libraries · Metadata · Cloud STRM · Emby/Jellyfin client compatible · Remote Emby mounts · Multi-user · Docker-first</strong>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="README.md">中文</a> ·
|
||||
<a href="#overview">Overview</a> ·
|
||||
<a href="#quick-start">Quick Start</a> ·
|
||||
<a href="#deployment-tiers">Deployment</a> ·
|
||||
<a href="#acknowledgements">Acknowledgements</a> ·
|
||||
<a href="#development">Development</a> ·
|
||||
<a href="https://t.me/MeBoxGroup">Telegram</a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<img alt="Go" src="https://img.shields.io/badge/Go-1.26+-00ADD8?style=flat-square&logo=go&logoColor=white" />
|
||||
<img alt="React" src="https://img.shields.io/badge/React-18-61DAFB?style=flat-square&logo=react&logoColor=111827" />
|
||||
<img alt="Docker" src="https://img.shields.io/badge/Docker-ready-2496ED?style=flat-square&logo=docker&logoColor=white" />
|
||||
<img alt="License" src="https://img.shields.io/badge/License-GPL--3.0-blue?style=flat-square" />
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
**MeBox** is a self-hosted private media management system for NAS, mini PCs, family sharing, and multi-device playback. This repository is a maintained fork of [MediaStationGo](https://github.com/ShukeBta/MediaStationGo), extended with stronger cloud playback, task queues, remote mounts, and permission controls.
|
||||
|
||||
In practice, MeBox gives you:
|
||||
|
||||
- A modern **web media library**
|
||||
- An **Emby/Jellyfin-compatible protocol gateway** for third-party players
|
||||
- A single panel for **local disks, download folders, and cloud storage**
|
||||
|
||||
### Key capabilities
|
||||
|
||||
| Area | Highlights |
|
||||
| --- | --- |
|
||||
| **Libraries** | Movies, TV, anime, variety, music, custom libraries; multi-root scanning; poster wall; continue watching |
|
||||
| **Metadata** | TMDb, Bangumi, Douban, TheTVDB, Fanart, NFO import, manual matching, scrape queue |
|
||||
| **Playback** | Web player, HLS transcoding, danmaku, subtitles, play profiles, history and favourites |
|
||||
| **Emby/Jellyfin client compatible** | Full Emby server protocol implementation: Infuse, SenPlayer, Fileball, and official Emby/Jellyfin clients can add MeBox as an Emby server and sign in with MeBox accounts — poster walls, watch progress, and multi-user work out of the box |
|
||||
| **Remote Emby mounts** | Browse remote Emby libraries inside MeBox without a separate Emby client |
|
||||
| **Cloud & STRM** | OpenList, CloudDrive2, 115, WebDAV; STRM sync; upload/download queues; direct or 302 playback |
|
||||
| **Downloads & organize** | Scheduled download-folder organization (smart classification, auto library registration), file manager (copy/move/hardlink/symlink) |
|
||||
| **Users & permissions** | Admin/regular users, expiry, NSFW toggle, play-profile PIN, granular permissions |
|
||||
| **Operations** | Unified task queue, storage stats, DLNA casting, settings and logs |
|
||||
|
||||
### Tech stack
|
||||
|
||||
- **Backend**: Go, Gin, GORM, SQLite or PostgreSQL, optional Redis and OpenSearch
|
||||
- **Frontend**: React 18, Vite, TypeScript, Tailwind CSS, Zustand
|
||||
- **Deployment**: Standalone Docker Compose templates, amd64/arm64 images, single-binary releases
|
||||
|
||||
---
|
||||
|
||||
## Quick Start
|
||||
|
||||
Docker Compose is the recommended path. The repo ships four **standalone** templates; no `.env` is required.
|
||||
|
||||
```bash
|
||||
mkdir -p MeBox && cd MeBox
|
||||
|
||||
# Simplest: one container with built-in SQLite
|
||||
curl -fsSL https://raw.githubusercontent.com/truewhile/MeBox/main/docker-compose.simple.yml -o docker-compose.yml
|
||||
|
||||
# Or PostgreSQL tier for multi-user setups
|
||||
# curl -fsSL https://raw.githubusercontent.com/truewhile/MeBox/main/docker-compose.yml -o docker-compose.yml
|
||||
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
Open:
|
||||
|
||||
```text
|
||||
http://SERVER_IP:18080
|
||||
```
|
||||
|
||||
Default login: `admin` / `admin123` — change the password immediately.
|
||||
|
||||
> 💡 **Seamless for Emby users**: MeBox fully implements the Emby/Jellyfin client protocol. Infuse, SenPlayer, Fileball, and official Emby/Jellyfin apps on phones, TVs, and tablets can add it as an Emby server at `http://SERVER_IP:18080` and sign in with MeBox accounts — no change to your existing workflow.
|
||||
|
||||
Image:
|
||||
|
||||
```text
|
||||
ghcr.io/truewhile/mebox:latest
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Deployment tiers
|
||||
|
||||
Pick one compose file. Do **not** stack multiple `-f` files.
|
||||
|
||||
| Tier | File | Stack | Best for |
|
||||
| --- | --- | --- | --- |
|
||||
| Single image | `docker-compose.simple.yml` | MeBox + SQLite | Beginners, single-user, low-resource NAS |
|
||||
| Tier 1 | `docker-compose.yml` | MeBox + PostgreSQL | Most home NAS deployments |
|
||||
| Tier 2 | `docker-compose.standard.yml` | + Redis | Multi-user, frequent Emby client refreshes |
|
||||
| Tier 3 | `docker-compose.search.yml` | + OpenSearch | Very large libraries, advanced full-text search |
|
||||
|
||||
### Single-image notes
|
||||
|
||||
- Only one MeBox container; database lives in `./data/mebox.db`
|
||||
- Do **not** set `MEBOX_DATABASE_DSN` or it switches to PostgreSQL
|
||||
- Back up `./data`; `./cache` can be rebuilt
|
||||
|
||||
### PostgreSQL notes
|
||||
|
||||
- Primary DB: `./postgres`; secrets and runtime files: `./data`
|
||||
- Existing `./data/mebox.db` migrates automatically on first start
|
||||
- After migration, point `MEBOX_DATABASE_DB_PATH` at a non-existent file to disable re-checks
|
||||
|
||||
### Backup
|
||||
|
||||
| Path | Notes |
|
||||
| --- | --- |
|
||||
| `./data` | JWT secret, config, SQLite DB or migration source |
|
||||
| `./postgres` | PostgreSQL primary DB |
|
||||
| `./cache`, `./redis`, `./opensearch` | Rebuildable |
|
||||
|
||||
### Update
|
||||
|
||||
```bash
|
||||
docker compose pull mebox
|
||||
docker compose up -d --no-deps mebox
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Path mapping
|
||||
|
||||
The most common Docker mistake is mixing host paths with container paths.
|
||||
|
||||
- Left side of `volumes` = real host/NAS path
|
||||
- Right side = container path; use `/media/...` in the web UI
|
||||
- Keep `MEBOX_MEDIA_DIR` / `MEBOX_DOWNLOAD_DIR` aligned with mounts when organizing or ingesting downloads
|
||||
|
||||
Example:
|
||||
|
||||
```yaml
|
||||
volumes:
|
||||
- /vol1/1000/Media:/media
|
||||
- /vol1/1000/Downloads:/downloads
|
||||
environment:
|
||||
MEBOX_MEDIA_DIR: /vol1/1000/Media
|
||||
MEBOX_MEDIA_CONTAINER_DIR: /media
|
||||
MEBOX_DOWNLOAD_DIR: /vol1/1000/Downloads
|
||||
MEBOX_DOWNLOAD_CONTAINER_DIR: /downloads
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## First-time setup
|
||||
|
||||
1. Create a library with a container path such as `/media/Movies`, then scan
|
||||
2. Add metadata providers (TMDb, Bangumi, etc.) in system settings
|
||||
3. Optionally set up download-folder auto-organization under file management so finished downloads land in the right library
|
||||
4. Optionally configure cloud accounts under STRM management
|
||||
5. Add the server in Emby-compatible players at `http://SERVER_IP:18080` using MeBox credentials
|
||||
|
||||
---
|
||||
|
||||
## FAQ
|
||||
|
||||
**Library scan is slow**
|
||||
Check path mapping and DB tier. Cloud scans also depend on API limits and folder size.
|
||||
|
||||
**Downloaded files are not organized**
|
||||
Ensure the download directory is mounted into the container and env vars match. MeBox handles folder organization; run qBittorrent or any downloader yourself as a regular app.
|
||||
|
||||
**Hardlink fails with cross-device link**
|
||||
Hardlinks require the same filesystem/subvolume; use copy or symlink across disks or cloud mounts.
|
||||
|
||||
**External player cannot connect**
|
||||
Use `http://IP:18080` and a MeBox user account; reverse proxies need correct external URL and HTTPS headers.
|
||||
|
||||
---
|
||||
|
||||
## Development
|
||||
|
||||
The backend embeds `web/dist` via `go:embed`. Build the frontend first.
|
||||
|
||||
```bash
|
||||
npm --prefix web ci
|
||||
npm --prefix web run build
|
||||
|
||||
go test ./...
|
||||
go run ./cmd/server
|
||||
npm --prefix web run dev
|
||||
```
|
||||
|
||||
Release builds ship single-file binaries for Windows, Linux, and macOS on amd64 and arm64.
|
||||
|
||||
Build the Windows executable locally:
|
||||
|
||||
```powershell
|
||||
.\scripts\build-windows.ps1 -Version dev
|
||||
```
|
||||
|
||||
The Windows executable uses the project logo and runs without a console window. It stays in the notification area, with menu actions for opening MeBox, toggling auto-start, viewing logs, restarting, and exiting.
|
||||
|
||||
---
|
||||
|
||||
## Acknowledgements
|
||||
|
||||
MeBox is forked from and continues to evolve [MediaStationGo](https://github.com/ShukeBta/MediaStationGo). Thank you to the upstream project for the media-library architecture, Emby-protocol compatibility, and self-hosted foundation.
|
||||
|
||||
Many cloud sync, STRM, and media-organization ideas in this project were also informed by [qmediasync](https://github.com/qicfan/qmediasync). Thank you for the reference implementation and design patterns.
|
||||
|
||||
---
|
||||
|
||||
## Contributing
|
||||
|
||||
See [CONTRIBUTING.md](CONTRIBUTING.md) and [SECURITY.md](SECURITY.md) before opening issues or pull requests.
|
||||
|
||||
---
|
||||
|
||||
## Star History
|
||||
|
||||
<a href="https://www.star-history.com/?repos=truewhile%2FMeBox&type=date&legend=top-left">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/chart?repos=truewhile/MeBox&type=date&theme=dark&legend=top-left" />
|
||||
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/chart?repos=truewhile/MeBox&type=date&legend=top-left" />
|
||||
<img alt="Star History Chart" src="https://api.star-history.com/chart?repos=truewhile/MeBox&type=date&legend=top-left" />
|
||||
</picture>
|
||||
</a>
|
||||
|
||||
---
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under [GPL-3.0](LICENSE).
|
||||
|
||||
---
|
||||
|
||||
## Support & Donate
|
||||
|
||||
If MeBox makes your home theater life easier, feel free to buy the maintainer a coffee ☕
|
||||
|
||||
<p align="center">
|
||||
<img src="docs/images/donation-qr.png" width="320" alt="WhileTrue donation QR" />
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<strong>Telegram group</strong>: <a href="https://t.me/MeBoxGroup">https://t.me/MeBoxGroup</a><br/>
|
||||
Questions, feature requests, and release news — come chat with us
|
||||
</p>
|
||||
-83
@@ -1,83 +0,0 @@
|
||||
# 安全策略
|
||||
|
||||
MeBox 是自托管媒体系统,常部署在 NAS、家庭网络、Docker、反向代理和第三方下载器环境中。安全问题通常会同时涉及应用代码、容器配置、路径映射、站点 Cookie / API Key、下载器凭据和外部访问入口。请按本策略报告和处理安全问题。
|
||||
|
||||
## 支持范围
|
||||
|
||||
我们优先支持以下版本和部署方式的安全修复:
|
||||
|
||||
- 当前 `main` 分支。
|
||||
- 最新发布镜像:`ghcr.io/truewhile/mebox:latest`。
|
||||
- README 中推荐的 Docker Compose 第一档、第二档、第三档部署方式。
|
||||
|
||||
历史版本、私有魔改镜像、未公开补丁分支和非标准部署仍可报告,但维护者可能要求先在最新 `main` 或最新镜像中复现。
|
||||
|
||||
## 如何报告安全漏洞
|
||||
|
||||
请不要在公开 Issue、PR、讨论区或群聊中披露可利用细节。优先使用 GitHub Security Advisory 私密报告:
|
||||
|
||||
<https://github.com/truewhile/MeBox/security/advisories/new>
|
||||
|
||||
如果无法使用 GitHub 私密报告,可以先通过项目 README 中的社区入口联系维护者,说明“需要私下报告安全问题”,不要直接贴出利用细节、密钥或完整日志。
|
||||
|
||||
报告时请尽量提供:
|
||||
|
||||
- 影响范围:认证绕过、权限提升、敏感信息泄露、任意文件读写、命令执行、SSRF、路径穿越、下载器凭据泄露等。
|
||||
- 复现环境:部署方式、镜像版本或 commit、NAS / 系统、Docker / Compose 版本、是否有反向代理。
|
||||
- 复现步骤:最小可复现路径、请求、页面操作或配置条件。
|
||||
- 影响证明:截图、脱敏日志、请求响应、数据库字段名等。
|
||||
- 缓解建议:如果你已经验证过可行修复或临时规避方式,请一并说明。
|
||||
|
||||
请务必脱敏:
|
||||
|
||||
- 站点 Cookie、Passkey、API Key、YemaPT Auth Key、M-Team API Key。
|
||||
- qBittorrent / Transmission / Aria2 用户名密码。
|
||||
- Telegram Bot Token、JWT、数据库密码、反代访问 Token。
|
||||
- 私有下载链接、媒体库真实敏感路径、用户个人信息。
|
||||
|
||||
## 响应流程
|
||||
|
||||
维护者会尽力按以下节奏处理:
|
||||
|
||||
- 3 个工作日内确认收到报告。
|
||||
- 7 个工作日内给出初步影响判断、复现状态或需要补充的信息。
|
||||
- 高危问题优先修复,并在可行时提供临时缓解建议。
|
||||
- 修复发布后,再公开披露必要信息;公开内容会避免包含可直接滥用的细节。
|
||||
|
||||
如果问题需要更长时间修复,例如涉及数据迁移、权限模型、第三方站点 API 或下载器协议,我们会在私密报告中同步进展。
|
||||
|
||||
## 安全问题范围
|
||||
|
||||
欢迎报告:
|
||||
|
||||
- 未授权访问管理接口、媒体库、下载任务、站点配置或用户数据。
|
||||
- 普通用户越权执行管理员操作。
|
||||
- 读取或写入容器可访问范围外的文件。
|
||||
- 通过路径映射、整理入库、STRM、图片代理、字幕、备份恢复等功能触发路径穿越。
|
||||
- 泄露 Cookie、API Key、下载器密码、Telegram Token、JWT 或数据库凭据。
|
||||
- SSRF、任意重定向、反代信任边界错误。
|
||||
- Docker Compose 示例中可能导致默认暴露敏感服务的问题。
|
||||
- 日志中输出敏感信息或无法脱敏的问题。
|
||||
|
||||
通常不按安全漏洞处理:
|
||||
|
||||
- 需要管理员主动填写恶意配置才能触发、且不会突破管理员已有权限的问题。
|
||||
- 只影响个人私有魔改版、无法在最新主分支复现的问题。
|
||||
- 已经失效的依赖告警,且没有可达利用路径。
|
||||
- 没有安全影响的 UI 显示问题、普通功能 Bug 或性能问题。
|
||||
|
||||
## 自托管安全基线
|
||||
|
||||
部署 MeBox 时建议:
|
||||
|
||||
- 首次登录后立即修改默认 `admin / admin123`。
|
||||
- 不要把 PostgreSQL、Redis、OpenSearch、qBittorrent WebUI 暴露到公网。
|
||||
- 反向代理公网访问时启用 HTTPS,并限制管理后台访问来源。
|
||||
- 使用强随机的 JWT / 加密密钥,妥善备份 `./data` 和数据库。
|
||||
- 不要在 Issue、PR、截图或日志中公开站点 Cookie、API Key、Passkey、下载器密码。
|
||||
- Docker `volumes` 只挂载 MeBox 需要访问的目录,媒体库目录需要写入时再授予写权限。
|
||||
- 定期更新镜像,并在升级前备份 `./postgres` 和 `./data`。
|
||||
|
||||
## 安全修复 PR
|
||||
|
||||
安全修复 PR 请遵循 [贡献规范](CONTRIBUTING.md),但不要在公开 PR 中暴露可利用细节。必要时先通过私密安全报告确认修复方案,再提交脱敏后的补丁。
|
||||
@@ -1,206 +0,0 @@
|
||||
// reader-smoke 是阅读书源兼容性冒烟工具:
|
||||
// 对批量书源逐个跑「搜索 → 详情 → 目录 → 正文」全链路,输出兼容率报告。
|
||||
//
|
||||
// 用法:
|
||||
//
|
||||
// go run ./cmd/reader-smoke -file sources.json -key 斗破苍穹 -c 8
|
||||
// go run ./cmd/reader-smoke -url https://example.com/sources.json -json > report.json
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"flag"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
"go.uber.org/zap"
|
||||
|
||||
"github.com/truewhile/MeBox/internal/config"
|
||||
"github.com/truewhile/MeBox/internal/helper"
|
||||
"github.com/truewhile/MeBox/internal/repository"
|
||||
"github.com/truewhile/MeBox/internal/service/reader"
|
||||
)
|
||||
|
||||
func main() {
|
||||
file := flag.String("file", "", "书源文件路径(JSON 数组/对象/Base64/每行一个)")
|
||||
urlFlag := flag.String("url", "", "书源网络地址(与 -file 二选一)")
|
||||
key := flag.String("key", "斗破苍穹", "搜索关键词")
|
||||
concurrency := flag.Int("c", 4, "并发数")
|
||||
timeout := flag.Int("timeout", 90, "单源全链路超时(秒)")
|
||||
jsonOut := flag.Bool("json", false, "输出完整 JSON 报告(追加在汇总后)")
|
||||
flag.Parse()
|
||||
|
||||
payload := ""
|
||||
switch {
|
||||
case *file != "":
|
||||
data, err := os.ReadFile(*file)
|
||||
if err != nil {
|
||||
fatal("读取文件失败: %v", err)
|
||||
}
|
||||
payload = string(data)
|
||||
case *urlFlag != "":
|
||||
client := helper.NewSiteHTTPClient(30, true)
|
||||
req, err := http.NewRequest("GET", *urlFlag, nil)
|
||||
if err != nil {
|
||||
fatal("构造请求失败: %v", err)
|
||||
}
|
||||
for k, v := range helper.HTTPHeaderPresets() {
|
||||
req.Header.Set(k, v)
|
||||
}
|
||||
resp, err := client.Do(req)
|
||||
if err != nil {
|
||||
fatal("拉取书源失败: %v", err)
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
var sb strings.Builder
|
||||
buf := make([]byte, 32*1024)
|
||||
for {
|
||||
n, err := resp.Body.Read(buf)
|
||||
sb.Write(buf[:n])
|
||||
if err != nil {
|
||||
break
|
||||
}
|
||||
}
|
||||
payload = sb.String()
|
||||
default:
|
||||
fatal("需要 -file 或 -url 指定书源来源")
|
||||
}
|
||||
|
||||
sources := reader.ParseSourcePayload(payload)
|
||||
if len(sources) == 0 {
|
||||
fatal("未从输入中识别到书源")
|
||||
}
|
||||
|
||||
// 书源文件缓存根目录:java.downloadFile / cacheFile 需要它才能落盘,
|
||||
// 否则「拷贝轻小说」这类把整卷文本缓存到本地再读的源会被判为不支持。
|
||||
// 用固定子目录而不是每次 MkdirTemp,避免反复运行在临时目录里留一堆垃圾。
|
||||
cfg := &config.Config{}
|
||||
cacheDir := filepath.Join(os.TempDir(), "reader-smoke-cache")
|
||||
if err := os.MkdirAll(cacheDir, 0o750); err == nil {
|
||||
cfg.Cache.CacheDir = cacheDir
|
||||
}
|
||||
svc := reader.NewReaderService(cfg, zap.NewNop(), &repository.Container{})
|
||||
ctx := context.Background()
|
||||
|
||||
results := make([]*reader.SmokeChainResult, len(sources))
|
||||
sem := make(chan struct{}, max(1, *concurrency))
|
||||
var wg sync.WaitGroup
|
||||
for i, raw := range sources {
|
||||
wg.Add(1)
|
||||
sem <- struct{}{}
|
||||
go func(i int, raw string) {
|
||||
defer wg.Done()
|
||||
defer func() { <-sem }()
|
||||
ctxSrc, cancel := context.WithTimeout(ctx, time.Duration(*timeout)*time.Second)
|
||||
defer cancel()
|
||||
res := svc.SmokeSource(ctxSrc, raw, *key)
|
||||
results[i] = res
|
||||
status := "✓"
|
||||
if !res.OK {
|
||||
status = "✗"
|
||||
}
|
||||
fmt.Fprintf(os.Stderr, "%s %-24s [%s] hits=%d chapters=%d content=%d %s\n",
|
||||
status, truncate(res.SourceName, 24), stageCN(res), res.SearchHits, res.Chapters, res.ContentLen, res.Error)
|
||||
}(i, raw)
|
||||
}
|
||||
wg.Wait()
|
||||
|
||||
// 汇总
|
||||
var searchOK, infoOK, tocOK, contentOK, allOK int
|
||||
failedAt := map[string]int{}
|
||||
for _, r := range results {
|
||||
if r == nil {
|
||||
continue
|
||||
}
|
||||
switch r.FailedAt {
|
||||
case "":
|
||||
allOK++
|
||||
searchOK++
|
||||
infoOK++
|
||||
tocOK++
|
||||
contentOK++
|
||||
case "search":
|
||||
failedAt["search"]++
|
||||
case "info":
|
||||
searchOK++
|
||||
failedAt["info"]++
|
||||
case "toc":
|
||||
searchOK++
|
||||
infoOK++
|
||||
failedAt["toc"]++
|
||||
case "content":
|
||||
searchOK++
|
||||
infoOK++
|
||||
tocOK++
|
||||
failedAt["content"]++
|
||||
}
|
||||
}
|
||||
n := len(results)
|
||||
pct := func(v int) string {
|
||||
if n == 0 {
|
||||
return "0%"
|
||||
}
|
||||
return fmt.Sprintf("%.1f%%", float64(v)/float64(n)*100)
|
||||
}
|
||||
fmt.Printf("\n==== 冒烟报告 ====\n")
|
||||
fmt.Printf("书源总数: %d 关键词: %s\n", n, *key)
|
||||
fmt.Printf("搜索通过: %d (%s)\n", searchOK, pct(searchOK))
|
||||
fmt.Printf("详情通过: %d (%s)\n", infoOK, pct(infoOK))
|
||||
fmt.Printf("目录通过: %d (%s)\n", tocOK, pct(tocOK))
|
||||
fmt.Printf("正文通过: %d (%s)\n", contentOK, pct(contentOK))
|
||||
fmt.Printf("全链路通过: %d (%s)\n", allOK, pct(allOK))
|
||||
for _, stage := range []string{"search", "info", "toc", "content"} {
|
||||
if failedAt[stage] > 0 {
|
||||
fmt.Printf(" 失败于 %s: %d\n", stageCN(&reader.SmokeChainResult{FailedAt: stage}), failedAt[stage])
|
||||
}
|
||||
}
|
||||
|
||||
if *jsonOut {
|
||||
out, err := json.MarshalIndent(results, "", " ")
|
||||
if err != nil {
|
||||
fatal("序列化报告失败: %v", err)
|
||||
}
|
||||
fmt.Println(string(out))
|
||||
}
|
||||
}
|
||||
|
||||
func stageCN(r *reader.SmokeChainResult) string {
|
||||
switch r.FailedAt {
|
||||
case "":
|
||||
return "完成"
|
||||
case "search":
|
||||
return "搜索"
|
||||
case "info":
|
||||
return "详情"
|
||||
case "toc":
|
||||
return "目录"
|
||||
case "content":
|
||||
return "正文"
|
||||
case "parse":
|
||||
return "解析"
|
||||
default:
|
||||
return r.FailedAt
|
||||
}
|
||||
}
|
||||
|
||||
func truncate(s string, n int) string {
|
||||
rs := []rune(strings.TrimSpace(s))
|
||||
if len(rs) <= n {
|
||||
if len(rs) == 0 {
|
||||
return "(未命名)"
|
||||
}
|
||||
return string(rs)
|
||||
}
|
||||
return string(rs[:n]) + "…"
|
||||
}
|
||||
|
||||
func fatal(format string, args ...any) {
|
||||
fmt.Fprintf(os.Stderr, "reader-smoke: "+format+"\n", args...)
|
||||
os.Exit(1)
|
||||
}
|
||||
@@ -1,200 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
"go.uber.org/zap"
|
||||
|
||||
"github.com/truewhile/MeBox/internal/config"
|
||||
"github.com/truewhile/MeBox/internal/database"
|
||||
"github.com/truewhile/MeBox/internal/helper"
|
||||
"github.com/truewhile/MeBox/internal/repository"
|
||||
"github.com/truewhile/MeBox/internal/service"
|
||||
)
|
||||
|
||||
// application owns the long-running MeBox server and all resources created
|
||||
// during startup. Platform entry points decide how the application is
|
||||
// controlled: a console signal loop or a Windows notification-area icon.
|
||||
type application struct {
|
||||
cfg *config.Config
|
||||
logger *zap.Logger
|
||||
embyCompatLogger *zap.Logger
|
||||
serverManager *serverManager
|
||||
services *service.Container
|
||||
|
||||
closeMu sync.Mutex
|
||||
closeFuncs []func()
|
||||
shutdown sync.Once
|
||||
shutdownErr error
|
||||
}
|
||||
|
||||
func newApplication() (*application, error) {
|
||||
cfg, err := config.Load()
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("config load failed: %w", err)
|
||||
}
|
||||
|
||||
logger, closeLogger, err := newLoggerWithCloser(cfg)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("logger init failed: %w", err)
|
||||
}
|
||||
|
||||
app := &application{
|
||||
cfg: cfg,
|
||||
logger: logger,
|
||||
closeFuncs: []func(){closeLogger},
|
||||
}
|
||||
if err := app.start(); err != nil {
|
||||
app.closeLoggers()
|
||||
return nil, err
|
||||
}
|
||||
return app, nil
|
||||
}
|
||||
|
||||
func (a *application) start() error {
|
||||
embyCompatLogger, closeEmbyCompatLogger, err := newEmbyCompatLogger(a.cfg)
|
||||
if err != nil {
|
||||
a.logger.Error("Emby compatibility logger init failed", zap.Error(err))
|
||||
return fmt.Errorf("Emby compatibility logger init failed: %w", err)
|
||||
}
|
||||
a.embyCompatLogger = embyCompatLogger
|
||||
a.addCloser(closeEmbyCompatLogger)
|
||||
|
||||
appVersion := effectiveVersion(version)
|
||||
a.logger.Info("starting MeBox",
|
||||
zap.String("version", appVersion),
|
||||
zap.Int("port", a.cfg.App.Port),
|
||||
zap.String("data_dir", a.cfg.App.DataDir),
|
||||
zap.String("emby_compat_log", embyCompatLogPath(a.cfg)),
|
||||
)
|
||||
|
||||
for _, dir := range []string{a.cfg.App.DataDir, a.cfg.Cache.CacheDir} {
|
||||
if err := os.MkdirAll(dir, 0o750); err != nil {
|
||||
a.logger.Error("create dir failed", zap.String("dir", dir), zap.Error(err))
|
||||
return fmt.Errorf("create dir %s failed: %w", dir, err)
|
||||
}
|
||||
}
|
||||
|
||||
if err := database.ApplyPendingSQLiteRestore(context.Background(), a.cfg, a.logger); err != nil {
|
||||
return fmt.Errorf("apply pending database restore: %w", err)
|
||||
}
|
||||
db, err := database.Open(a.cfg, a.logger)
|
||||
if err != nil {
|
||||
a.logger.Error("database open failed", zap.Error(err))
|
||||
return fmt.Errorf("database open failed: %w", err)
|
||||
}
|
||||
if err := waitForDatabase(db, a.logger); err != nil {
|
||||
a.logger.Error("database not ready", zap.Error(err))
|
||||
return fmt.Errorf("database not ready: %w", err)
|
||||
}
|
||||
if err := database.AutoMigrateWithConfig(db, a.cfg, a.logger); err != nil {
|
||||
a.logger.Error("auto-migrate failed", zap.Error(err))
|
||||
return fmt.Errorf("auto-migrate failed: %w", err)
|
||||
}
|
||||
if err := database.MigrateSQLiteToCurrentIfNeeded(a.cfg, db, a.logger); err != nil {
|
||||
a.logger.Error("sqlite to postgres migration failed", zap.Error(err))
|
||||
return fmt.Errorf("sqlite to postgres migration failed: %w", err)
|
||||
}
|
||||
|
||||
repos := repository.New(db)
|
||||
service.ApplyRuntimeSettings(context.Background(), a.cfg, repos, a.logger)
|
||||
applyCPUThreadLimit(a.cfg, a.logger)
|
||||
a.services = service.NewWithVersion(a.cfg, a.logger, repos, appVersion)
|
||||
|
||||
// 一次性清洗历史脏数据: 老版本把单集 episode id / 单集名写进整剧字段, 导致
|
||||
// 同一部剧被拆成多张单集卡。清空被污染的字段并重置为 pending(借后续重刮修正)。
|
||||
if cleaned, err := a.services.NormalizePollutedEpisodeMetadata(context.Background()); err != nil {
|
||||
a.logger.Warn("polluted episode metadata cleanup failed", zap.Error(err))
|
||||
} else if cleaned > 0 {
|
||||
a.logger.Info("polluted episode metadata cleanup completed", zap.Int("media_count", cleaned))
|
||||
}
|
||||
|
||||
if err := a.services.Auth.SeedAdmin(context.Background()); err != nil {
|
||||
a.logger.Warn("seed admin failed", zap.Error(err))
|
||||
}
|
||||
|
||||
router := buildRouter(a.cfg, a.logger, a.embyCompatLogger, a.services)
|
||||
a.serverManager = newServerManager(a.cfg, a.logger, router)
|
||||
a.services.ReloadHTTPServer = a.serverManager.Reload
|
||||
if err := a.serverManager.Start(); err != nil {
|
||||
a.logger.Error("listen failed", zap.Error(err))
|
||||
return fmt.Errorf("listen failed: %w", err)
|
||||
}
|
||||
|
||||
go func() {
|
||||
scheme := "http"
|
||||
if a.cfg.App.HTTPSEnabled {
|
||||
scheme = "https"
|
||||
}
|
||||
if publicIP := getPublicIP(3 * time.Second); publicIP != "" {
|
||||
a.logger.Info("server public endpoint",
|
||||
zap.String("public", fmt.Sprintf("%s://%s:%d", scheme, publicIP, a.cfg.App.Port)),
|
||||
)
|
||||
}
|
||||
}()
|
||||
helper.Go(a.logger, "services.boot", a.services.Boot)
|
||||
return nil
|
||||
}
|
||||
|
||||
// Shutdown is idempotent and safe to call from both the tray handler and the
|
||||
// systray exit callback.
|
||||
func (a *application) Shutdown() error {
|
||||
a.shutdown.Do(func() {
|
||||
a.logger.Info("shutdown requested")
|
||||
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 15*time.Second)
|
||||
if a.serverManager != nil {
|
||||
if err := a.serverManager.Shutdown(ctx); err != nil {
|
||||
a.shutdownErr = err
|
||||
a.logger.Error("graceful shutdown failed", zap.Error(err))
|
||||
}
|
||||
}
|
||||
cancel()
|
||||
|
||||
if a.services != nil {
|
||||
a.services.Close()
|
||||
}
|
||||
a.logger.Info("MeBox stopped")
|
||||
_ = a.logger.Sync()
|
||||
if a.embyCompatLogger != nil {
|
||||
_ = a.embyCompatLogger.Sync()
|
||||
}
|
||||
a.closeLoggers()
|
||||
})
|
||||
return a.shutdownErr
|
||||
}
|
||||
|
||||
func (a *application) addCloser(fn func()) {
|
||||
if fn == nil {
|
||||
return
|
||||
}
|
||||
a.closeMu.Lock()
|
||||
a.closeFuncs = append(a.closeFuncs, fn)
|
||||
a.closeMu.Unlock()
|
||||
}
|
||||
|
||||
func (a *application) closeLoggers() {
|
||||
a.closeMu.Lock()
|
||||
closers := append([]func(){}, a.closeFuncs...)
|
||||
a.closeFuncs = nil
|
||||
a.closeMu.Unlock()
|
||||
|
||||
for i := len(closers) - 1; i >= 0; i-- {
|
||||
closers[i]()
|
||||
}
|
||||
}
|
||||
|
||||
func (a *application) localURL() string {
|
||||
config.RuntimeMu.RLock()
|
||||
scheme := "http"
|
||||
if a.cfg.App.HTTPSEnabled {
|
||||
scheme = "https"
|
||||
}
|
||||
port := a.cfg.App.Port
|
||||
config.RuntimeMu.RUnlock()
|
||||
return fmt.Sprintf("%s://127.0.0.1:%d", scheme, port)
|
||||
}
|
||||
@@ -1,140 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
"github.com/truewhile/MeBox/internal/config"
|
||||
)
|
||||
|
||||
const defaultLogMaxSizeMB = 20
|
||||
|
||||
type rotatingFileWriter struct {
|
||||
mu sync.Mutex
|
||||
path string
|
||||
maxSize int64
|
||||
maxBackups int
|
||||
maxAge time.Duration
|
||||
file *os.File
|
||||
size int64
|
||||
}
|
||||
|
||||
func newRotatingFileWriter(path string, cfg config.LoggingConfig) (*rotatingFileWriter, error) {
|
||||
if path == "" {
|
||||
return nil, fmt.Errorf("log path required")
|
||||
}
|
||||
if err := os.MkdirAll(filepath.Dir(path), 0o750); err != nil {
|
||||
return nil, fmt.Errorf("create log dir: %w", err)
|
||||
}
|
||||
maxSizeMB := cfg.MaxSizeMB
|
||||
if maxSizeMB <= 0 {
|
||||
maxSizeMB = defaultLogMaxSizeMB
|
||||
}
|
||||
w := &rotatingFileWriter{
|
||||
path: path,
|
||||
maxBackups: cfg.MaxBackups,
|
||||
}
|
||||
if cfg.EnableRotation {
|
||||
w.maxSize = int64(maxSizeMB) * 1024 * 1024
|
||||
}
|
||||
if w.maxBackups < 0 {
|
||||
w.maxBackups = 0
|
||||
}
|
||||
if cfg.MaxAgeDays > 0 {
|
||||
w.maxAge = time.Duration(cfg.MaxAgeDays) * 24 * time.Hour
|
||||
}
|
||||
if err := w.open(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return w, nil
|
||||
}
|
||||
|
||||
func (w *rotatingFileWriter) Write(p []byte) (int, error) {
|
||||
w.mu.Lock()
|
||||
defer w.mu.Unlock()
|
||||
if w.file == nil {
|
||||
if err := w.open(); err != nil {
|
||||
return 0, err
|
||||
}
|
||||
}
|
||||
if w.maxSize > 0 && w.size > 0 && w.size+int64(len(p)) > w.maxSize {
|
||||
if err := w.rotate(); err != nil {
|
||||
return 0, err
|
||||
}
|
||||
}
|
||||
n, err := w.file.Write(p)
|
||||
w.size += int64(n)
|
||||
return n, err
|
||||
}
|
||||
|
||||
func (w *rotatingFileWriter) Sync() error {
|
||||
w.mu.Lock()
|
||||
defer w.mu.Unlock()
|
||||
if w.file == nil {
|
||||
return nil
|
||||
}
|
||||
return w.file.Sync()
|
||||
}
|
||||
|
||||
func (w *rotatingFileWriter) Close() error {
|
||||
w.mu.Lock()
|
||||
defer w.mu.Unlock()
|
||||
if w.file == nil {
|
||||
return nil
|
||||
}
|
||||
err := w.file.Close()
|
||||
w.file = nil
|
||||
w.size = 0
|
||||
return err
|
||||
}
|
||||
|
||||
func (w *rotatingFileWriter) open() error {
|
||||
file, err := os.OpenFile(w.path, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0o640)
|
||||
if err != nil {
|
||||
return fmt.Errorf("open log file %s: %w", w.path, err)
|
||||
}
|
||||
w.file = file
|
||||
if stat, err := file.Stat(); err == nil {
|
||||
w.size = stat.Size()
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (w *rotatingFileWriter) rotate() error {
|
||||
if w.file != nil {
|
||||
_ = w.file.Close()
|
||||
w.file = nil
|
||||
}
|
||||
if w.maxBackups == 0 {
|
||||
_ = os.Remove(w.path)
|
||||
return w.open()
|
||||
}
|
||||
for i := w.maxBackups - 1; i >= 1; i-- {
|
||||
oldPath := fmt.Sprintf("%s.%d", w.path, i)
|
||||
newPath := fmt.Sprintf("%s.%d", w.path, i+1)
|
||||
if _, err := os.Stat(oldPath); err == nil {
|
||||
_ = os.Rename(oldPath, newPath)
|
||||
}
|
||||
}
|
||||
if _, err := os.Stat(w.path); err == nil {
|
||||
_ = os.Rename(w.path, fmt.Sprintf("%s.1", w.path))
|
||||
}
|
||||
w.pruneByAge()
|
||||
return w.open()
|
||||
}
|
||||
|
||||
func (w *rotatingFileWriter) pruneByAge() {
|
||||
if w.maxAge <= 0 {
|
||||
return
|
||||
}
|
||||
cutoff := time.Now().Add(-w.maxAge)
|
||||
for i := 1; i <= w.maxBackups; i++ {
|
||||
path := fmt.Sprintf("%s.%d", w.path, i)
|
||||
if stat, err := os.Stat(path); err == nil && stat.ModTime().Before(cutoff) {
|
||||
_ = os.Remove(path)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,138 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
|
||||
"go.uber.org/zap"
|
||||
"go.uber.org/zap/zapcore"
|
||||
|
||||
"github.com/truewhile/MeBox/internal/config"
|
||||
)
|
||||
|
||||
// newLogger 根据 cfg.Logging 构建 Zap。
|
||||
func newLogger(cfg *config.Config) (*zap.Logger, error) {
|
||||
log, _, err := newLoggerWithCloser(cfg)
|
||||
return log, err
|
||||
}
|
||||
|
||||
func newLoggerWithCloser(cfg *config.Config) (*zap.Logger, func(), error) {
|
||||
if cfg.App.Debug {
|
||||
log, err := zap.NewDevelopment()
|
||||
return log, func() {}, err
|
||||
}
|
||||
level := configuredLogLevel(cfg.Logging.Level)
|
||||
encoderCfg := zap.NewProductionEncoderConfig()
|
||||
encoderCfg.EncodeTime = zapcore.ISO8601TimeEncoder
|
||||
var encoder zapcore.Encoder
|
||||
if strings.EqualFold(strings.TrimSpace(cfg.Logging.Format), "console") {
|
||||
encoder = zapcore.NewConsoleEncoder(encoderCfg)
|
||||
} else {
|
||||
encoder = zapcore.NewJSONEncoder(encoderCfg)
|
||||
}
|
||||
cores := []zapcore.Core{
|
||||
zapcore.NewCore(encoder, zapcore.Lock(os.Stdout), level),
|
||||
}
|
||||
var closers []func() error
|
||||
appPath, warnPath, errorPath := logFilePaths(cfg)
|
||||
if appPath != "" {
|
||||
appWriter, err := newRotatingFileWriter(appPath, cfg.Logging)
|
||||
if err != nil {
|
||||
return nil, nil, err
|
||||
}
|
||||
cores = append(cores, zapcore.NewCore(encoder, appWriter, level))
|
||||
closers = append(closers, appWriter.Close)
|
||||
}
|
||||
if warnPath != "" {
|
||||
warnWriter, err := newRotatingFileWriter(warnPath, cfg.Logging)
|
||||
if err != nil {
|
||||
return nil, nil, err
|
||||
}
|
||||
cores = append(cores, zapcore.NewCore(encoder, warnWriter, zap.LevelEnablerFunc(func(lvl zapcore.Level) bool {
|
||||
return lvl == zapcore.WarnLevel && level.Enabled(lvl)
|
||||
})))
|
||||
closers = append(closers, warnWriter.Close)
|
||||
}
|
||||
if errorPath != "" {
|
||||
errorWriter, err := newRotatingFileWriter(errorPath, cfg.Logging)
|
||||
if err != nil {
|
||||
return nil, nil, err
|
||||
}
|
||||
cores = append(cores, zapcore.NewCore(encoder, errorWriter, zap.LevelEnablerFunc(func(lvl zapcore.Level) bool {
|
||||
return lvl >= zapcore.ErrorLevel && level.Enabled(lvl)
|
||||
})))
|
||||
closers = append(closers, errorWriter.Close)
|
||||
}
|
||||
closeFn := func() {
|
||||
for _, c := range closers {
|
||||
_ = c()
|
||||
}
|
||||
}
|
||||
return zap.New(zapcore.NewTee(cores...), zap.AddCaller(), zap.AddStacktrace(zapcore.ErrorLevel), zap.ErrorOutput(zapcore.Lock(os.Stderr))), closeFn, nil
|
||||
}
|
||||
|
||||
func configuredLogLevel(raw string) zapcore.Level {
|
||||
level := zapcore.WarnLevel
|
||||
raw = strings.TrimSpace(raw)
|
||||
if raw != "" {
|
||||
var parsed zapcore.Level
|
||||
if err := parsed.UnmarshalText([]byte(raw)); err == nil {
|
||||
level = parsed
|
||||
}
|
||||
}
|
||||
return level
|
||||
}
|
||||
|
||||
func logFilePaths(cfg *config.Config) (string, string, string) {
|
||||
out := strings.TrimSpace(cfg.Logging.OutputPath)
|
||||
if strings.EqualFold(out, "stdout") || strings.EqualFold(out, "stderr") {
|
||||
return "", "", ""
|
||||
}
|
||||
if out == "" {
|
||||
out = filepath.Join(cfg.App.DataDir, "logs")
|
||||
}
|
||||
if ext := filepath.Ext(out); ext != "" {
|
||||
base := strings.TrimSuffix(out, ext)
|
||||
return out, base + ".warn" + ext, base + ".error" + ext
|
||||
}
|
||||
return filepath.Join(out, "app.log"), filepath.Join(out, "warn.log"), filepath.Join(out, "error.log")
|
||||
}
|
||||
|
||||
// newEmbyCompatLogger 构建只写入 Emby 兼容日志文件的独立 Zap 实例。
|
||||
// 它不参与 app.log 的日志级别过滤,始终记录 INFO 及以上,确保成功请求也能
|
||||
// 用于还原客户端的接口调用顺序;轮转参数沿用 logging 配置。
|
||||
func newEmbyCompatLogger(cfg *config.Config) (*zap.Logger, func(), error) {
|
||||
encoderCfg := zap.NewProductionEncoderConfig()
|
||||
encoderCfg.EncodeTime = zapcore.ISO8601TimeEncoder
|
||||
var encoder zapcore.Encoder
|
||||
if strings.EqualFold(strings.TrimSpace(cfg.Logging.Format), "console") {
|
||||
encoder = zapcore.NewConsoleEncoder(encoderCfg)
|
||||
} else {
|
||||
encoder = zapcore.NewJSONEncoder(encoderCfg)
|
||||
}
|
||||
|
||||
writer, err := newRotatingFileWriter(embyCompatLogPath(cfg), cfg.Logging)
|
||||
if err != nil {
|
||||
return nil, nil, err
|
||||
}
|
||||
log := zap.New(
|
||||
zapcore.NewCore(encoder, writer, zap.InfoLevel),
|
||||
zap.AddCaller(),
|
||||
zap.AddStacktrace(zapcore.ErrorLevel),
|
||||
zap.ErrorOutput(zapcore.Lock(os.Stderr)),
|
||||
)
|
||||
return log, func() { _ = writer.Close() }, nil
|
||||
}
|
||||
|
||||
func embyCompatLogPath(cfg *config.Config) string {
|
||||
out := strings.TrimSpace(cfg.Logging.OutputPath)
|
||||
if out == "" || strings.EqualFold(out, "stdout") || strings.EqualFold(out, "stderr") {
|
||||
return filepath.Join(cfg.App.DataDir, "logs", "emby-compat.log")
|
||||
}
|
||||
if ext := filepath.Ext(out); ext != "" {
|
||||
base := strings.TrimSuffix(out, ext)
|
||||
return base + ".emby-compat" + ext
|
||||
}
|
||||
return filepath.Join(out, "emby-compat.log")
|
||||
}
|
||||
@@ -1,149 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"go.uber.org/zap"
|
||||
|
||||
"github.com/truewhile/MeBox/internal/config"
|
||||
)
|
||||
|
||||
func TestProductionLoggerWritesConfiguredInfoToAppLogAndSplitsWarnError(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
cfg := &config.Config{}
|
||||
cfg.App.DataDir = dir
|
||||
cfg.Logging.Level = "info"
|
||||
cfg.Logging.Format = "json"
|
||||
cfg.Logging.OutputPath = filepath.Join(dir, "logs")
|
||||
cfg.Logging.EnableRotation = true
|
||||
cfg.Logging.MaxSizeMB = 1
|
||||
cfg.Logging.MaxBackups = 2
|
||||
|
||||
log, closeFn, err := newLoggerWithCloser(cfg)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer closeFn()
|
||||
log.Info("info should be stored")
|
||||
log.Warn("warning only", zap.String("kind", "warn"))
|
||||
log.Error("error only", zap.String("kind", "error"))
|
||||
_ = log.Sync()
|
||||
|
||||
appBytes, err := os.ReadFile(filepath.Join(dir, "logs", "app.log"))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
warnBytes, err := os.ReadFile(filepath.Join(dir, "logs", "warn.log"))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
errorBytes, err := os.ReadFile(filepath.Join(dir, "logs", "error.log"))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
appLog := string(appBytes)
|
||||
warnLog := string(warnBytes)
|
||||
errorLog := string(errorBytes)
|
||||
if !strings.Contains(appLog, "info should be stored") ||
|
||||
!strings.Contains(appLog, "warning only") ||
|
||||
!strings.Contains(appLog, "error only") {
|
||||
t.Fatalf("app log should contain all enabled levels: %s", appLog)
|
||||
}
|
||||
if strings.Contains(warnLog, "info should be stored") || strings.Contains(errorLog, "info should be stored") {
|
||||
t.Fatal("split warn/error logs should not contain info")
|
||||
}
|
||||
if !strings.Contains(warnLog, "warning only") || strings.Contains(warnLog, "error only") {
|
||||
t.Fatalf("warn log not isolated: %s", warnLog)
|
||||
}
|
||||
if !strings.Contains(errorLog, "error only") || strings.Contains(errorLog, "warning only") {
|
||||
t.Fatalf("error log not isolated: %s", errorLog)
|
||||
}
|
||||
}
|
||||
|
||||
func TestProductionLoggerDefaultsToWarnInAppLog(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
cfg := &config.Config{}
|
||||
cfg.App.DataDir = dir
|
||||
cfg.Logging.Format = "json"
|
||||
cfg.Logging.OutputPath = filepath.Join(dir, "logs")
|
||||
cfg.Logging.EnableRotation = true
|
||||
|
||||
log, closeFn, err := newLoggerWithCloser(cfg)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer closeFn()
|
||||
log.Info("info should stay quiet by default")
|
||||
log.Warn("warning should be stored")
|
||||
_ = log.Sync()
|
||||
|
||||
appBytes, err := os.ReadFile(filepath.Join(dir, "logs", "app.log"))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
appLog := string(appBytes)
|
||||
if strings.Contains(appLog, "info should stay quiet by default") {
|
||||
t.Fatalf("default logger should not store info: %s", appLog)
|
||||
}
|
||||
if !strings.Contains(appLog, "warning should be stored") {
|
||||
t.Fatalf("default logger should store warn: %s", appLog)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRotatingFileWriterCapsFileSize(t *testing.T) {
|
||||
path := filepath.Join(t.TempDir(), "app.log")
|
||||
writer, err := newRotatingFileWriter(path, config.LoggingConfig{
|
||||
EnableRotation: true,
|
||||
MaxSizeMB: 1,
|
||||
MaxBackups: 2,
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer writer.Close()
|
||||
chunk := strings.Repeat("x", 700*1024)
|
||||
if _, err := writer.Write([]byte(chunk)); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if _, err := writer.Write([]byte(chunk)); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if _, err := os.Stat(path + ".1"); err != nil {
|
||||
t.Fatalf("expected rotated backup: %v", err)
|
||||
}
|
||||
_ = writer.Sync()
|
||||
}
|
||||
|
||||
func TestEmbyCompatLoggerWritesDedicatedFile(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
cfg := &config.Config{}
|
||||
cfg.App.DataDir = dir
|
||||
cfg.Logging.Format = "json"
|
||||
cfg.Logging.OutputPath = filepath.Join(dir, "logs")
|
||||
cfg.Logging.EnableRotation = true
|
||||
cfg.Logging.MaxSizeMB = 1
|
||||
cfg.Logging.MaxBackups = 2
|
||||
|
||||
log, closeFn, err := newEmbyCompatLogger(cfg)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
log.Info("emby request", zap.String("client", "Infuse"))
|
||||
_ = log.Sync()
|
||||
closeFn()
|
||||
|
||||
path := filepath.Join(dir, "logs", "emby-compat.log")
|
||||
data, err := os.ReadFile(path)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if !strings.Contains(string(data), "emby request") || !strings.Contains(string(data), "Infuse") {
|
||||
t.Fatalf("dedicated Emby log missing request data: %s", data)
|
||||
}
|
||||
if _, err := os.Stat(filepath.Join(dir, "logs", "app.log")); !os.IsNotExist(err) {
|
||||
t.Fatalf("Emby logger must not write app.log, stat err=%v", err)
|
||||
}
|
||||
}
|
||||
@@ -1,37 +0,0 @@
|
||||
// Package main is the MeBox HTTP server entry point.
|
||||
//
|
||||
// MeBox is a Go rewrite of the legacy Python implementation,
|
||||
// adopting the same tech stack as cropflre/nowen-video:
|
||||
//
|
||||
// Backend: Go 1.25 + Gin + GORM + PostgreSQL/SQLite + Viper + Zap + JWT
|
||||
// Frontend: React 18 + Vite + Tailwind + Zustand + HLS.js
|
||||
//
|
||||
// The binary embeds the SPA build artifacts at /app/web/dist and serves them
|
||||
// alongside the JSON REST API at /api/* and the WebSocket hub at /api/ws.
|
||||
package main
|
||||
|
||||
import (
|
||||
"os"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// version is overwritten at build time via -ldflags="-X main.version=...".
|
||||
var version = "dev"
|
||||
|
||||
func effectiveVersion(buildVersion string) string {
|
||||
buildVersion = strings.TrimSpace(buildVersion)
|
||||
if buildVersion != "" && buildVersion != "dev" {
|
||||
return buildVersion
|
||||
}
|
||||
if envVersion := strings.TrimSpace(os.Getenv("MEBOX_VERSION")); envVersion != "" {
|
||||
return envVersion
|
||||
}
|
||||
if buildVersion == "" {
|
||||
return "dev"
|
||||
}
|
||||
return buildVersion
|
||||
}
|
||||
|
||||
func main() {
|
||||
runProgram()
|
||||
}
|
||||
@@ -1,198 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/gin-gonic/gin"
|
||||
)
|
||||
|
||||
func TestEffectiveVersionPrefersBuildVersion(t *testing.T) {
|
||||
t.Setenv("MEBOX_VERSION", "MeBox-v0.1.15")
|
||||
|
||||
if got := effectiveVersion("MeBox-v0.1.16"); got != "MeBox-v0.1.16" {
|
||||
t.Fatalf("effectiveVersion = %q, want MeBox-v0.1.16", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestEffectiveVersionUsesEnvWhenBuildVersionIsDev(t *testing.T) {
|
||||
t.Setenv("MEBOX_VERSION", " MeBox-v0.1.16 ")
|
||||
|
||||
if got := effectiveVersion("dev"); got != "MeBox-v0.1.16" {
|
||||
t.Fatalf("effectiveVersion = %q, want MeBox-v0.1.16", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestEffectiveVersionDefaultsToDev(t *testing.T) {
|
||||
t.Setenv("MEBOX_VERSION", "")
|
||||
|
||||
if got := effectiveVersion(""); got != "dev" {
|
||||
t.Fatalf("effectiveVersion = %q, want dev", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestServeSPANoCachesIndexAndServesRoutes(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
webDir := t.TempDir()
|
||||
if err := os.MkdirAll(filepath.Join(webDir, "assets"), 0o755); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := os.WriteFile(filepath.Join(webDir, "index.html"), []byte("<html><div id=\"root\"></div></html>"), 0o644); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := os.WriteFile(filepath.Join(webDir, "assets", "app.js"), []byte("console.log('ok')"), 0o644); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := os.WriteFile(filepath.Join(webDir, "favicon.svg"), []byte("<svg></svg>"), 0o644); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
router := gin.New()
|
||||
serveSPA(router, os.DirFS(webDir))
|
||||
|
||||
for _, path := range []string{"/", "/login", "/library/e1c3507e-2878-40ae-a0e1-6b6e44b7fa7a", "/media/abc"} {
|
||||
req := httptest.NewRequest(http.MethodGet, path, nil)
|
||||
w := httptest.NewRecorder()
|
||||
router.ServeHTTP(w, req)
|
||||
if w.Code != http.StatusOK {
|
||||
t.Fatalf("%s status = %d, want 200", path, w.Code)
|
||||
}
|
||||
if got := w.Header().Get("Cache-Control"); !strings.Contains(got, "no-store") {
|
||||
t.Fatalf("%s Cache-Control = %q, want no-store", path, got)
|
||||
}
|
||||
if !strings.Contains(w.Body.String(), "root") {
|
||||
t.Fatalf("%s did not serve index.html: %q", path, w.Body.String())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestServeSPAServesAssetsImmutableAndBypassesAPIRoutes(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
webDir := t.TempDir()
|
||||
if err := os.MkdirAll(filepath.Join(webDir, "assets"), 0o755); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := os.MkdirAll(filepath.Join(webDir, "fonts"), 0o755); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := os.MkdirAll(filepath.Join(webDir, "brand"), 0o755); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := os.WriteFile(filepath.Join(webDir, "index.html"), []byte("index"), 0o644); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := os.WriteFile(filepath.Join(webDir, "assets", "app.js"), []byte("console.log('ok')"), 0o644); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := os.WriteFile(filepath.Join(webDir, "fonts", "geist-400.woff2"), []byte("wOF2-test-font"), 0o644); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := os.WriteFile(filepath.Join(webDir, "brand", "mebox-logo.svg"), []byte("<svg></svg>"), 0o644); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := os.WriteFile(filepath.Join(webDir, "artwork-cache-sw.js"), []byte("self.addEventListener('fetch', () => {})"), 0o644); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
router := gin.New()
|
||||
serveSPA(router, os.DirFS(webDir))
|
||||
|
||||
assetReq := httptest.NewRequest(http.MethodGet, "/assets/app.js", nil)
|
||||
assetResp := httptest.NewRecorder()
|
||||
router.ServeHTTP(assetResp, assetReq)
|
||||
if assetResp.Code != http.StatusOK {
|
||||
t.Fatalf("asset status = %d, want 200", assetResp.Code)
|
||||
}
|
||||
if got := assetResp.Header().Get("Cache-Control"); !strings.Contains(got, "immutable") {
|
||||
t.Fatalf("asset Cache-Control = %q, want immutable", got)
|
||||
}
|
||||
|
||||
fontReq := httptest.NewRequest(http.MethodGet, "/fonts/geist-400.woff2", nil)
|
||||
fontResp := httptest.NewRecorder()
|
||||
router.ServeHTTP(fontResp, fontReq)
|
||||
if fontResp.Code != http.StatusOK {
|
||||
t.Fatalf("font status = %d, want 200", fontResp.Code)
|
||||
}
|
||||
if got := fontResp.Header().Get("Cache-Control"); !strings.Contains(got, "max-age=86400") {
|
||||
t.Fatalf("font Cache-Control = %q, want max-age=86400", got)
|
||||
}
|
||||
if got := fontResp.Body.String(); got != "wOF2-test-font" {
|
||||
t.Fatalf("font body = %q, want wOF2-test-font", got)
|
||||
}
|
||||
|
||||
missingFontReq := httptest.NewRequest(http.MethodGet, "/fonts/missing.woff2", nil)
|
||||
missingFontResp := httptest.NewRecorder()
|
||||
router.ServeHTTP(missingFontResp, missingFontReq)
|
||||
if missingFontResp.Code != http.StatusNotFound {
|
||||
t.Fatalf("missing font status = %d, want 404", missingFontResp.Code)
|
||||
}
|
||||
if strings.Contains(missingFontResp.Body.String(), "index") {
|
||||
t.Fatalf("missing font should not serve SPA index: %q", missingFontResp.Body.String())
|
||||
}
|
||||
|
||||
brandReq := httptest.NewRequest(http.MethodGet, "/brand/mebox-logo.svg", nil)
|
||||
brandResp := httptest.NewRecorder()
|
||||
router.ServeHTTP(brandResp, brandReq)
|
||||
if brandResp.Code != http.StatusOK {
|
||||
t.Fatalf("brand asset status = %d, want 200", brandResp.Code)
|
||||
}
|
||||
if got := brandResp.Header().Get("Cache-Control"); !strings.Contains(got, "no-store") {
|
||||
t.Fatalf("brand asset Cache-Control = %q, want no-store", got)
|
||||
}
|
||||
if strings.Contains(brandResp.Body.String(), "index") {
|
||||
t.Fatalf("brand asset should not serve SPA index: %q", brandResp.Body.String())
|
||||
}
|
||||
|
||||
swReq := httptest.NewRequest(http.MethodGet, "/artwork-cache-sw.js", nil)
|
||||
swResp := httptest.NewRecorder()
|
||||
router.ServeHTTP(swResp, swReq)
|
||||
if swResp.Code != http.StatusOK {
|
||||
t.Fatalf("service worker status = %d, want 200", swResp.Code)
|
||||
}
|
||||
if got := swResp.Header().Get("Cache-Control"); !strings.Contains(got, "no-store") {
|
||||
t.Fatalf("service worker Cache-Control = %q, want no-store", got)
|
||||
}
|
||||
if strings.Contains(swResp.Body.String(), "index") {
|
||||
t.Fatalf("service worker should not serve SPA index: %q", swResp.Body.String())
|
||||
}
|
||||
|
||||
for _, path := range []string{
|
||||
"/api/missing",
|
||||
"/emby",
|
||||
"/emby/missing",
|
||||
"/Library/VirtualFolders",
|
||||
"/Startup/Configuration",
|
||||
"/QuickConnect/Enabled",
|
||||
"/embywebsocket",
|
||||
} {
|
||||
req := httptest.NewRequest(http.MethodGet, path, nil)
|
||||
resp := httptest.NewRecorder()
|
||||
router.ServeHTTP(resp, req)
|
||||
if resp.Code != http.StatusNotFound {
|
||||
t.Fatalf("%s fallback status = %d, want 404", path, resp.Code)
|
||||
}
|
||||
if strings.Contains(resp.Body.String(), "index") {
|
||||
t.Fatalf("%s should not serve SPA index: %q", path, resp.Body.String())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestServeSPAMissingIndexReportsExplicit404(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
router := gin.New()
|
||||
serveSPA(router, os.DirFS(t.TempDir()))
|
||||
|
||||
req := httptest.NewRequest(http.MethodGet, "/", nil)
|
||||
w := httptest.NewRecorder()
|
||||
router.ServeHTTP(w, req)
|
||||
if w.Code != http.StatusNotFound {
|
||||
t.Fatalf("status = %d, want 404", w.Code)
|
||||
}
|
||||
if !strings.Contains(w.Body.String(), "web UI not found") {
|
||||
t.Fatalf("body = %q, want explicit missing UI message", w.Body.String())
|
||||
}
|
||||
}
|
||||
@@ -1,55 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"io"
|
||||
"net"
|
||||
"net/http"
|
||||
"strings"
|
||||
"time"
|
||||
)
|
||||
|
||||
// getLocalIP returns the first non-loopback IPv4 address of the machine.
|
||||
// Falls back to "localhost" if no suitable interface is found.
|
||||
func getLocalIP() string {
|
||||
interfaces, err := net.Interfaces()
|
||||
if err != nil {
|
||||
return "localhost"
|
||||
}
|
||||
for _, iface := range interfaces {
|
||||
if iface.Flags&net.FlagUp == 0 || iface.Flags&net.FlagLoopback != 0 {
|
||||
continue
|
||||
}
|
||||
addrs, err := iface.Addrs()
|
||||
if err != nil {
|
||||
continue
|
||||
}
|
||||
for _, addr := range addrs {
|
||||
switch v := addr.(type) {
|
||||
case *net.IPNet:
|
||||
if ip := v.IP.To4(); ip != nil {
|
||||
return ip.String()
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
return "localhost"
|
||||
}
|
||||
|
||||
// getPublicIP tries to detect the public-facing IP by querying ipify.org.
|
||||
// Returns empty string if detection fails (e.g. no internet, timeout).
|
||||
func getPublicIP(timeout time.Duration) string {
|
||||
client := &http.Client{Timeout: timeout}
|
||||
resp, err := client.Get("https://api.ipify.org")
|
||||
if err != nil {
|
||||
return ""
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
return ""
|
||||
}
|
||||
data, err := io.ReadAll(io.LimitReader(resp.Body, 64))
|
||||
if err != nil || len(data) == 0 {
|
||||
return ""
|
||||
}
|
||||
return strings.TrimSpace(string(data))
|
||||
}
|
||||
@@ -1,33 +0,0 @@
|
||||
//go:build !windows
|
||||
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"os/signal"
|
||||
"syscall"
|
||||
)
|
||||
|
||||
func runProgram() {
|
||||
app, err := newApplication()
|
||||
if err != nil {
|
||||
reportError("MeBox 启动失败", err)
|
||||
os.Exit(1)
|
||||
}
|
||||
|
||||
stop := make(chan os.Signal, 1)
|
||||
signal.Notify(stop, syscall.SIGINT, syscall.SIGTERM)
|
||||
<-stop
|
||||
|
||||
if err := app.Shutdown(); err != nil {
|
||||
reportError("MeBox 退出失败", err)
|
||||
}
|
||||
}
|
||||
|
||||
func reportError(title string, err error) {
|
||||
if err == nil {
|
||||
return
|
||||
}
|
||||
fmt.Fprintf(os.Stderr, "%s: %v\n", title, err)
|
||||
}
|
||||
@@ -1,330 +0,0 @@
|
||||
//go:build windows
|
||||
|
||||
package main
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"os"
|
||||
"os/exec"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"sync/atomic"
|
||||
"syscall"
|
||||
|
||||
"fyne.io/systray"
|
||||
"golang.org/x/sys/windows"
|
||||
"golang.org/x/sys/windows/registry"
|
||||
|
||||
"github.com/truewhile/MeBox/internal/brand"
|
||||
)
|
||||
|
||||
const (
|
||||
runRegistryKey = `Software\Microsoft\Windows\CurrentVersion\Run`
|
||||
runRegistryValue = "MeBox"
|
||||
singleInstanceName = `Local\MeBox-Server`
|
||||
)
|
||||
|
||||
var errAlreadyRunning = errors.New("MeBox is already running")
|
||||
|
||||
func runProgram() {
|
||||
if err := prepareWorkingDirectory(); err != nil {
|
||||
reportError("MeBox 启动失败", fmt.Errorf("切换工作目录失败: %w", err))
|
||||
return
|
||||
}
|
||||
|
||||
instance, err := acquireSingleInstance()
|
||||
if errors.Is(err, errAlreadyRunning) {
|
||||
reportError("MeBox", errors.New("MeBox 已在运行,请查看右下角托盘图标"))
|
||||
return
|
||||
}
|
||||
if err != nil {
|
||||
reportError("MeBox 启动失败", fmt.Errorf("创建单实例锁失败: %w", err))
|
||||
return
|
||||
}
|
||||
|
||||
app, err := newApplication()
|
||||
if err != nil {
|
||||
_ = instance.Close()
|
||||
reportError("MeBox 启动失败", err)
|
||||
return
|
||||
}
|
||||
|
||||
controller := &trayController{app: app}
|
||||
systray.Run(controller.onReady, controller.onExit)
|
||||
|
||||
// Release the mutex before starting the replacement process. The new
|
||||
// process must be able to acquire it immediately after the old one exits.
|
||||
_ = instance.Close()
|
||||
|
||||
if !controller.readyClosed.Load() {
|
||||
_ = app.Shutdown()
|
||||
reportError("MeBox 启动失败", errors.New("系统托盘初始化失败"))
|
||||
return
|
||||
}
|
||||
if controller.restartRequested.Load() {
|
||||
if err := launchSelf(); err != nil {
|
||||
reportError("MeBox 重启失败", err)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
type trayController struct {
|
||||
app *application
|
||||
|
||||
readyClosed atomic.Bool
|
||||
restartRequested atomic.Bool
|
||||
shutdownStarted atomic.Bool
|
||||
}
|
||||
|
||||
func (c *trayController) onReady() {
|
||||
defer func() {
|
||||
c.readyClosed.Store(true)
|
||||
}()
|
||||
|
||||
systray.SetIcon(brand.Icon)
|
||||
systray.SetTooltip("MeBox")
|
||||
|
||||
mOpen := systray.AddMenuItem("打开 MeBox", "在浏览器中打开 MeBox")
|
||||
mAutoStart := systray.AddMenuItemCheckbox("开机自启", "登录 Windows 后自动启动 MeBox", autoStartEnabled())
|
||||
mLogs := systray.AddMenuItem("查看日志", "打开 MeBox 应用日志")
|
||||
systray.AddSeparator()
|
||||
mRestart := systray.AddMenuItem("重启 MeBox", "重启 MeBox 服务")
|
||||
mQuit := systray.AddMenuItem("退出 MeBox", "停止服务并退出")
|
||||
|
||||
initialAutoStart := mAutoStart.Checked()
|
||||
go func() {
|
||||
for {
|
||||
select {
|
||||
case <-mOpen.ClickedCh:
|
||||
if err := openURL(c.app.localURL()); err != nil {
|
||||
reportError("MeBox", fmt.Errorf("打开 MeBox 失败: %w", err))
|
||||
}
|
||||
case <-mAutoStart.ClickedCh:
|
||||
enable := !mAutoStart.Checked()
|
||||
if err := setAutoStart(enable); err != nil {
|
||||
if initialAutoStart {
|
||||
mAutoStart.Check()
|
||||
} else {
|
||||
mAutoStart.Uncheck()
|
||||
}
|
||||
reportError("MeBox", fmt.Errorf("更新开机自启设置失败: %w", err))
|
||||
continue
|
||||
}
|
||||
if enable {
|
||||
mAutoStart.Check()
|
||||
} else {
|
||||
mAutoStart.Uncheck()
|
||||
}
|
||||
initialAutoStart = enable
|
||||
case <-mLogs.ClickedCh:
|
||||
if err := c.app.openLog(); err != nil {
|
||||
reportError("MeBox", fmt.Errorf("打开日志失败: %w", err))
|
||||
}
|
||||
case <-mRestart.ClickedCh:
|
||||
c.restart()
|
||||
case <-mQuit.ClickedCh:
|
||||
c.quit()
|
||||
}
|
||||
}
|
||||
}()
|
||||
}
|
||||
|
||||
func (c *trayController) onExit() {
|
||||
_ = c.app.Shutdown()
|
||||
}
|
||||
|
||||
func (c *trayController) quit() {
|
||||
if !c.shutdownStarted.CompareAndSwap(false, true) {
|
||||
return
|
||||
}
|
||||
go func() {
|
||||
_ = c.app.Shutdown()
|
||||
systray.Quit()
|
||||
}()
|
||||
}
|
||||
|
||||
func (c *trayController) restart() {
|
||||
if !c.shutdownStarted.CompareAndSwap(false, true) {
|
||||
return
|
||||
}
|
||||
c.restartRequested.Store(true)
|
||||
go func() {
|
||||
_ = c.app.Shutdown()
|
||||
systray.Quit()
|
||||
}()
|
||||
}
|
||||
|
||||
func (a *application) openLog() error {
|
||||
appLog, _, _ := logFilePaths(a.cfg)
|
||||
if appLog != "" {
|
||||
if _, err := os.Stat(appLog); err == nil {
|
||||
return openPath(appLog)
|
||||
}
|
||||
_ = os.MkdirAll(filepath.Dir(appLog), 0o750)
|
||||
return openPath(filepath.Dir(appLog))
|
||||
}
|
||||
|
||||
logDir := filepath.Join(a.cfg.App.DataDir, "logs")
|
||||
if err := os.MkdirAll(logDir, 0o750); err != nil {
|
||||
return err
|
||||
}
|
||||
return openPath(logDir)
|
||||
}
|
||||
|
||||
func prepareWorkingDirectory() error {
|
||||
exe, err := os.Executable()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
exeDir := filepath.Dir(exe)
|
||||
cwd, err := os.Getwd()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if samePath(exeDir, cwd) || looksLikeProjectDirectory(cwd) {
|
||||
return nil
|
||||
}
|
||||
return os.Chdir(exeDir)
|
||||
}
|
||||
|
||||
func looksLikeProjectDirectory(dir string) bool {
|
||||
for _, name := range []string{"go.mod", "config.yaml", "data", filepath.Join("web", "dist")} {
|
||||
if _, err := os.Stat(filepath.Join(dir, name)); err == nil {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
func samePath(left, right string) bool {
|
||||
return strings.EqualFold(filepath.Clean(left), filepath.Clean(right))
|
||||
}
|
||||
|
||||
type singleInstance struct {
|
||||
handle windows.Handle
|
||||
}
|
||||
|
||||
func acquireSingleInstance() (*singleInstance, error) {
|
||||
name, err := windows.UTF16PtrFromString(singleInstanceName)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
handle, err := windows.CreateMutex(nil, false, name)
|
||||
if errors.Is(err, windows.ERROR_ALREADY_EXISTS) {
|
||||
if handle != 0 {
|
||||
_ = windows.CloseHandle(handle)
|
||||
}
|
||||
return nil, errAlreadyRunning
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return &singleInstance{handle: handle}, nil
|
||||
}
|
||||
|
||||
func (s *singleInstance) Close() error {
|
||||
if s == nil || s.handle == 0 {
|
||||
return nil
|
||||
}
|
||||
err := windows.CloseHandle(s.handle)
|
||||
s.handle = 0
|
||||
return err
|
||||
}
|
||||
|
||||
func launchSelf() error {
|
||||
exe, err := os.Executable()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
cwd, err := os.Getwd()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
cmd := exec.Command(exe, os.Args[1:]...)
|
||||
cmd.Dir = cwd
|
||||
cmd.Env = os.Environ()
|
||||
cmd.SysProcAttr = &syscall.SysProcAttr{
|
||||
HideWindow: true,
|
||||
CreationFlags: windows.CREATE_NEW_PROCESS_GROUP | windows.DETACHED_PROCESS,
|
||||
}
|
||||
if err := cmd.Start(); err != nil {
|
||||
return err
|
||||
}
|
||||
return cmd.Process.Release()
|
||||
}
|
||||
|
||||
func autoStartEnabled() bool {
|
||||
key, err := registry.OpenKey(registry.CURRENT_USER, runRegistryKey, registry.QUERY_VALUE)
|
||||
if err != nil {
|
||||
return false
|
||||
}
|
||||
defer key.Close()
|
||||
|
||||
value, _, err := key.GetStringValue(runRegistryValue)
|
||||
if err != nil {
|
||||
return false
|
||||
}
|
||||
exe, err := os.Executable()
|
||||
if err != nil {
|
||||
return false
|
||||
}
|
||||
return strings.EqualFold(strings.TrimSpace(strings.Trim(value, `"`)), filepath.Clean(exe))
|
||||
}
|
||||
|
||||
func setAutoStart(enabled bool) error {
|
||||
key, _, err := registry.CreateKey(registry.CURRENT_USER, runRegistryKey, registry.SET_VALUE)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer key.Close()
|
||||
|
||||
if !enabled {
|
||||
if err := key.DeleteValue(runRegistryValue); err != nil && !errors.Is(err, registry.ErrNotExist) {
|
||||
return err
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
exe, err := os.Executable()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return key.SetStringValue(runRegistryValue, syscall.EscapeArg(filepath.Clean(exe)))
|
||||
}
|
||||
|
||||
func openURL(url string) error {
|
||||
return shellOpen(url)
|
||||
}
|
||||
|
||||
func openPath(path string) error {
|
||||
return shellOpen(path)
|
||||
}
|
||||
|
||||
func shellOpen(target string) error {
|
||||
targetPtr, err := windows.UTF16PtrFromString(target)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
verbPtr, err := windows.UTF16PtrFromString("open")
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return windows.ShellExecute(0, verbPtr, targetPtr, nil, nil, 1)
|
||||
}
|
||||
|
||||
func reportError(title string, err error) {
|
||||
if err == nil {
|
||||
return
|
||||
}
|
||||
text, textErr := windows.UTF16PtrFromString(title + "\r\n\r\n" + err.Error())
|
||||
if textErr != nil {
|
||||
return
|
||||
}
|
||||
caption, captionErr := windows.UTF16PtrFromString("MeBox")
|
||||
if captionErr != nil {
|
||||
return
|
||||
}
|
||||
_, _ = windows.MessageBox(0, text, caption, windows.MB_OK|windows.MB_ICONERROR|windows.MB_SETFOREGROUND)
|
||||
}
|
||||
@@ -1,129 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"net"
|
||||
"sync"
|
||||
"time"
|
||||
)
|
||||
|
||||
// 开启 HTTPS 后,同一个端口会同时面对两类连接:
|
||||
//
|
||||
// - TLS 客户端(浏览器、播放器)——正常提供 HTTPS 服务;
|
||||
// - 明确访问 http:// 的客户端——以前只会撞出一句
|
||||
// "Client sent an HTTP request to an HTTPS server.",用户看不懂。
|
||||
//
|
||||
// 一个端口上只有 TLS 监听时无法区分两者,所以在 Accept 之后先偷看第一个字节:
|
||||
// TLS 握手的记录类型固定是 0x16(handshake),而 HTTP 请求行必然是可见字符。
|
||||
// 据此把连接分流成两路,明文那一路交给只做跳转的 http.Server,于是 http:// 会被
|
||||
// 自动重定向到 https://(见 server_manager.go 的 httpsRedirectHandler)。
|
||||
const tlsRecordHandshake = 0x16
|
||||
|
||||
// defaultPeekTimeout 限制"偷看首字节"阶段的等待,避免只连不发的半开连接长期占住
|
||||
// goroutine。分流器按实例持有该值,便于测试用更短的超时。
|
||||
const defaultPeekTimeout = 10 * time.Second
|
||||
|
||||
// splitListener 是监听分流器:Accept 到底层连接后按首字节投递给对应的一路。
|
||||
type splitListener struct {
|
||||
ln net.Listener
|
||||
tlsCh chan net.Conn
|
||||
plainCh chan net.Conn
|
||||
quit chan struct{}
|
||||
once sync.Once
|
||||
peek time.Duration
|
||||
}
|
||||
|
||||
func newSplitListener(ln net.Listener) *splitListener {
|
||||
return newSplitListenerWithTimeout(ln, defaultPeekTimeout)
|
||||
}
|
||||
|
||||
func newSplitListenerWithTimeout(ln net.Listener, peek time.Duration) *splitListener {
|
||||
s := &splitListener{
|
||||
ln: ln,
|
||||
tlsCh: make(chan net.Conn),
|
||||
plainCh: make(chan net.Conn),
|
||||
quit: make(chan struct{}),
|
||||
peek: peek,
|
||||
}
|
||||
go s.acceptLoop()
|
||||
return s
|
||||
}
|
||||
|
||||
// tlsListener 返回只收到 TLS 连接的 listener。
|
||||
func (s *splitListener) tlsListener() net.Listener {
|
||||
return &channelListener{addr: s.ln.Addr(), conns: s.tlsCh, quit: s.quit}
|
||||
}
|
||||
|
||||
// plainListener 返回只收到明文 HTTP 连接的 listener。
|
||||
func (s *splitListener) plainListener() net.Listener {
|
||||
return &channelListener{addr: s.ln.Addr(), conns: s.plainCh, quit: s.quit}
|
||||
}
|
||||
|
||||
func (s *splitListener) acceptLoop() {
|
||||
for {
|
||||
conn, err := s.ln.Accept()
|
||||
if err != nil {
|
||||
// 底层监听关闭(换证、关停)后两路 Accept 一起返回 net.ErrClosed,
|
||||
// 由持有它们的 http.Server 自行收尾。
|
||||
s.stop()
|
||||
return
|
||||
}
|
||||
go s.dispatch(conn)
|
||||
}
|
||||
}
|
||||
|
||||
func (s *splitListener) dispatch(conn net.Conn) {
|
||||
br := bufio.NewReader(conn)
|
||||
_ = conn.SetReadDeadline(time.Now().Add(s.peek))
|
||||
first, err := br.Peek(1)
|
||||
_ = conn.SetReadDeadline(time.Time{})
|
||||
if err != nil {
|
||||
_ = conn.Close()
|
||||
return
|
||||
}
|
||||
|
||||
peeked := &peekedConn{Conn: conn, r: br}
|
||||
ch := s.plainCh
|
||||
if first[0] == tlsRecordHandshake {
|
||||
ch = s.tlsCh
|
||||
}
|
||||
select {
|
||||
case ch <- peeked: // 交给对应的 http.Server,由它负责读写与关闭
|
||||
case <-s.quit:
|
||||
_ = conn.Close()
|
||||
}
|
||||
}
|
||||
|
||||
func (s *splitListener) stop() {
|
||||
s.once.Do(func() { close(s.quit) })
|
||||
}
|
||||
|
||||
// channelListener 把一路 channel 包装成 net.Listener,供 http.Server.Serve 使用。
|
||||
type channelListener struct {
|
||||
addr net.Addr
|
||||
conns <-chan net.Conn
|
||||
quit <-chan struct{}
|
||||
}
|
||||
|
||||
func (l *channelListener) Accept() (net.Conn, error) {
|
||||
select {
|
||||
case conn := <-l.conns:
|
||||
return conn, nil
|
||||
case <-l.quit:
|
||||
return nil, net.ErrClosed
|
||||
}
|
||||
}
|
||||
|
||||
// Close 是空实现:真正要释放的端口在 splitListener 的底层监听上,它一旦关闭,
|
||||
// 这里的 Accept 就会返回 net.ErrClosed,http.Server 随之退出。
|
||||
func (l *channelListener) Close() error { return nil }
|
||||
|
||||
func (l *channelListener) Addr() net.Addr { return l.addr }
|
||||
|
||||
// peekedConn 把已经读进 bufio 缓冲的首字节还给上层读取者。
|
||||
type peekedConn struct {
|
||||
net.Conn
|
||||
r *bufio.Reader
|
||||
}
|
||||
|
||||
func (c *peekedConn) Read(p []byte) (int, error) { return c.r.Read(p) }
|
||||
@@ -1,140 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"io"
|
||||
"net"
|
||||
"net/http"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
func TestSplitListenerRoutesByFirstByte(t *testing.T) {
|
||||
raw, err := net.Listen("tcp", "127.0.0.1:0")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
split := newSplitListener(raw)
|
||||
addr := raw.Addr().String()
|
||||
|
||||
// TLS:首字节 0x16。分流器偷看过的字节必须还能被上层读到,否则握手会失败。
|
||||
handshake := []byte{0x16, 0x03, 0x01, 0x00, 0x2c}
|
||||
tlsClient, err := net.Dial("tcp", addr)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer func() { _ = tlsClient.Close() }()
|
||||
if _, err := tlsClient.Write(handshake); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
tlsConn := <-split.tlsCh
|
||||
defer func() { _ = tlsConn.Close() }()
|
||||
got := make([]byte, len(handshake))
|
||||
if _, err := io.ReadFull(tlsConn, got); err != nil {
|
||||
t.Fatalf("read peeked tls bytes: %v", err)
|
||||
}
|
||||
if string(got) != string(handshake) {
|
||||
t.Fatalf("tls bytes = %v, want %v", got, handshake)
|
||||
}
|
||||
|
||||
// 明文 HTTP:请求行走另一路,同样要读到偷看过的首字节。
|
||||
request := "GET /api/health HTTP/1.1\r\nHost: example.com\r\n\r\n"
|
||||
plainClient, err := net.Dial("tcp", addr)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer func() { _ = plainClient.Close() }()
|
||||
if _, err := plainClient.Write([]byte(request)); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
plainConn := <-split.plainCh
|
||||
defer func() { _ = plainConn.Close() }()
|
||||
head := make([]byte, len("GET /"))
|
||||
if _, err := io.ReadFull(plainConn, head); err != nil {
|
||||
t.Fatalf("read peeked plain bytes: %v", err)
|
||||
}
|
||||
if string(head) != request[:len(head)] {
|
||||
t.Fatalf("plain bytes = %q, want prefix of %q", head, request)
|
||||
}
|
||||
|
||||
// 底层监听关闭后两路 Accept 都要返回 net.ErrClosed,http.Server 才能收尾。
|
||||
_ = raw.Close()
|
||||
for _, ln := range []net.Listener{split.tlsListener(), split.plainListener()} {
|
||||
deadline := time.Now().Add(3 * time.Second)
|
||||
for {
|
||||
_, err := ln.Accept()
|
||||
if err == net.ErrClosed {
|
||||
break
|
||||
}
|
||||
if time.Now().After(deadline) {
|
||||
t.Fatalf("Accept after close = %v, want net.ErrClosed", err)
|
||||
}
|
||||
time.Sleep(10 * time.Millisecond)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// 只连不发的半开连接不应被分给任何一路,而应在偷看超时后被丢弃。
|
||||
func TestSplitListenerDropsIdleConnection(t *testing.T) {
|
||||
raw, err := net.Listen("tcp", "127.0.0.1:0")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer func() { _ = raw.Close() }()
|
||||
split := newSplitListenerWithTimeout(raw, 200*time.Millisecond)
|
||||
|
||||
conn, err := net.Dial("tcp", raw.Addr().String())
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer func() { _ = conn.Close() }()
|
||||
|
||||
select {
|
||||
case c := <-split.plainCh:
|
||||
_ = c.Close()
|
||||
t.Fatal("idle connection should not be dispatched")
|
||||
case c := <-split.tlsCh:
|
||||
_ = c.Close()
|
||||
t.Fatal("idle connection should not be dispatched")
|
||||
case <-time.After(time.Second):
|
||||
}
|
||||
}
|
||||
|
||||
func TestHTTPSRedirectTarget(t *testing.T) {
|
||||
cases := []struct {
|
||||
name string
|
||||
host string
|
||||
rawURL string
|
||||
want string
|
||||
wantErr bool
|
||||
}{
|
||||
{name: "keeps host port path and query", host: "10.0.0.2:8080", rawURL: "/library?tab=1&q=a%20b", want: "https://10.0.0.2:8080/library?tab=1&q=a%20b"},
|
||||
{name: "root path", host: "nas.local:18080", rawURL: "/", want: "https://nas.local:18080/"},
|
||||
{name: "keeps escaping of user input", host: "10.0.0.2", rawURL: "/a%2Fb", want: "https://10.0.0.2/a%2Fb"},
|
||||
{name: "absolute form request line", host: "10.0.0.2:8080", rawURL: "http://10.0.0.2:8080/api/x?y=1", want: "https://10.0.0.2:8080/api/x?y=1"},
|
||||
{name: "rejects empty host", host: "", rawURL: "/", wantErr: true},
|
||||
{name: "rejects host with slash", host: "evil.com/path", rawURL: "/", wantErr: true},
|
||||
{name: "rejects userinfo host", host: "user@evil.com", rawURL: "/", wantErr: true},
|
||||
}
|
||||
for _, tc := range cases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
req, err := http.NewRequest(http.MethodGet, tc.rawURL, nil)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
req.Host = tc.host
|
||||
|
||||
if host := redirectHostHeader(req); host == "" {
|
||||
if !tc.wantErr {
|
||||
t.Fatalf("redirectHostHeader(%q) rejected, want accepted", tc.host)
|
||||
}
|
||||
return
|
||||
}
|
||||
if tc.wantErr {
|
||||
t.Fatalf("redirectHostHeader(%q) accepted, want rejected", tc.host)
|
||||
}
|
||||
if got := httpsRedirectURL(tc.host, req); got != tc.want {
|
||||
t.Fatalf("redirect target = %q, want %q", got, tc.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
@@ -1,11 +0,0 @@
|
||||
//go:build windows
|
||||
|
||||
package main
|
||||
|
||||
// Regenerate the linked Windows resources after changing the project logo or
|
||||
// manifest:
|
||||
//
|
||||
// go generate ./cmd/server
|
||||
//
|
||||
//go:generate go run github.com/akavel/rsrc@v0.10.2 -arch amd64 -ico ../../internal/brand/logo.ico -manifest winres/mebox.manifest -o rsrc_windows_amd64.syso
|
||||
//go:generate go run github.com/akavel/rsrc@v0.10.2 -arch arm64 -ico ../../internal/brand/logo.ico -manifest winres/mebox.manifest -o rsrc_windows_arm64.syso
|
||||
@@ -1,211 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"io/fs"
|
||||
"mime"
|
||||
"net/http"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
|
||||
"github.com/gin-gonic/gin"
|
||||
"go.uber.org/zap"
|
||||
|
||||
"github.com/truewhile/MeBox/internal/config"
|
||||
"github.com/truewhile/MeBox/internal/handler"
|
||||
"github.com/truewhile/MeBox/internal/middleware"
|
||||
"github.com/truewhile/MeBox/internal/service"
|
||||
|
||||
"github.com/truewhile/MeBox/web"
|
||||
)
|
||||
|
||||
func buildRouter(cfg *config.Config, logger *zap.Logger, embyCompatLogger *zap.Logger, svc *service.Container) *gin.Engine {
|
||||
if !cfg.App.Debug {
|
||||
gin.SetMode(gin.ReleaseMode)
|
||||
}
|
||||
r := gin.New()
|
||||
r.Use(gin.Recovery())
|
||||
r.Use(middleware.RequestLogger(logger))
|
||||
r.Use(middleware.EmbyCompatLogger(embyCompatLogger, func(path string) bool {
|
||||
return !isFrontendLibraryRoute(path) && handler.IsEmbyPath(path)
|
||||
}))
|
||||
if !cfg.App.Debug && len(cfg.App.CORSOrigins) == 0 {
|
||||
logger.Warn("CORS: no origins configured in production — CORS headers will be omitted (same-origin enforced). Set app.cors_origins for cross-origin access.")
|
||||
}
|
||||
r.Use(middleware.CORS(cfg.App.CORSOrigins, cfg.App.Debug))
|
||||
|
||||
handler.Register(r, cfg, logger, svc)
|
||||
|
||||
// Prefer a directory on disk when configured explicitly (e.g. the Docker image
|
||||
// mounts web/dist from the build stage, or an operator overrides app.web_dir
|
||||
// with a custom skin). Otherwise fall back to the SPA embedded into the binary,
|
||||
// which is what makes the cross-platform single-file artifacts work.
|
||||
uiFS := webui.DistFS()
|
||||
if dir := cfg.App.WebDir; dir != "" {
|
||||
disk := os.DirFS(dir)
|
||||
if index, err := fs.Stat(disk, "index.html"); err == nil && !index.IsDir() {
|
||||
uiFS = disk
|
||||
}
|
||||
}
|
||||
serveSPA(r, uiFS)
|
||||
return r
|
||||
}
|
||||
|
||||
// serveSPA serves the React build artifacts and falls back to index.html for
|
||||
// non-API, non-asset paths so client-side routing keeps working. The UI tree
|
||||
// comes from root, which is either the compiled-in SPA or an on-disk web dir.
|
||||
func serveSPA(r *gin.Engine, root fs.FS) {
|
||||
assets := r.Group("/assets")
|
||||
assets.Use(middleware.GzipStatic())
|
||||
assets.Use(func(c *gin.Context) {
|
||||
c.Header("Cache-Control", "public, max-age=31536000, immutable")
|
||||
c.Next()
|
||||
})
|
||||
assets.GET("/*filepath", serveFSDir(root, "assets"))
|
||||
fonts := r.Group("/fonts")
|
||||
fonts.Use(middleware.GzipStatic())
|
||||
fonts.Use(func(c *gin.Context) {
|
||||
c.Header("Cache-Control", "public, max-age=86400")
|
||||
c.Next()
|
||||
})
|
||||
fonts.GET("/*filepath", serveFSDir(root, "fonts"))
|
||||
brand := r.Group("/brand")
|
||||
brand.Use(func(c *gin.Context) {
|
||||
setNoCacheHeaders(c)
|
||||
c.Next()
|
||||
})
|
||||
brand.GET("/*filepath", serveFSDir(root, "brand"))
|
||||
for _, rootFile := range []string{"/favicon.ico", "/favicon.svg", "/artwork-cache-sw.js"} {
|
||||
name := strings.TrimPrefix(rootFile, "/")
|
||||
r.GET(rootFile, serveFSFile(root, name))
|
||||
r.HEAD(rootFile, serveFSFile(root, name))
|
||||
}
|
||||
r.NoRoute(middleware.GzipStatic(), func(c *gin.Context) {
|
||||
if handler.TryHandleEmbyNormalizedRoute(c, r) {
|
||||
return
|
||||
}
|
||||
path := c.Request.URL.Path
|
||||
if shouldBypassSPAFallback(path) {
|
||||
c.Status(http.StatusNotFound)
|
||||
return
|
||||
}
|
||||
setNoCacheHeaders(c)
|
||||
data, err := fs.ReadFile(root, "index.html")
|
||||
if err != nil {
|
||||
c.String(http.StatusNotFound, "MeBox web UI not found")
|
||||
return
|
||||
}
|
||||
c.Data(http.StatusOK, "text/html; charset=utf-8", data)
|
||||
})
|
||||
}
|
||||
|
||||
// serveFSDir serves a static subdirectory of root. A missing asset returns 404.
|
||||
func serveFSDir(root fs.FS, dir string) gin.HandlerFunc {
|
||||
sub, err := fs.Sub(root, dir)
|
||||
if err != nil {
|
||||
return func(c *gin.Context) { c.Status(http.StatusNotFound) }
|
||||
}
|
||||
handler := http.StripPrefix("/"+dir, http.FileServerFS(sub))
|
||||
return func(c *gin.Context) {
|
||||
handler.ServeHTTP(c.Writer, c.Request)
|
||||
}
|
||||
}
|
||||
|
||||
// serveFSFile serves a single root-level file (favicon / service worker) with
|
||||
// no-cache headers. It reads from root, which may be the embedded SPA or disk.
|
||||
func serveFSFile(root fs.FS, name string) gin.HandlerFunc {
|
||||
return func(c *gin.Context) {
|
||||
setNoCacheHeaders(c)
|
||||
data, err := fs.ReadFile(root, name)
|
||||
if err != nil {
|
||||
c.Status(http.StatusNotFound)
|
||||
return
|
||||
}
|
||||
c.Data(http.StatusOK, mimeTypeByName(name), data)
|
||||
}
|
||||
}
|
||||
|
||||
// mimeTypeByName returns an HTTP content type guessed from a file extension.
|
||||
func mimeTypeByName(name string) string {
|
||||
switch mime.TypeByExtension(filepath.Ext(name)) {
|
||||
case "":
|
||||
return "application/octet-stream"
|
||||
default:
|
||||
return mime.TypeByExtension(filepath.Ext(name))
|
||||
}
|
||||
}
|
||||
|
||||
func setNoCacheHeaders(c *gin.Context) {
|
||||
c.Header("Cache-Control", "no-cache, no-store, must-revalidate")
|
||||
c.Header("Pragma", "no-cache")
|
||||
c.Header("Expires", "0")
|
||||
}
|
||||
|
||||
func shouldBypassSPAFallback(path string) bool {
|
||||
if isFrontendLibraryRoute(path) {
|
||||
return false
|
||||
}
|
||||
lower := strings.ToLower(path)
|
||||
for _, exact := range []string{
|
||||
"/emby",
|
||||
} {
|
||||
if lower == exact {
|
||||
return true
|
||||
}
|
||||
}
|
||||
for _, prefix := range []string{
|
||||
"/api/",
|
||||
"/emby/",
|
||||
"/system/",
|
||||
"/users/",
|
||||
"/items/",
|
||||
"/shows/",
|
||||
"/library/",
|
||||
"/videos/",
|
||||
"/sessions/",
|
||||
"/displaypreferences/",
|
||||
"/branding/",
|
||||
"/localization/",
|
||||
"/startup/",
|
||||
"/quickconnect/",
|
||||
"/socket",
|
||||
"/embywebsocket",
|
||||
} {
|
||||
if strings.HasPrefix(lower, prefix) {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
func isFrontendLibraryRoute(path string) bool {
|
||||
const prefix = "/library/"
|
||||
if !strings.HasPrefix(path, prefix) {
|
||||
return false
|
||||
}
|
||||
id := strings.TrimPrefix(path, prefix)
|
||||
if strings.Contains(id, "/") {
|
||||
return false
|
||||
}
|
||||
// 远程 Emby 挂载库的伪装 ID(embyremote~account~remote)也是前端库路由,
|
||||
// 需要交给 SPA 而非当作 Emby API 路径 404。
|
||||
if strings.HasPrefix(id, "embyremote~") {
|
||||
return true
|
||||
}
|
||||
if len(id) != 36 {
|
||||
return false
|
||||
}
|
||||
for i, ch := range id {
|
||||
switch i {
|
||||
case 8, 13, 18, 23:
|
||||
if ch != '-' {
|
||||
return false
|
||||
}
|
||||
default:
|
||||
if !((ch >= '0' && ch <= '9') || (ch >= 'a' && ch <= 'f') || (ch >= 'A' && ch <= 'F')) {
|
||||
return false
|
||||
}
|
||||
}
|
||||
}
|
||||
return true
|
||||
}
|
||||
Binary file not shown.
Binary file not shown.
@@ -1,386 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"crypto/tls"
|
||||
"errors"
|
||||
"fmt"
|
||||
"net"
|
||||
"net/http"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
"go.uber.org/zap"
|
||||
|
||||
"github.com/truewhile/MeBox/internal/config"
|
||||
"github.com/truewhile/MeBox/internal/service"
|
||||
)
|
||||
|
||||
// httpSchemeFileName 是数据目录下记录当前监听协议的小文件(内容为 http 或 https)。
|
||||
//
|
||||
// 容器健康检查无法读取后台保存的 HTTPS 设置(它存在数据库里),而同一端口在开启
|
||||
// HTTPS 后只接受 TLS。若健康检查固定用 http:// 探测,每轮都会撞出
|
||||
// "client sent an HTTP request to an HTTPS server",既刷日志又让容器永远 unhealthy。
|
||||
// 因此由服务进程在每次成功绑定监听后写下真实协议,供 docker-healthcheck.sh 选择。
|
||||
const httpSchemeFileName = ".http_scheme"
|
||||
|
||||
// tlsPair 记录当前正在服务的证书,用于判断是否需要重新绑定监听。
|
||||
type tlsPair struct {
|
||||
cert tls.Certificate
|
||||
certPEM string
|
||||
keyPEM string
|
||||
// version 是解析后的证书/私钥指纹;内容或磁盘文件变化都会导致其改变,
|
||||
// 据此决定是否需要重新绑定监听。
|
||||
version string
|
||||
}
|
||||
|
||||
// serverManager 负责 MeBox 的 HTTP/HTTPS 监听。HTTPS 设置保存后调用 Reload,
|
||||
// 在同一个端口上把明文 HTTP 与 TLS 监听热切换,无需重启进程:
|
||||
//
|
||||
// - 关闭旧监听释放端口(同一进程内 Windows 不允许重复绑定同一端口);
|
||||
// - 按最新配置重新绑定并立即对外服务;
|
||||
// - 旧服务器随后优雅退出,正在进行的播放/请求不会被立刻掐断。
|
||||
//
|
||||
// 任何校验失败都会中止切换并保留旧监听,保证用户不会被锁在服务外面。
|
||||
//
|
||||
// 开启 HTTPS 时端口上会同时接两类连接:TLS 走主服务器,明文 HTTP 走
|
||||
// redirectSrv 并跳转到 HTTPS(见 protocol_mux.go)。
|
||||
type serverManager struct {
|
||||
cfg *config.Config
|
||||
log *zap.Logger
|
||||
handler http.Handler
|
||||
addr string
|
||||
|
||||
mu sync.Mutex
|
||||
srv *http.Server
|
||||
redirectSrv *http.Server
|
||||
ln net.Listener
|
||||
pair *tlsPair
|
||||
stopCh chan struct{}
|
||||
autoReloadStarted bool
|
||||
}
|
||||
|
||||
func newServerManager(cfg *config.Config, log *zap.Logger, handler http.Handler) *serverManager {
|
||||
return &serverManager{
|
||||
cfg: cfg,
|
||||
log: log,
|
||||
handler: handler,
|
||||
addr: fmt.Sprintf(":%d", cfg.App.Port),
|
||||
stopCh: make(chan struct{}),
|
||||
}
|
||||
}
|
||||
|
||||
// Start 启动监听。即使 HTTPS 配置损坏也退回明文 HTTP 继续启动,避免服务冷启动失败。
|
||||
func (m *serverManager) Start() error {
|
||||
m.mu.Lock()
|
||||
defer m.mu.Unlock()
|
||||
|
||||
pair, err := m.desiredPair()
|
||||
if err != nil {
|
||||
m.log.Error("invalid HTTPS config at startup, serving plain HTTP instead", zap.Error(err))
|
||||
pair = nil
|
||||
}
|
||||
if err := m.bind(pair); err != nil {
|
||||
return err
|
||||
}
|
||||
m.logServerReady()
|
||||
m.maybeStartAutoReloadLocked()
|
||||
return nil
|
||||
}
|
||||
|
||||
// Reload 依据最新配置热切换监听。返回的错误会带给调用它的设置接口;若新监听
|
||||
// 绑定失败会自动回滚到旧配置继续服务。
|
||||
func (m *serverManager) Reload() error {
|
||||
m.mu.Lock()
|
||||
defer m.mu.Unlock()
|
||||
|
||||
pair, err := m.desiredPair()
|
||||
if err != nil {
|
||||
m.log.Error("server reload aborted", zap.Error(err))
|
||||
return err
|
||||
}
|
||||
if m.pairEquals(pair) {
|
||||
return nil
|
||||
}
|
||||
|
||||
oldSrv, oldRedirect, oldLn, oldPair := m.srv, m.redirectSrv, m.ln, m.pair
|
||||
if oldLn != nil {
|
||||
_ = oldLn.Close() // 释放端口后再绑定新监听
|
||||
}
|
||||
m.srv, m.redirectSrv, m.ln, m.pair = nil, nil, nil, nil
|
||||
|
||||
firstErr := m.bind(pair)
|
||||
if firstErr != nil {
|
||||
m.log.Error("bind new listener failed, rolling back to previous", zap.Error(firstErr))
|
||||
if rbErr := m.bind(oldPair); rbErr != nil {
|
||||
return fmt.Errorf("reload failed: %v; rollback failed: %v", firstErr, rbErr)
|
||||
}
|
||||
}
|
||||
// 新监听已就绪,让旧服务器在新连接切换到新监听后优雅退出。
|
||||
m.drain(oldSrv)
|
||||
m.drain(oldRedirect)
|
||||
m.logServerReady()
|
||||
m.maybeStartAutoReloadLocked()
|
||||
return firstErr
|
||||
}
|
||||
|
||||
// Shutdown 优雅停止当前服务器(用于进程退出)。
|
||||
func (m *serverManager) Shutdown(ctx context.Context) error {
|
||||
select {
|
||||
case <-m.stopCh:
|
||||
default:
|
||||
close(m.stopCh)
|
||||
}
|
||||
m.mu.Lock()
|
||||
targets := []*http.Server{m.srv, m.redirectSrv}
|
||||
m.mu.Unlock()
|
||||
|
||||
var firstErr error
|
||||
for _, srv := range targets {
|
||||
if srv == nil {
|
||||
continue
|
||||
}
|
||||
if err := srv.Shutdown(ctx); err != nil && firstErr == nil {
|
||||
firstErr = err
|
||||
}
|
||||
}
|
||||
return firstErr
|
||||
}
|
||||
|
||||
// desiredPair 根据当前配置计算目标监听形态:nil 表示明文 HTTP,非 nil 表示 TLS。
|
||||
// 证书/私钥按"路径优先、内容兜底"解析,并校验是否匹配。
|
||||
func (m *serverManager) desiredPair() (*tlsPair, error) {
|
||||
// 与 ApplyRuntimeSetting 的写锁配对:HTTPS 相关字段可能被运行时设置
|
||||
// 热更新,无锁读存在数据竞争(string 撕裂)。
|
||||
config.RuntimeMu.RLock()
|
||||
httpsEnabled := m.cfg != nil && m.cfg.App.HTTPSEnabled
|
||||
cert := m.cfg.App.SSLCert
|
||||
certPath := m.cfg.App.SSLCertPath
|
||||
key := m.cfg.App.SSLKey
|
||||
keyPath := m.cfg.App.SSLKeyPath
|
||||
config.RuntimeMu.RUnlock()
|
||||
if !httpsEnabled {
|
||||
return nil, nil
|
||||
}
|
||||
certPEM, err := service.ResolveSSLMaterial(cert, certPath, "证书")
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
keyPEM, err := service.ResolveSSLMaterial(key, keyPath, "私钥")
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if err := service.ValidateSSLKeyPair(certPEM, keyPEM); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
pairCert, err := tls.X509KeyPair([]byte(certPEM), []byte(keyPEM))
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("SSL 证书/私钥无效:%v", err)
|
||||
}
|
||||
return &tlsPair{
|
||||
cert: pairCert,
|
||||
certPEM: certPEM,
|
||||
keyPEM: keyPEM,
|
||||
version: certPEM + "\x00" + keyPEM,
|
||||
}, nil
|
||||
}
|
||||
|
||||
// maybeStartAutoReloadLocked 在证书/私钥通过文件路径配置时,幂等地启动后台轮询,
|
||||
// 便于运行中切换到路径方式(或换证)后无需重启也能热更新。调用方需持有 m.mu。
|
||||
func (m *serverManager) maybeStartAutoReloadLocked() {
|
||||
if m.autoReloadStarted {
|
||||
return
|
||||
}
|
||||
if !m.pathBased() {
|
||||
return
|
||||
}
|
||||
m.autoReloadStarted = true
|
||||
m.startAutoReload()
|
||||
}
|
||||
|
||||
// pathBased 是否至少有一侧证书/私钥通过文件路径配置。
|
||||
func (m *serverManager) pathBased() bool {
|
||||
config.RuntimeMu.RLock()
|
||||
defer config.RuntimeMu.RUnlock()
|
||||
return strings.TrimSpace(m.cfg.App.SSLCertPath) != "" || strings.TrimSpace(m.cfg.App.SSLKeyPath) != ""
|
||||
}
|
||||
|
||||
// startAutoReload 后台轮询文件变更并自动热更新,方便换证。
|
||||
func (m *serverManager) startAutoReload() {
|
||||
ticker := time.NewTicker(30 * time.Second)
|
||||
go func() {
|
||||
defer ticker.Stop()
|
||||
for {
|
||||
select {
|
||||
case <-m.stopCh:
|
||||
return
|
||||
case <-ticker.C:
|
||||
if !m.pathBased() {
|
||||
continue // 路径已清空(改回内容配置),不再轮询
|
||||
}
|
||||
if err := m.Reload(); err != nil {
|
||||
m.log.Warn("periodic https reload failed", zap.Error(err))
|
||||
}
|
||||
}
|
||||
}
|
||||
}()
|
||||
}
|
||||
|
||||
// pairEquals 判断目标配置与当前监听是否一致,一致则无需重新绑定。
|
||||
func (m *serverManager) pairEquals(pair *tlsPair) bool {
|
||||
if pair == nil && m.pair == nil {
|
||||
return true
|
||||
}
|
||||
if pair == nil || m.pair == nil {
|
||||
return false
|
||||
}
|
||||
return pair.version == m.pair.version
|
||||
}
|
||||
|
||||
// bind 创建监听,异步开始服务。
|
||||
//
|
||||
// 未开启 HTTPS 时端口只服务明文 HTTP;开启后同一个端口两种流量都要接:TLS 连接
|
||||
// 交给主服务器,明文 HTTP 连接交给只做跳转的 redirect 服务器,让 http:// 自动
|
||||
// 跳到 https://,而不是甩给用户一句 "Client sent an HTTP request to an HTTPS
|
||||
// server."。
|
||||
func (m *serverManager) bind(pair *tlsPair) error {
|
||||
ln, err := net.Listen("tcp", m.addr)
|
||||
if err != nil {
|
||||
return fmt.Errorf("listen %s: %w", m.addr, err)
|
||||
}
|
||||
|
||||
if pair == nil {
|
||||
srv := m.newHTTPServer(m.handler)
|
||||
m.srv, m.redirectSrv, m.ln, m.pair = srv, nil, ln, nil
|
||||
m.writeSchemeState(nil)
|
||||
go m.serve(srv, ln)
|
||||
return nil
|
||||
}
|
||||
|
||||
split := newSplitListener(ln)
|
||||
srv := m.newHTTPServer(m.handler)
|
||||
tlsLn := tls.NewListener(split.tlsListener(), &tls.Config{
|
||||
Certificates: []tls.Certificate{pair.cert},
|
||||
MinVersion: tls.VersionTLS12,
|
||||
})
|
||||
redirect := m.newHTTPServer(m.httpsRedirectHandler())
|
||||
|
||||
m.srv, m.redirectSrv, m.ln, m.pair = srv, redirect, ln, pair
|
||||
m.writeSchemeState(pair)
|
||||
go m.serve(srv, tlsLn)
|
||||
go m.serve(redirect, split.plainListener())
|
||||
return nil
|
||||
}
|
||||
|
||||
func (m *serverManager) newHTTPServer(handler http.Handler) *http.Server {
|
||||
return &http.Server{
|
||||
Handler: handler,
|
||||
ReadHeaderTimeout: 15 * time.Second,
|
||||
}
|
||||
}
|
||||
|
||||
// httpsRedirectHandler 处理"开着 HTTPS 却用 http:// 访问"的请求:跳转到同端口、
|
||||
// 同路径的 https://。
|
||||
//
|
||||
// 用 302/307 而不是 301/308:HTTPS 开关可以在后台随时改,永久跳转会被浏览器长期
|
||||
// 缓存,等用户关掉 HTTPS 之后 http 访问会被带到已经不提供 TLS 的端口上打不开。
|
||||
func (m *serverManager) httpsRedirectHandler() http.Handler {
|
||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
host := redirectHostHeader(r)
|
||||
if host == "" {
|
||||
// 没有可用的 Host(HTTP/1.0 或畸形请求头)时宁可明说,也不跳到错的地方。
|
||||
w.Header().Set("Content-Type", "text/plain; charset=utf-8")
|
||||
w.WriteHeader(http.StatusBadRequest)
|
||||
fmt.Fprintf(w, "HTTPS is enabled; open https://<host>:%d instead.\n", m.cfg.App.Port)
|
||||
return
|
||||
}
|
||||
status := http.StatusFound
|
||||
if r.Method != http.MethodGet && r.Method != http.MethodHead {
|
||||
status = http.StatusTemporaryRedirect // 保住方法与请求体
|
||||
}
|
||||
w.Header().Set("Location", httpsRedirectURL(host, r))
|
||||
w.WriteHeader(status)
|
||||
})
|
||||
}
|
||||
|
||||
// httpsRedirectURL 拼出同端口同路径的 HTTPS 地址。
|
||||
func httpsRedirectURL(host string, r *http.Request) string {
|
||||
target := "https://" + host + r.URL.EscapedPath()
|
||||
if r.URL.RawQuery != "" {
|
||||
target += "?" + r.URL.RawQuery
|
||||
}
|
||||
return target
|
||||
}
|
||||
|
||||
// redirectHostHeader 取重定向目标主机。HTTP/1.1 里 Host 是唯一的主机来源(端口映射
|
||||
// 到容器 8080 时它同时也是 HTTPS 端口),这里只做字符过滤,避免把请求头里的怪字符
|
||||
// 带进 Location 造成任意跳转。
|
||||
func redirectHostHeader(r *http.Request) string {
|
||||
host := strings.TrimSpace(r.Host)
|
||||
if host == "" || strings.ContainsAny(host, " \t\r\n/\\@?#") {
|
||||
return ""
|
||||
}
|
||||
return host
|
||||
}
|
||||
|
||||
// writeSchemeState 把当前实际监听的协议写入数据目录,供容器健康检查按协议探测。
|
||||
// 写失败只降级为告警:健康检查脚本在状态文件缺失时会回退试另一种协议。
|
||||
func (m *serverManager) writeSchemeState(pair *tlsPair) {
|
||||
dataDir := strings.TrimSpace(m.cfg.App.DataDir)
|
||||
if dataDir == "" {
|
||||
return
|
||||
}
|
||||
scheme := "http"
|
||||
if pair != nil {
|
||||
scheme = "https"
|
||||
}
|
||||
path := filepath.Join(dataDir, httpSchemeFileName)
|
||||
if err := os.WriteFile(path, []byte(scheme+"\n"), 0o644); err != nil { // #nosec G304 -- path is DataDir + fixed filename.
|
||||
m.log.Warn("write http scheme state failed", zap.String("path", path), zap.Error(err))
|
||||
}
|
||||
}
|
||||
|
||||
func (m *serverManager) serve(s *http.Server, ln net.Listener) {
|
||||
if err := s.Serve(ln); err != nil &&
|
||||
!errors.Is(err, http.ErrServerClosed) && !errors.Is(err, net.ErrClosed) {
|
||||
m.log.Fatal("listen failed", zap.Error(err))
|
||||
}
|
||||
}
|
||||
|
||||
// drain 让旧服务器在后台优雅退出(等待进行中的连接完成或在超时后强制关闭)。
|
||||
func (m *serverManager) drain(s *http.Server) {
|
||||
if s == nil {
|
||||
return
|
||||
}
|
||||
// Stop reusing old connections before Reload returns. Asynchronous Shutdown
|
||||
// alone leaves a window where a client receives the previous HTTP/TLS mode.
|
||||
s.SetKeepAlivesEnabled(false)
|
||||
go func(s *http.Server) {
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 15*time.Second)
|
||||
defer cancel()
|
||||
if err := s.Shutdown(ctx); err != nil && !errors.Is(err, context.DeadlineExceeded) {
|
||||
m.log.Warn("drain old server failed", zap.Error(err))
|
||||
}
|
||||
}(s)
|
||||
}
|
||||
|
||||
func (m *serverManager) logServerReady() {
|
||||
scheme := "http"
|
||||
if m.pair != nil {
|
||||
scheme = "https"
|
||||
}
|
||||
localIP := getLocalIP()
|
||||
m.log.Info("server is ready",
|
||||
zap.String("scheme", scheme),
|
||||
zap.String("local", fmt.Sprintf("%s://%s:%d", scheme, localIP, m.cfg.App.Port)),
|
||||
zap.String("listen", m.addr),
|
||||
)
|
||||
if m.pair != nil {
|
||||
m.log.Info("HTTPS is enabled; plain HTTP requests on this port are redirected to HTTPS",
|
||||
zap.String("addr", m.addr),
|
||||
)
|
||||
}
|
||||
}
|
||||
@@ -1,246 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"crypto/ecdsa"
|
||||
"crypto/elliptic"
|
||||
"crypto/rand"
|
||||
"crypto/tls"
|
||||
"crypto/x509"
|
||||
"crypto/x509/pkix"
|
||||
"encoding/pem"
|
||||
"io"
|
||||
"math/big"
|
||||
"net"
|
||||
"net/http"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"go.uber.org/zap"
|
||||
|
||||
"github.com/truewhile/MeBox/internal/config"
|
||||
)
|
||||
|
||||
func makeTestPairPEM(t *testing.T) (certPEM, keyPEM string) {
|
||||
t.Helper()
|
||||
priv, err := ecdsa.GenerateKey(elliptic.P256(), rand.Reader)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
tpl := &x509.Certificate{
|
||||
SerialNumber: big.NewInt(1),
|
||||
Subject: pkix.Name{CommonName: "localhost"},
|
||||
NotBefore: time.Now().Add(-time.Hour),
|
||||
NotAfter: time.Now().Add(24 * time.Hour),
|
||||
DNSNames: []string{"localhost"},
|
||||
// 带上回环 IP,HTTPS 客户端就能在校验证书的前提下连 127.0.0.1:port。
|
||||
IPAddresses: []net.IP{net.ParseIP("127.0.0.1")},
|
||||
}
|
||||
der, err := x509.CreateCertificate(rand.Reader, tpl, tpl, &priv.PublicKey, priv)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
keyDER, err := x509.MarshalECPrivateKey(priv)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
certPEM = strings.TrimSpace(string(pem.EncodeToMemory(&pem.Block{Type: "CERTIFICATE", Bytes: der})))
|
||||
keyPEM = strings.TrimSpace(string(pem.EncodeToMemory(&pem.Block{Type: "EC PRIVATE KEY", Bytes: keyDER})))
|
||||
return certPEM, keyPEM
|
||||
}
|
||||
|
||||
func newTestServerManager(t *testing.T) *serverManager {
|
||||
t.Helper()
|
||||
cfg := &config.Config{}
|
||||
cfg.App.Port = 18081
|
||||
return newServerManager(cfg, zap.NewNop(), http.NewServeMux())
|
||||
}
|
||||
|
||||
func TestDesiredPairModes(t *testing.T) {
|
||||
m := newTestServerManager(t)
|
||||
|
||||
if p, err := m.desiredPair(); err != nil || p != nil {
|
||||
t.Fatalf("disabled should be nil pair, got p=%v err=%v", p, err)
|
||||
}
|
||||
|
||||
certPEM, keyPEM := makeTestPairPEM(t)
|
||||
m.cfg.App.HTTPSEnabled = true
|
||||
m.cfg.App.SSLCert, m.cfg.App.SSLKey = certPEM, keyPEM
|
||||
p, err := m.desiredPair()
|
||||
if err != nil || p == nil || p.version == "" {
|
||||
t.Fatalf("content pair failed: p=%v err=%v", p, err)
|
||||
}
|
||||
|
||||
dir := t.TempDir()
|
||||
certPath, keyPath := filepath.Join(dir, "cert.pem"), filepath.Join(dir, "key.pem")
|
||||
if err := os.WriteFile(certPath, []byte(certPEM), 0o600); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := os.WriteFile(keyPath, []byte(keyPEM), 0o600); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
m.cfg.App.SSLCert, m.cfg.App.SSLKey = "", ""
|
||||
m.cfg.App.SSLCertPath, m.cfg.App.SSLKeyPath = certPath, keyPath
|
||||
p2, err := m.desiredPair()
|
||||
if err != nil || p2 == nil {
|
||||
t.Fatalf("path pair failed: %v", err)
|
||||
}
|
||||
|
||||
m.cfg.App.SSLKeyPath = filepath.Join(dir, "nope.pem")
|
||||
if _, err := m.desiredPair(); err == nil {
|
||||
t.Fatal("expected error when key file missing")
|
||||
}
|
||||
m.cfg.App.SSLKeyPath = keyPath
|
||||
|
||||
// 替换文件(换一套新的有效证书)后版本号应变化,触发热更新。
|
||||
newCert, newKey := makeTestPairPEM(t)
|
||||
if err := os.WriteFile(certPath, []byte(newCert), 0o600); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := os.WriteFile(keyPath, []byte(newKey), 0o600); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
p3, err := m.desiredPair()
|
||||
if err != nil {
|
||||
t.Fatalf("replace: %v", err)
|
||||
}
|
||||
if p3.version == p2.version {
|
||||
t.Fatal("version should change after files replaced")
|
||||
}
|
||||
}
|
||||
|
||||
// 健康检查依赖该文件判断该用 http 还是 https 探测,内容与当前监听协议必须一致,
|
||||
// 否则容器会一直显示 unhealthy 并刷 TLS handshake error 日志。
|
||||
func TestWriteSchemeState(t *testing.T) {
|
||||
m := newTestServerManager(t)
|
||||
m.cfg.App.DataDir = t.TempDir()
|
||||
path := filepath.Join(m.cfg.App.DataDir, httpSchemeFileName)
|
||||
|
||||
m.writeSchemeState(nil)
|
||||
if data, err := os.ReadFile(path); err != nil || strings.TrimSpace(string(data)) != "http" {
|
||||
t.Fatalf("plain HTTP state: data=%q err=%v", data, err)
|
||||
}
|
||||
|
||||
m.writeSchemeState(&tlsPair{})
|
||||
if data, err := os.ReadFile(path); err != nil || strings.TrimSpace(string(data)) != "https" {
|
||||
t.Fatalf("HTTPS state: data=%q err=%v", data, err)
|
||||
}
|
||||
|
||||
// DataDir 为空时不应写到工作目录(测试/裸跑二进制时会污染仓库)。
|
||||
m.cfg.App.DataDir = ""
|
||||
_ = os.Remove(path)
|
||||
m.writeSchemeState(nil)
|
||||
if _, err := os.Stat(httpSchemeFileName); !os.IsNotExist(err) {
|
||||
t.Fatalf("empty DataDir should not create %s in cwd: %v", httpSchemeFileName, err)
|
||||
}
|
||||
}
|
||||
|
||||
// 开启 HTTPS 后同一个端口要同时接 TLS 与明文 HTTP:明文请求跳到 HTTPS,而不是
|
||||
// 给用户看 "Client sent an HTTP request to an HTTPS server."。
|
||||
func TestServerManagerRedirectsPlainHTTPToHTTPS(t *testing.T) {
|
||||
certPEM, keyPEM := makeTestPairPEM(t)
|
||||
cfg := &config.Config{}
|
||||
cfg.App.Port = 8080
|
||||
cfg.App.DataDir = t.TempDir()
|
||||
cfg.App.HTTPSEnabled = true
|
||||
cfg.App.SSLCert, cfg.App.SSLKey = certPEM, keyPEM
|
||||
|
||||
handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
w.WriteHeader(http.StatusOK)
|
||||
_, _ = io.WriteString(w, "secure:"+r.URL.Path)
|
||||
})
|
||||
m := newServerManager(cfg, zap.NewNop(), handler)
|
||||
m.addr = "127.0.0.1:0" // 端口 0 交给内核分配,测试之间不会撞端口
|
||||
if err := m.Start(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
t.Cleanup(func() { _ = m.Shutdown(context.Background()) })
|
||||
|
||||
addr := m.ln.Addr().String()
|
||||
// 端口 0 只在第一次分配时用;热切换要绑回同一个端口(生产里端口本来就是固定的)。
|
||||
m.addr = addr
|
||||
schemeFile := filepath.Join(cfg.App.DataDir, httpSchemeFileName)
|
||||
if data, err := os.ReadFile(schemeFile); err != nil || strings.TrimSpace(string(data)) != "https" {
|
||||
t.Fatalf("scheme state = %q err=%v, want https", data, err)
|
||||
}
|
||||
|
||||
plain := &http.Client{
|
||||
Timeout: 10 * time.Second,
|
||||
CheckRedirect: func(*http.Request, []*http.Request) error { return http.ErrUseLastResponse },
|
||||
}
|
||||
|
||||
resp, err := plain.Get("http://" + addr + "/library?tab=1")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
if resp.StatusCode != http.StatusFound {
|
||||
t.Fatalf("plain GET status = %d, want %d", resp.StatusCode, http.StatusFound)
|
||||
}
|
||||
if got, want := resp.Header.Get("Location"), "https://"+addr+"/library?tab=1"; got != want {
|
||||
t.Fatalf("Location = %q, want %q", got, want)
|
||||
}
|
||||
|
||||
postResp, err := plain.Post("http://"+addr+"/api/me/login", "application/json", strings.NewReader("{}"))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer func() { _ = postResp.Body.Close() }()
|
||||
if postResp.StatusCode != http.StatusTemporaryRedirect {
|
||||
t.Fatalf("plain POST status = %d, want %d", postResp.StatusCode, http.StatusTemporaryRedirect)
|
||||
}
|
||||
if got, want := postResp.Header.Get("Location"), "https://"+addr+"/api/me/login"; got != want {
|
||||
t.Fatalf("POST Location = %q, want %q", got, want)
|
||||
}
|
||||
|
||||
// 同一端口上的 TLS 连接照常拿到正常响应(校验证书,不做跳过校验)。
|
||||
pool := x509.NewCertPool()
|
||||
if !pool.AppendCertsFromPEM([]byte(certPEM)) {
|
||||
t.Fatal("append test certificate to pool failed")
|
||||
}
|
||||
secure := &http.Client{
|
||||
Timeout: 10 * time.Second,
|
||||
Transport: &http.Transport{
|
||||
TLSClientConfig: &tls.Config{RootCAs: pool, MinVersion: tls.VersionTLS12},
|
||||
},
|
||||
}
|
||||
secureResp, err := secure.Get("https://" + addr + "/library")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer func() { _ = secureResp.Body.Close() }()
|
||||
body, err := io.ReadAll(secureResp.Body)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if secureResp.StatusCode != http.StatusOK || string(body) != "secure:/library" {
|
||||
t.Fatalf("https response = %d %q, want 200 %q", secureResp.StatusCode, body, "secure:/library")
|
||||
}
|
||||
|
||||
// 关掉 HTTPS 后同一端口回到纯明文服务,不再有多余的跳转服务器。
|
||||
cfg.App.HTTPSEnabled = false
|
||||
if err := m.Reload(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if m.redirectSrv != nil {
|
||||
t.Fatal("redirect server should be released when HTTPS is off")
|
||||
}
|
||||
if data, err := os.ReadFile(schemeFile); err != nil || strings.TrimSpace(string(data)) != "http" {
|
||||
t.Fatalf("scheme state = %q err=%v, want http", data, err)
|
||||
}
|
||||
plainResp, err := plain.Get("http://" + addr + "/library")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer func() { _ = plainResp.Body.Close() }()
|
||||
plainBody, err := io.ReadAll(plainResp.Body)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if plainResp.StatusCode != http.StatusOK || string(plainBody) != "secure:/library" {
|
||||
t.Fatalf("plain response after disabling https = %d %q", plainResp.StatusCode, plainBody)
|
||||
}
|
||||
}
|
||||
@@ -1,46 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"database/sql"
|
||||
"runtime"
|
||||
"time"
|
||||
|
||||
"go.uber.org/zap"
|
||||
|
||||
"github.com/truewhile/MeBox/internal/config"
|
||||
)
|
||||
|
||||
func applyCPUThreadLimit(cfg *config.Config, logger *zap.Logger) {
|
||||
if cfg == nil || cfg.App.MaxCPUThreads < 1 {
|
||||
return
|
||||
}
|
||||
prev := runtime.GOMAXPROCS(cfg.App.MaxCPUThreads)
|
||||
if logger != nil {
|
||||
logger.Info("runtime CPU thread limit applied",
|
||||
zap.Int("max_cpu_threads", cfg.App.MaxCPUThreads),
|
||||
zap.Int("previous", prev))
|
||||
}
|
||||
}
|
||||
|
||||
func waitForDatabase(db interface{ DB() (*sql.DB, error) }, logger *zap.Logger) error {
|
||||
sqlDB, err := db.DB()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
var lastErr error
|
||||
for attempt := 1; attempt <= 30; attempt++ {
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 3*time.Second)
|
||||
err = sqlDB.PingContext(ctx)
|
||||
cancel()
|
||||
if err == nil {
|
||||
return nil
|
||||
}
|
||||
lastErr = err
|
||||
if logger != nil {
|
||||
logger.Warn("database not ready; retrying", zap.Int("attempt", attempt), zap.Error(err))
|
||||
}
|
||||
time.Sleep(time.Duration(attempt) * 500 * time.Millisecond)
|
||||
}
|
||||
return lastErr
|
||||
}
|
||||
@@ -1,28 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
|
||||
<assembly xmlns="urn:schemas-microsoft-com:asm.v1" manifestVersion="1.0">
|
||||
<assemblyIdentity
|
||||
version="1.0.0.0"
|
||||
processorArchitecture="*"
|
||||
name="MeBox"
|
||||
type="win32"
|
||||
/>
|
||||
<description>MeBox media server</description>
|
||||
<trustInfo xmlns="urn:schemas-microsoft-com:asm.v3">
|
||||
<security>
|
||||
<requestedPrivileges>
|
||||
<requestedExecutionLevel level="asInvoker" uiAccess="false" />
|
||||
</requestedPrivileges>
|
||||
</security>
|
||||
</trustInfo>
|
||||
<compatibility xmlns="urn:schemas-microsoft-com:compatibility.v1">
|
||||
<application>
|
||||
<supportedOS Id="{8e0f7a12-bfb3-4fe8-b9a5-48fd50a15a9a}" />
|
||||
</application>
|
||||
</compatibility>
|
||||
<application xmlns="urn:schemas-microsoft-com:asm.v3">
|
||||
<windowsSettings>
|
||||
<dpiAware xmlns="http://schemas.microsoft.com/SMI/2005/WindowsSettings">true/pm</dpiAware>
|
||||
<longPathAware xmlns="http://schemas.microsoft.com/SMI/2016/WindowsSettings">true</longPathAware>
|
||||
</windowsSettings>
|
||||
</application>
|
||||
</assembly>
|
||||
Vendored
-26
@@ -1,26 +0,0 @@
|
||||
<!doctype html>
|
||||
<html lang="zh-CN">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<meta name="theme-color" content="#faf8f5" />
|
||||
<meta name="description" content="MeBox — 个人家庭媒体中心" />
|
||||
<link rel="icon" type="image/png" href="/brand/logo-64.png" />
|
||||
<link rel="icon" type="image/x-icon" href="/favicon.ico" />
|
||||
<link rel="apple-touch-icon" href="/brand/logo-192.png" />
|
||||
<!-- 字体已自托管(见 src/index.css 的 @font-face),不再使用 Google Fonts 外链:
|
||||
自托管环境常无法访问 Google,渲染阻塞外链会拖慢首屏。 -->
|
||||
<title>MeBox</title>
|
||||
<script type="module" crossorigin src="/assets/index-CcRvbC_F.js"></script>
|
||||
<link rel="modulepreload" crossorigin href="/assets/rolldown-runtime-B0Z9INg1.js">
|
||||
<link rel="modulepreload" crossorigin href="/assets/vendor-data-CD8zvwOM.js">
|
||||
<link rel="modulepreload" crossorigin href="/assets/vendor-react-Cz-iIQjW.js">
|
||||
<link rel="modulepreload" crossorigin href="/assets/vendor-motion-FEuwvkVZ.js">
|
||||
<link rel="modulepreload" crossorigin href="/assets/auth-D3Hf5Dnr.js">
|
||||
<link rel="modulepreload" crossorigin href="/assets/createLucideIcon-nIJoh1kU.js">
|
||||
<link rel="stylesheet" crossorigin href="/assets/index-BPz3c5Oc.css">
|
||||
</head>
|
||||
<body class="font-body antialiased">
|
||||
<div id="root"></div>
|
||||
|
||||
</body>
|
||||
@@ -1,218 +0,0 @@
|
||||
# MeBox + MetaTube 一体部署 Docker Compose 部署文件
|
||||
#
|
||||
# 组件:
|
||||
# MeBox + PostgreSQL + Redis + MetaTube
|
||||
#
|
||||
# 与 docker-compose.standard.yml 的区别:
|
||||
# 额外内置一个 MetaTube 后端(番号元数据刮削 / 封面人脸裁剪),
|
||||
# 并与 MeBox 共用同一个 PostgreSQL 实例,不需要再单独起一套数据库。
|
||||
#
|
||||
# 使用方式二选一:
|
||||
# 1. 保存为 docker-compose.yml 后执行:
|
||||
# docker compose up -d
|
||||
# 2. 保留本文件名时执行:
|
||||
# docker compose -f docker-compose.metatube.yml up -d
|
||||
#
|
||||
# 首次启动后需要做一次配置(只有这一处是手动的):
|
||||
# 登录 MeBox → 设置 → 番号刮削:
|
||||
# - 番号刮削引擎:MetaTube 后端服务,或 智能混合
|
||||
# - MetaTube 服务端地址:http://metatube:8080
|
||||
# - 访问 Token:留空(仅内部网络,未启用认证;如需认证两边填同一个值)
|
||||
#
|
||||
# 说明:
|
||||
# - MetaTube 使用独立数据库 metatube,由 metatube-db-init 一次性容器自动创建;
|
||||
# 和 MeBox 的 mebox 库共用同一个 PostgreSQL 实例,只是分成两个库。
|
||||
# - MetaTube 不向宿主机映射端口,只在本 Compose 内部网络提供服务。
|
||||
# - MeBox 故意不依赖 MetaTube:MetaTube 未就绪或挂掉时,智能混合模式会自动回退到内置刮削源。
|
||||
# - 更新全部组件:
|
||||
# docker compose -f docker-compose.metatube.yml pull
|
||||
# docker compose -f docker-compose.metatube.yml up -d
|
||||
# 保留本文件名时,管理面板「系统更新」需要把「Compose 安装目录」指向本文件所在目录,
|
||||
# 或把更新命令改成带 -f docker-compose.metatube.yml 的形式。
|
||||
#
|
||||
# 默认账号:
|
||||
# admin / admin123
|
||||
|
||||
services:
|
||||
mebox:
|
||||
image: ghcr.io/truewhile/mebox:latest
|
||||
|
||||
restart: unless-stopped
|
||||
init: true
|
||||
depends_on:
|
||||
postgres:
|
||||
condition: service_healthy
|
||||
redis:
|
||||
condition: service_healthy
|
||||
|
||||
ports:
|
||||
- "18080:8080"
|
||||
|
||||
extra_hosts:
|
||||
- "host.docker.internal:host-gateway"
|
||||
|
||||
volumes:
|
||||
# 程序运行数据:JWT 密钥、运行配置、旧 SQLite 迁移源。
|
||||
- ./data:/data
|
||||
|
||||
# 缓存目录:海报缓存、临时文件等。通常不用备份。
|
||||
- ./cache:/cache
|
||||
|
||||
# 媒体库目录。自动整理/重命名/入库需要读写权限。
|
||||
# NAS 示例:source: /vol1/1000/Media
|
||||
# Windows Docker Desktop 示例:source: D:/Media
|
||||
# create_host_path=false 可以避免路径写错时 Docker 自动创建空文件夹。
|
||||
- ./media:/media
|
||||
|
||||
environment:
|
||||
TZ: Asia/Shanghai
|
||||
|
||||
PUID: "0"
|
||||
PGID: "0"
|
||||
|
||||
MEBOX_APP_HOST: 0.0.0.0
|
||||
MEBOX_APP_PORT: 8080
|
||||
MEBOX_APP_WEB_DIR: /app/web/dist
|
||||
MEBOX_APP_DATA_DIR: /data
|
||||
MEBOX_LOGGING_LEVEL: info
|
||||
MEBOX_LOGGING_FORMAT: console
|
||||
MEBOX_LOGGING_OUTPUT_PATH: /data/logs
|
||||
MEBOX_LOGGING_MAX_SIZE_MB: "20"
|
||||
MEBOX_LOGGING_MAX_BACKUPS: "5"
|
||||
MEBOX_LOGGING_MAX_AGE_DAYS: "30"
|
||||
|
||||
MEBOX_DATABASE_TYPE: postgres
|
||||
MEBOX_DATABASE_DSN: postgres://mebox:mebox@postgres:5432/mebox?sslmode=disable
|
||||
MEBOX_DATABASE_DB_PATH: /data/mebox.db
|
||||
|
||||
# Redis 只做热缓存,源数据仍在 PostgreSQL;Redis 丢失可自动重建。
|
||||
MEBOX_CACHE_REDIS_URL: redis://redis:6379/0
|
||||
MEBOX_CACHE_CACHE_DIR: /cache
|
||||
|
||||
MEBOX_UPDATE_IMAGE: ghcr.io/truewhile/mebox:latest
|
||||
|
||||
# 路径换算配置。左边宿主机真实路径要和 volumes 左边保持一致。
|
||||
MEBOX_MEDIA_DIR: /media
|
||||
MEBOX_MEDIA_CONTAINER_DIR: /media
|
||||
MEBOX_DOWNLOAD_DIR: /downloads
|
||||
MEBOX_DOWNLOAD_CONTAINER_DIR: /downloads
|
||||
|
||||
MEBOX_TRANSCODER_ENABLED: "true"
|
||||
MEBOX_TRANSCODER_HARDWARE_ACCEL: "false"
|
||||
MEBOX_TRANSCODER_REALTIME: "true"
|
||||
MEBOX_TRANSCODER_THREADS: "2"
|
||||
MEBOX_TRANSCODER_MAX_CONCURRENT: "1"
|
||||
MEBOX_TRANSCODER_IDLE_TIMEOUT_SECONDS: "120"
|
||||
|
||||
healthcheck:
|
||||
# 不能写死 http://:开启 HTTPS 后 8080 只接受 TLS,固定明文探测会
|
||||
# 每轮刷一条 TLS handshake error 并让容器一直 unhealthy。
|
||||
test: ["CMD", "/usr/local/bin/mebox-healthcheck"]
|
||||
interval: 30s
|
||||
timeout: 10s
|
||||
retries: 5
|
||||
start_period: 30s
|
||||
|
||||
logging:
|
||||
driver: json-file
|
||||
options:
|
||||
max-size: "20m"
|
||||
max-file: "3"
|
||||
|
||||
postgres:
|
||||
image: postgres:16-alpine
|
||||
# 首次部署允许拉取;日常更新请只 pull mebox。
|
||||
# MetaTube 与 MeBox 共用本实例(不同数据库),无需第二套 PostgreSQL。
|
||||
pull_policy: missing
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
POSTGRES_DB: mebox
|
||||
POSTGRES_USER: mebox
|
||||
POSTGRES_PASSWORD: mebox
|
||||
TZ: Asia/Shanghai
|
||||
volumes:
|
||||
# 同时存放 mebox 与 metatube 两个数据库,备份这一个目录即可。
|
||||
- ./postgres:/var/lib/postgresql/data
|
||||
healthcheck:
|
||||
test: ["CMD-SHELL", "pg_isready -h 127.0.0.1 -U mebox -d mebox"]
|
||||
interval: 10s
|
||||
timeout: 5s
|
||||
retries: 10
|
||||
logging:
|
||||
driver: json-file
|
||||
options:
|
||||
max-size: "20m"
|
||||
max-file: "3"
|
||||
|
||||
# 一次性容器:确保 metatube 库存在。
|
||||
# MetaTube 自己的 -db-auto-migrate 只建表不建库,所以必须先建库。
|
||||
# 数据库已存在时它会直接退出,重复执行无副作用。
|
||||
metatube-db-init:
|
||||
image: postgres:16-alpine
|
||||
pull_policy: missing
|
||||
restart: "no"
|
||||
depends_on:
|
||||
postgres:
|
||||
condition: service_healthy
|
||||
environment:
|
||||
PGPASSWORD: mebox
|
||||
entrypoint: ["/bin/sh", "-c"]
|
||||
command:
|
||||
- |
|
||||
psql -h postgres -U mebox -d mebox -tAc "SELECT 1 FROM pg_database WHERE datname='metatube'" | grep -q 1 || psql -h postgres -U mebox -d mebox -c "CREATE DATABASE metatube OWNER mebox"
|
||||
logging:
|
||||
driver: json-file
|
||||
options:
|
||||
max-size: "5m"
|
||||
max-file: "1"
|
||||
|
||||
metatube:
|
||||
image: ghcr.io/metatube-community/metatube-server:latest
|
||||
restart: unless-stopped
|
||||
depends_on:
|
||||
metatube-db-init:
|
||||
condition: service_completed_successfully
|
||||
environment:
|
||||
TZ: Asia/Shanghai
|
||||
# 需要走代理时在这里填写,例如 http://192.168.1.2:7890
|
||||
HTTP_PROXY: ""
|
||||
HTTPS_PROXY: ""
|
||||
# 不需要 ports:MeBox 通过内部网络访问 http://metatube:8080。
|
||||
# 只有想让局域网内其他工具直连时才映射,且建议只映射到 127.0.0.1。
|
||||
command:
|
||||
- -dsn
|
||||
- postgres://mebox:mebox@postgres:5432/metatube?sslmode=disable
|
||||
- -port
|
||||
- "8080"
|
||||
- -db-auto-migrate
|
||||
- -db-prepared-stmt
|
||||
logging:
|
||||
driver: json-file
|
||||
options:
|
||||
max-size: "20m"
|
||||
max-file: "3"
|
||||
|
||||
redis:
|
||||
image: redis:7-alpine
|
||||
pull_policy: missing
|
||||
restart: unless-stopped
|
||||
command:
|
||||
- redis-server
|
||||
- --appendonly
|
||||
- "yes"
|
||||
- --maxmemory
|
||||
- 256mb
|
||||
- --maxmemory-policy
|
||||
- allkeys-lru
|
||||
volumes:
|
||||
- ./redis:/data
|
||||
healthcheck:
|
||||
test: ["CMD", "redis-cli", "ping"]
|
||||
interval: 10s
|
||||
timeout: 5s
|
||||
retries: 10
|
||||
logging:
|
||||
driver: json-file
|
||||
options:
|
||||
max-size: "20m"
|
||||
max-file: "3"
|
||||
@@ -1,202 +0,0 @@
|
||||
# MeBox 第三档完整 Docker Compose 部署文件
|
||||
#
|
||||
# 组件:
|
||||
# MeBox + PostgreSQL + Redis + OpenSearch
|
||||
#
|
||||
# 使用方式二选一:
|
||||
# 1. 保存为 docker-compose.yml 后执行:
|
||||
# docker compose up -d
|
||||
# 2. 保留本文件名时执行:
|
||||
# docker compose -f docker-compose.search.yml up -d
|
||||
#
|
||||
# 适合:
|
||||
# 超大媒体库、复杂全文搜索、后续需要独立搜索索引的部署。
|
||||
#
|
||||
# 注意:
|
||||
# OpenSearch 常驻内存明显高于 Redis/PostgreSQL。低配 NAS 不建议开启。
|
||||
#
|
||||
# 默认账号:
|
||||
# admin / admin123
|
||||
|
||||
services:
|
||||
mebox:
|
||||
image: ghcr.io/truewhile/mebox:latest
|
||||
|
||||
restart: unless-stopped
|
||||
init: true
|
||||
depends_on:
|
||||
postgres:
|
||||
condition: service_healthy
|
||||
redis:
|
||||
condition: service_healthy
|
||||
opensearch:
|
||||
condition: service_healthy
|
||||
|
||||
ports:
|
||||
- "18080:8080"
|
||||
|
||||
extra_hosts:
|
||||
- "host.docker.internal:host-gateway"
|
||||
|
||||
volumes:
|
||||
# 程序运行数据:JWT 密钥、运行配置、旧 SQLite 迁移源。
|
||||
- ./data:/data
|
||||
|
||||
# 缓存目录:海报缓存、临时文件等。通常不用备份。
|
||||
- ./cache:/cache
|
||||
|
||||
# 媒体库目录。自动整理/重命名/入库需要读写权限。
|
||||
# NAS 示例:source: /vol1/1000/Media
|
||||
# Windows Docker Desktop 示例:source: D:/Media
|
||||
# create_host_path=false 可以避免路径写错时 Docker 自动创建空文件夹。
|
||||
- type: bind
|
||||
source: ./media
|
||||
target: /media
|
||||
bind:
|
||||
create_host_path: false
|
||||
|
||||
# 下载目录。需要和下载器保存路径保持一致。
|
||||
# NAS 示例:source: /vol1/1000/Downloads
|
||||
# Windows Docker Desktop 示例:source: D:/Downloads
|
||||
- type: bind
|
||||
source: ./downloads
|
||||
target: /downloads
|
||||
bind:
|
||||
create_host_path: false
|
||||
|
||||
# 管理面板「系统更新」需要访问 Docker 引擎。
|
||||
# 需要一键更新 Docker 镜像时取消下一行注释。
|
||||
# - /var/run/docker.sock:/var/run/docker.sock
|
||||
|
||||
environment:
|
||||
TZ: Asia/Shanghai
|
||||
|
||||
PUID: "1000"
|
||||
PGID: "1000"
|
||||
|
||||
MEBOX_APP_HOST: 0.0.0.0
|
||||
MEBOX_APP_PORT: 8080
|
||||
MEBOX_APP_WEB_DIR: /app/web/dist
|
||||
MEBOX_APP_DATA_DIR: /data
|
||||
MEBOX_LOGGING_LEVEL: info
|
||||
MEBOX_LOGGING_FORMAT: console
|
||||
MEBOX_LOGGING_OUTPUT_PATH: /data/logs
|
||||
MEBOX_LOGGING_MAX_SIZE_MB: "20"
|
||||
MEBOX_LOGGING_MAX_BACKUPS: "5"
|
||||
MEBOX_LOGGING_MAX_AGE_DAYS: "30"
|
||||
|
||||
MEBOX_DATABASE_TYPE: postgres
|
||||
MEBOX_DATABASE_DSN: postgres://mebox:mebox@postgres:5432/mebox?sslmode=disable
|
||||
MEBOX_DATABASE_DB_PATH: /data/mebox.db
|
||||
|
||||
MEBOX_CACHE_REDIS_URL: redis://redis:6379/0
|
||||
MEBOX_CACHE_CACHE_DIR: /cache
|
||||
|
||||
# OpenSearch 只做搜索索引,主数据仍以 PostgreSQL 为准。
|
||||
MEBOX_SEARCH_BACKEND: opensearch
|
||||
MEBOX_SEARCH_OPENSEARCH_URL: http://opensearch:9200
|
||||
MEBOX_SEARCH_INDEX: mebox_media
|
||||
|
||||
MEBOX_UPDATE_IMAGE: ghcr.io/truewhile/mebox:latest
|
||||
|
||||
# 默认推荐在网页里使用容器路径 /media。
|
||||
# 如果旧媒体库已经保存了宿主机路径 /vol1/1000/Media,
|
||||
# 再把这里改成同一个宿主机真实路径用于旧路径换算。
|
||||
MEBOX_MEDIA_DIR: /media
|
||||
MEBOX_MEDIA_CONTAINER_DIR: /media
|
||||
MEBOX_DOWNLOAD_DIR: /downloads
|
||||
MEBOX_DOWNLOAD_CONTAINER_DIR: /downloads
|
||||
|
||||
MEBOX_TRANSCODER_ENABLED: "true"
|
||||
MEBOX_TRANSCODER_HARDWARE_ACCEL: "false"
|
||||
MEBOX_TRANSCODER_REALTIME: "true"
|
||||
MEBOX_TRANSCODER_THREADS: "2"
|
||||
MEBOX_TRANSCODER_MAX_CONCURRENT: "1"
|
||||
MEBOX_TRANSCODER_IDLE_TIMEOUT_SECONDS: "120"
|
||||
|
||||
healthcheck:
|
||||
# 不能写死 http://:开启 HTTPS 后 8080 只接受 TLS,固定明文探测会
|
||||
# 每轮刷一条 TLS handshake error 并让容器一直 unhealthy。
|
||||
test: ["CMD", "/usr/local/bin/mebox-healthcheck"]
|
||||
interval: 30s
|
||||
timeout: 10s
|
||||
retries: 5
|
||||
start_period: 30s
|
||||
|
||||
logging:
|
||||
driver: json-file
|
||||
options:
|
||||
max-size: "20m"
|
||||
max-file: "3"
|
||||
|
||||
postgres:
|
||||
image: postgres:16-alpine
|
||||
# 首次部署允许拉取;日常更新请只 pull mebox。
|
||||
pull_policy: missing
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
POSTGRES_DB: mebox
|
||||
POSTGRES_USER: mebox
|
||||
POSTGRES_PASSWORD: mebox
|
||||
TZ: Asia/Shanghai
|
||||
volumes:
|
||||
- ./postgres:/var/lib/postgresql/data
|
||||
healthcheck:
|
||||
test: ["CMD-SHELL", "pg_isready -h 127.0.0.1 -U mebox -d mebox"]
|
||||
interval: 10s
|
||||
timeout: 5s
|
||||
retries: 10
|
||||
logging:
|
||||
driver: json-file
|
||||
options:
|
||||
max-size: "20m"
|
||||
max-file: "3"
|
||||
|
||||
redis:
|
||||
image: redis:7-alpine
|
||||
pull_policy: missing
|
||||
restart: unless-stopped
|
||||
command:
|
||||
- redis-server
|
||||
- --appendonly
|
||||
- "yes"
|
||||
- --maxmemory
|
||||
- 256mb
|
||||
- --maxmemory-policy
|
||||
- allkeys-lru
|
||||
volumes:
|
||||
- ./redis:/data
|
||||
healthcheck:
|
||||
test: ["CMD", "redis-cli", "ping"]
|
||||
interval: 10s
|
||||
timeout: 5s
|
||||
retries: 10
|
||||
logging:
|
||||
driver: json-file
|
||||
options:
|
||||
max-size: "20m"
|
||||
max-file: "3"
|
||||
|
||||
opensearch:
|
||||
image: opensearchproject/opensearch:2
|
||||
pull_policy: missing
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
discovery.type: single-node
|
||||
plugins.security.disabled: "true"
|
||||
OPENSEARCH_JAVA_OPTS: "-Xms512m -Xmx512m"
|
||||
DISABLE_INSTALL_DEMO_CONFIG: "true"
|
||||
bootstrap.memory_lock: "false"
|
||||
volumes:
|
||||
- ./opensearch:/usr/share/opensearch/data
|
||||
healthcheck:
|
||||
test: ["CMD-SHELL", "curl -fsS http://127.0.0.1:9200 >/dev/null || exit 1"]
|
||||
interval: 20s
|
||||
timeout: 10s
|
||||
retries: 15
|
||||
start_period: 60s
|
||||
logging:
|
||||
driver: json-file
|
||||
options:
|
||||
max-size: "20m"
|
||||
max-file: "3"
|
||||
@@ -1,88 +0,0 @@
|
||||
# MeBox 单镜像部署模板(SQLite)
|
||||
#
|
||||
# 适合:新手、单人使用、低配 NAS / 小主机。
|
||||
# 特点:只有一个镜像,不需要 PostgreSQL / Redis / .env。
|
||||
#
|
||||
# 使用:
|
||||
# 1. 按需修改 ports 和 volumes 左侧的宿主机目录。
|
||||
# 2. docker compose -f docker-compose.simple.yml up -d
|
||||
# 3. 浏览器打开 http://服务器IP:18080
|
||||
#
|
||||
# 默认账号:admin / admin123
|
||||
# 首次登录后请立刻修改密码。
|
||||
|
||||
services:
|
||||
mebox:
|
||||
image: ghcr.io/truewhile/mebox:latest
|
||||
|
||||
container_name: mebox
|
||||
restart: unless-stopped
|
||||
init: true
|
||||
|
||||
ports:
|
||||
# 左边是宿主机访问端口,右边固定为容器内 8080。
|
||||
- "18080:8080"
|
||||
|
||||
volumes:
|
||||
# 必须备份:SQLite 数据库、系统配置、JWT 密钥、日志。
|
||||
- ./data:/data
|
||||
|
||||
# 可重建:海报缓存、临时文件、转码缓存。
|
||||
- ./cache:/cache
|
||||
|
||||
# 媒体库。网页里添加媒体库时填写 /media 或 /media/子目录。
|
||||
- ./media:/media
|
||||
|
||||
# 可选:Intel 核显硬解/转码。需要时取消注释,并在后台开启硬件加速。
|
||||
# - /dev/dri:/dev/dri
|
||||
|
||||
# 可选:管理面板一键更新需要访问 Docker 引擎。需要时取消注释。
|
||||
# - /var/run/docker.sock:/var/run/docker.sock
|
||||
|
||||
environment:
|
||||
TZ: Asia/Shanghai
|
||||
|
||||
# Linux/NAS 文件权限。写入文件权限异常时,改成宿主机实际 uid/gid。
|
||||
PUID: "0"
|
||||
PGID: "0"
|
||||
|
||||
MEBOX_APP_HOST: 0.0.0.0
|
||||
MEBOX_APP_PORT: 8080
|
||||
MEBOX_APP_WEB_DIR: /app/web/dist
|
||||
MEBOX_APP_DATA_DIR: /data
|
||||
|
||||
# 单镜像档固定使用 SQLite。主数据库文件:./data/mebox.db。
|
||||
MEBOX_DATABASE_TYPE: sqlite
|
||||
MEBOX_DATABASE_DB_PATH: /data/mebox.db
|
||||
MEBOX_CACHE_CACHE_DIR: /cache
|
||||
|
||||
# 路径映射保持容器内统一,网页和下载器里优先使用 /media、/downloads。
|
||||
MEBOX_MEDIA_DIR: /media
|
||||
MEBOX_MEDIA_CONTAINER_DIR: /media
|
||||
|
||||
# 完整应用日志默认写入 ./data/logs/app.log;排查复杂问题时可临时改成 debug。
|
||||
MEBOX_LOGGING_LEVEL: info
|
||||
MEBOX_LOGGING_FORMAT: console
|
||||
MEBOX_LOGGING_OUTPUT_PATH: /data/logs
|
||||
MEBOX_LOGGING_MAX_SIZE_MB: "20"
|
||||
MEBOX_LOGGING_MAX_BACKUPS: "5"
|
||||
MEBOX_LOGGING_MAX_AGE_DAYS: "30"
|
||||
|
||||
extra_hosts:
|
||||
# 容器访问宿主机服务(如下载器等)用: http://host.docker.internal:8085
|
||||
- "host.docker.internal:host-gateway"
|
||||
|
||||
healthcheck:
|
||||
# 不能写死 http://:开启 HTTPS 后 8080 只接受 TLS,固定明文探测会
|
||||
# 每轮刷一条 TLS handshake error 并让容器一直 unhealthy。
|
||||
test: ["CMD", "/usr/local/bin/mebox-healthcheck"]
|
||||
interval: 30s
|
||||
timeout: 10s
|
||||
retries: 5
|
||||
start_period: 30s
|
||||
|
||||
logging:
|
||||
driver: json-file
|
||||
options:
|
||||
max-size: "20m"
|
||||
max-file: "3"
|
||||
@@ -1,150 +0,0 @@
|
||||
# MeBox 第二档完整 Docker Compose 部署文件
|
||||
#
|
||||
# 组件:
|
||||
# MeBox + PostgreSQL + Redis
|
||||
#
|
||||
# 使用方式二选一:
|
||||
# 1. 保存为 docker-compose.yml 后执行:
|
||||
# docker compose up -d
|
||||
# 2. 保留本文件名时执行:
|
||||
# docker compose -f docker-compose.standard.yml up -d
|
||||
#
|
||||
# 适合:
|
||||
# 多用户、第三方 Emby 客户端频繁刷新、媒体列表/首页访问较多的 NAS。
|
||||
#
|
||||
# 默认账号:
|
||||
# admin / admin123
|
||||
|
||||
services:
|
||||
mebox:
|
||||
image: ghcr.io/truewhile/mebox:latest
|
||||
|
||||
restart: unless-stopped
|
||||
init: true
|
||||
depends_on:
|
||||
postgres:
|
||||
condition: service_healthy
|
||||
redis:
|
||||
condition: service_healthy
|
||||
|
||||
ports:
|
||||
- "18080:8080"
|
||||
|
||||
extra_hosts:
|
||||
- "host.docker.internal:host-gateway"
|
||||
|
||||
volumes:
|
||||
# 程序运行数据:JWT 密钥、运行配置、旧 SQLite 迁移源。
|
||||
- ./data:/data
|
||||
|
||||
# 缓存目录:海报缓存、临时文件等。通常不用备份。
|
||||
- ./cache:/cache
|
||||
|
||||
# 媒体库目录。自动整理/重命名/入库需要读写权限。
|
||||
# NAS 示例:source: /vol1/1000/Media
|
||||
# Windows Docker Desktop 示例:source: D:/Media
|
||||
# create_host_path=false 可以避免路径写错时 Docker 自动创建空文件夹。
|
||||
- ./media:/media
|
||||
|
||||
environment:
|
||||
TZ: Asia/Shanghai
|
||||
|
||||
PUID: "0"
|
||||
PGID: "0"
|
||||
|
||||
MEBOX_APP_HOST: 0.0.0.0
|
||||
MEBOX_APP_PORT: 8080
|
||||
MEBOX_APP_WEB_DIR: /app/web/dist
|
||||
MEBOX_APP_DATA_DIR: /data
|
||||
MEBOX_LOGGING_LEVEL: info
|
||||
MEBOX_LOGGING_FORMAT: console
|
||||
MEBOX_LOGGING_OUTPUT_PATH: /data/logs
|
||||
MEBOX_LOGGING_MAX_SIZE_MB: "20"
|
||||
MEBOX_LOGGING_MAX_BACKUPS: "5"
|
||||
MEBOX_LOGGING_MAX_AGE_DAYS: "30"
|
||||
|
||||
MEBOX_DATABASE_TYPE: postgres
|
||||
MEBOX_DATABASE_DSN: postgres://mebox:mebox@postgres:5432/mebox?sslmode=disable
|
||||
MEBOX_DATABASE_DB_PATH: /data/mebox.db
|
||||
|
||||
# Redis 只做热缓存,源数据仍在 PostgreSQL;Redis 丢失可自动重建。
|
||||
MEBOX_CACHE_REDIS_URL: redis://redis:6379/0
|
||||
MEBOX_CACHE_CACHE_DIR: /cache
|
||||
|
||||
MEBOX_UPDATE_IMAGE: ghcr.io/truewhile/mebox:latest
|
||||
|
||||
# 路径换算配置。左边宿主机真实路径要和 volumes 左边保持一致。
|
||||
MEBOX_MEDIA_DIR: /media
|
||||
MEBOX_MEDIA_CONTAINER_DIR: /media
|
||||
MEBOX_DOWNLOAD_DIR: /downloads
|
||||
MEBOX_DOWNLOAD_CONTAINER_DIR: /downloads
|
||||
|
||||
MEBOX_TRANSCODER_ENABLED: "true"
|
||||
MEBOX_TRANSCODER_HARDWARE_ACCEL: "false"
|
||||
MEBOX_TRANSCODER_REALTIME: "true"
|
||||
MEBOX_TRANSCODER_THREADS: "2"
|
||||
MEBOX_TRANSCODER_MAX_CONCURRENT: "1"
|
||||
MEBOX_TRANSCODER_IDLE_TIMEOUT_SECONDS: "120"
|
||||
|
||||
healthcheck:
|
||||
# 不能写死 http://:开启 HTTPS 后 8080 只接受 TLS,固定明文探测会
|
||||
# 每轮刷一条 TLS handshake error 并让容器一直 unhealthy。
|
||||
test: ["CMD", "/usr/local/bin/mebox-healthcheck"]
|
||||
interval: 30s
|
||||
timeout: 10s
|
||||
retries: 5
|
||||
start_period: 30s
|
||||
|
||||
logging:
|
||||
driver: json-file
|
||||
options:
|
||||
max-size: "20m"
|
||||
max-file: "3"
|
||||
|
||||
postgres:
|
||||
image: postgres:16-alpine
|
||||
# 首次部署允许拉取;日常更新请只 pull mebox。
|
||||
pull_policy: missing
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
POSTGRES_DB: mebox
|
||||
POSTGRES_USER: mebox
|
||||
POSTGRES_PASSWORD: mebox
|
||||
TZ: Asia/Shanghai
|
||||
volumes:
|
||||
- ./postgres:/var/lib/postgresql/data
|
||||
healthcheck:
|
||||
test: ["CMD-SHELL", "pg_isready -h 127.0.0.1 -U mebox -d mebox"]
|
||||
interval: 10s
|
||||
timeout: 5s
|
||||
retries: 10
|
||||
logging:
|
||||
driver: json-file
|
||||
options:
|
||||
max-size: "20m"
|
||||
max-file: "3"
|
||||
|
||||
redis:
|
||||
image: redis:7-alpine
|
||||
pull_policy: missing
|
||||
restart: unless-stopped
|
||||
command:
|
||||
- redis-server
|
||||
- --appendonly
|
||||
- "yes"
|
||||
- --maxmemory
|
||||
- 256mb
|
||||
- --maxmemory-policy
|
||||
- allkeys-lru
|
||||
volumes:
|
||||
- ./redis:/data
|
||||
healthcheck:
|
||||
test: ["CMD", "redis-cli", "ping"]
|
||||
interval: 10s
|
||||
timeout: 5s
|
||||
retries: 10
|
||||
logging:
|
||||
driver: json-file
|
||||
options:
|
||||
max-size: "20m"
|
||||
max-file: "3"
|
||||
@@ -1,172 +0,0 @@
|
||||
# MeBox 最简单 Docker Compose 部署文件
|
||||
#
|
||||
# 新手建议:
|
||||
# 1. 不用 .env。
|
||||
# 2. 直接改本文件。
|
||||
# 3. 第一次可以不改路径,先用当前目录下的 ./media 和 ./downloads 体验。
|
||||
#
|
||||
# 启动:
|
||||
# docker compose up -d
|
||||
#
|
||||
# 访问:
|
||||
# http://服务器IP:18080
|
||||
#
|
||||
# 默认账号:
|
||||
# admin / admin123
|
||||
|
||||
services:
|
||||
mebox:
|
||||
image: ghcr.io/truewhile/mebox:latest
|
||||
|
||||
restart: unless-stopped
|
||||
init: true
|
||||
depends_on:
|
||||
postgres:
|
||||
condition: service_healthy
|
||||
|
||||
# 浏览器访问端口。
|
||||
# 如果 18080 被占用,可以改成 "19011:8080" 之类。
|
||||
ports:
|
||||
- "18080:8080"
|
||||
|
||||
# 让容器可以访问宿主机上的服务(如下载器)。
|
||||
# qB 地址通常可填:http://host.docker.internal:8085
|
||||
extra_hosts:
|
||||
- "host.docker.internal:host-gateway"
|
||||
|
||||
volumes:
|
||||
# 程序运行数据:JWT 密钥、运行配置、旧 SQLite 迁移源。
|
||||
# 主数据库在 ./postgres,升级/备份时 ./data 和 ./postgres 都要保留。
|
||||
- ./data:/data
|
||||
|
||||
# 缓存目录:海报缓存、临时文件等。通常不用备份。
|
||||
- ./cache:/cache
|
||||
|
||||
# 媒体库目录。
|
||||
# 如果要使用自动整理/重命名/入库,这里必须保持读写,不能加 :ro。
|
||||
# 只有完全不整理、只扫描/播放已有媒体时,才建议手动改成只读。
|
||||
# 新手可先创建当前目录的 ./media 并把影片放进去。
|
||||
# NAS 用户把左边改成真实路径,例如:
|
||||
# source: /vol1/1000/Media
|
||||
# Windows Docker Desktop 示例:
|
||||
# source: D:/Media
|
||||
# create_host_path=false 可以避免路径写错时 Docker 自动创建空文件夹。
|
||||
- type: bind
|
||||
source: ./media
|
||||
target: /media
|
||||
bind:
|
||||
create_host_path: false
|
||||
|
||||
# 下载目录。
|
||||
# qB 下载目录、手动整理、自动整理会经常用到。
|
||||
# NAS 示例:
|
||||
# source: /vol1/1000/Downloads
|
||||
# Windows Docker Desktop 示例:
|
||||
# source: D:/Downloads
|
||||
- type: bind
|
||||
source: ./downloads
|
||||
target: /downloads
|
||||
bind:
|
||||
create_host_path: false
|
||||
|
||||
# 管理面板「系统更新」需要访问 Docker 引擎。
|
||||
# 需要一键更新 Docker 镜像时取消下一行注释;如果提示权限不足,
|
||||
# 请确认 PUID/PGID 对 /var/run/docker.sock 有读写权限。
|
||||
# - /var/run/docker.sock:/var/run/docker.sock
|
||||
|
||||
environment:
|
||||
TZ: Asia/Shanghai
|
||||
|
||||
# Linux/NAS 用户权限。一般 1000 就可以。
|
||||
# 如果写入文件权限不对,再改成宿主机实际用户的 uid/gid。
|
||||
PUID: "1000"
|
||||
PGID: "1000"
|
||||
|
||||
# 程序基础配置,通常不用改。
|
||||
MEBOX_APP_HOST: 0.0.0.0
|
||||
MEBOX_APP_PORT: 8080
|
||||
MEBOX_APP_WEB_DIR: /app/web/dist
|
||||
MEBOX_APP_DATA_DIR: /data
|
||||
# 详细应用日志会保存在 ./data/logs/app.log,warn/error 也会拆分保存。
|
||||
# 排查复杂问题时可临时改成 debug。
|
||||
MEBOX_LOGGING_LEVEL: info
|
||||
MEBOX_LOGGING_FORMAT: console
|
||||
MEBOX_LOGGING_OUTPUT_PATH: /data/logs
|
||||
MEBOX_LOGGING_MAX_SIZE_MB: "20"
|
||||
MEBOX_LOGGING_MAX_BACKUPS: "5"
|
||||
MEBOX_LOGGING_MAX_AGE_DAYS: "30"
|
||||
|
||||
# 轻量模式默认只使用 PostgreSQL,适合大多数 NAS。
|
||||
# 旧版 ./data/mmtl.db 或 ./data/mebox.db 存在时,首次启动会自动迁移到 PostgreSQL。
|
||||
MEBOX_DATABASE_TYPE: postgres
|
||||
MEBOX_DATABASE_DSN: postgres://mebox:mebox@postgres:5432/mebox?sslmode=disable
|
||||
|
||||
# SQLite 旧库迁移源:
|
||||
# - 首次从旧版 SQLite(mmtl.db / mebox.db)导入时保持此路径。
|
||||
# - 确认迁移完成后,建议改成 /data/no-sqlite-migration.db 这类不存在的路径。
|
||||
MEBOX_DATABASE_DB_PATH: /data/mebox.db
|
||||
MEBOX_CACHE_CACHE_DIR: /cache
|
||||
|
||||
# 管理面板热更新默认拉取此镜像,并用 Watchtower 一次性重建当前容器。
|
||||
MEBOX_UPDATE_IMAGE: ghcr.io/truewhile/mebox:latest
|
||||
|
||||
# 路径换算配置。
|
||||
# 默认推荐在网页里使用容器路径 /media。
|
||||
# 如果旧媒体库已经保存了宿主机路径 /vol1/1000/Media,
|
||||
# 再把这里改成同一个宿主机真实路径用于旧路径换算。
|
||||
MEBOX_MEDIA_DIR: /media
|
||||
MEBOX_MEDIA_CONTAINER_DIR: /media
|
||||
|
||||
# 默认推荐下载器保存路径使用 /downloads。
|
||||
# 如果下载器只能返回宿主机路径,再改成同一个宿主机真实路径。
|
||||
MEBOX_DOWNLOAD_DIR: /downloads
|
||||
MEBOX_DOWNLOAD_CONTAINER_DIR: /downloads
|
||||
|
||||
# NAS 友好的低负载默认值。
|
||||
MEBOX_TRANSCODER_ENABLED: "true"
|
||||
MEBOX_TRANSCODER_HARDWARE_ACCEL: "false"
|
||||
MEBOX_TRANSCODER_REALTIME: "true"
|
||||
MEBOX_TRANSCODER_THREADS: "2"
|
||||
MEBOX_TRANSCODER_MAX_CONCURRENT: "1"
|
||||
MEBOX_TRANSCODER_IDLE_TIMEOUT_SECONDS: "120"
|
||||
|
||||
healthcheck:
|
||||
# 不能写死 http://:开启 HTTPS 后 8080 只接受 TLS,固定明文探测会
|
||||
# 每轮刷一条 TLS handshake error 并让容器一直 unhealthy。
|
||||
test: ["CMD", "/usr/local/bin/mebox-healthcheck"]
|
||||
interval: 30s
|
||||
timeout: 10s
|
||||
retries: 5
|
||||
start_period: 30s
|
||||
|
||||
# 限制 Docker 日志大小,避免长期运行把磁盘写满。
|
||||
logging:
|
||||
driver: json-file
|
||||
options:
|
||||
max-size: "20m"
|
||||
max-file: "3"
|
||||
|
||||
postgres:
|
||||
image: postgres:16-alpine
|
||||
# 首次部署允许拉取;日常更新请只 pull mebox。
|
||||
# 如需升级 PostgreSQL,请先备份 ./postgres 后再手动调整镜像版本并拉取。
|
||||
pull_policy: missing
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
POSTGRES_DB: mebox
|
||||
POSTGRES_USER: mebox
|
||||
POSTGRES_PASSWORD: mebox
|
||||
TZ: Asia/Shanghai
|
||||
volumes:
|
||||
# PostgreSQL 主数据目录。升级/重建容器时必须保留。
|
||||
- ./postgres:/var/lib/postgresql/data
|
||||
healthcheck:
|
||||
test: ["CMD-SHELL", "pg_isready -h 127.0.0.1 -U mebox -d mebox"]
|
||||
interval: 10s
|
||||
timeout: 5s
|
||||
retries: 10
|
||||
logging:
|
||||
driver: json-file
|
||||
options:
|
||||
max-size: "20m"
|
||||
max-file: "3"
|
||||
@@ -1,28 +0,0 @@
|
||||
#!/bin/sh
|
||||
set -eu
|
||||
|
||||
run_uid="${PUID:-$(id -u mebox 2>/dev/null || echo 1000)}"
|
||||
run_gid="${PGID:-$(id -g mebox 2>/dev/null || echo 1000)}"
|
||||
|
||||
case "$run_uid" in
|
||||
''|*[!0-9]*)
|
||||
echo "PUID must be a numeric uid, got: $run_uid" >&2
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
|
||||
case "$run_gid" in
|
||||
''|*[!0-9]*)
|
||||
echo "PGID must be a numeric gid, got: $run_gid" >&2
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
|
||||
if [ "$run_uid" = "0" ]; then
|
||||
exec mebox
|
||||
fi
|
||||
|
||||
chown -R "$run_uid:$run_gid" /data /cache 2>/dev/null || true
|
||||
chown "$run_uid:$run_gid" /media 2>/dev/null || true
|
||||
|
||||
exec su-exec "$run_uid:$run_gid" mebox
|
||||
@@ -1,39 +0,0 @@
|
||||
#!/bin/sh
|
||||
# MeBox 容器健康检查。
|
||||
#
|
||||
# 背景:MeBox 只监听一个端口,且开启 HTTPS 后该端口只接受 TLS(明文 HTTP 不再
|
||||
# 服务)。健康检查若固定用 http:// 探测,每轮都会被 TLS 监听拒绝并在服务日志里
|
||||
# 留下一条 "client sent an HTTP request to an HTTPS server",同时容器状态永远
|
||||
# 是 unhealthy。反过来固定用 https:// 探测,则在未开启 HTTPS 的部署上产生
|
||||
# "first record does not look like a TLS handshake"。
|
||||
#
|
||||
# 当前协议由服务进程写入 $MEBOX_APP_DATA_DIR/.http_scheme(见
|
||||
# cmd/server/server_manager.go 的 writeSchemeState)。脚本优先按该文件选择协议,
|
||||
# 文件缺失或该协议探测失败时再试另一种,避免状态文件过期导致误报不健康。
|
||||
set -u
|
||||
|
||||
port="${MEBOX_APP_PORT:-8080}"
|
||||
data_dir="${MEBOX_APP_DATA_DIR:-/data}"
|
||||
|
||||
scheme_file="$data_dir/.http_scheme"
|
||||
scheme=""
|
||||
if [ -r "$scheme_file" ]; then
|
||||
scheme="$(tr -d '[:space:]' <"$scheme_file")"
|
||||
fi
|
||||
if [ "$scheme" = "https" ]; then
|
||||
first="https"
|
||||
second="http"
|
||||
else
|
||||
first="http"
|
||||
second="https"
|
||||
fi
|
||||
|
||||
for proto in "$first" "$second"; do
|
||||
# --no-check-certificate:用户常用自签证书或 IP 访问,校验域名必然会失败。
|
||||
if busybox wget -q --spider -T 3 --no-check-certificate \
|
||||
"$proto://127.0.0.1:$port/api/health" >/dev/null 2>&1; then
|
||||
exit 0
|
||||
fi
|
||||
done
|
||||
|
||||
exit 1
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 278 KiB |
@@ -1,91 +0,0 @@
|
||||
# MeBox Mobile API 接入与部署说明
|
||||
|
||||
更新日期:2026-10-17
|
||||
适用版本:后端 `feature/android-mobile-api` 分支;App `0.1.0`(versionCode 1)。
|
||||
|
||||
## 1. 路径与版本
|
||||
|
||||
- 安卓契约挂载在 `/api/v1`,与既有 `/api`、Emby/Jellyfin 入口并行。
|
||||
- 健康检查:`GET /api/health`。
|
||||
- 实例身份:`GET /api/v1/server-info`(匿名,`Cache-Control: no-store`)。
|
||||
- 契约字段与错误码见同目录 `openapi.yaml`。
|
||||
|
||||
`server-info.capabilities` 必须反映真实运行能力。当前分支只有
|
||||
`device_sessions=true`;播放会话、阅读 v1 进度、批量正文与移动端转码仍为
|
||||
`false`,App 不得据此进入对应流程。
|
||||
|
||||
## 2. 连接与传输安全
|
||||
|
||||
- 公网必须使用 HTTPS;App 默认使用系统信任链,不提供全局跳过证书校验。
|
||||
- 局域网 HTTP 需要用户在 App 内明确确认风险;App 只对当前配置的服务器来源
|
||||
使用明文,不会把 MeBox `Authorization` 发往其它主机。
|
||||
- 首版只支持根路径部署。`https://host/mebox` 这类子路径会被 App 明确拒绝,
|
||||
不会静默截断为根路径。
|
||||
- 反代需要保留 `X-Request-ID`(可选);服务端会回传同值或新生成值,用于
|
||||
日志对账。
|
||||
|
||||
## 3. 反向代理检查项
|
||||
|
||||
以下项用于媒体阶段(M3/M4)回归,当前登录闭环不依赖它们,但仍建议提前配置:
|
||||
|
||||
| 项目 | 要求 |
|
||||
| --- | --- |
|
||||
| Range / 206 | 透传客户端 `Range`,不要缓存完整响应后改写状态码 |
|
||||
| 流式响应 | 关闭代理缓冲(如 nginx `proxy_buffering off`) |
|
||||
| HLS | `.m3u8` 与分片路径不要被改写或强制压缩 |
|
||||
| WebSocket | 升级头透传,读超时大于心跳间隔 |
|
||||
| 超时 | 登录/普通 API 30 秒内完成;转码起播超时单独配置 |
|
||||
|
||||
目前只验证了普通 JSON 端点;上表其余项尚未在本分支验收。
|
||||
|
||||
## 4. 认证与会话
|
||||
|
||||
- `POST /api/v1/auth/login` 创建 `auth_sessions` 记录,访问令牌 JWT 增加 `sid`。
|
||||
- 旧 `/api` 中间件同样校验 `sid`:设备被踢出或退出后,未过期的 JWT 也会立即
|
||||
返回 401,不能借旧入口绕过。
|
||||
- 没有 `sid` 的历史令牌继续按原逻辑访问旧 API;v1 认证端点拒绝这类令牌,
|
||||
App 需要重新登录。
|
||||
- `POST /api/v1/auth/logout` 幂等;会话撤销会同时撤销其名下刷新令牌。
|
||||
- 设备管理中的踢出操作会同步撤销该设备认证会话。
|
||||
|
||||
### 刷新轮换边界
|
||||
|
||||
- 同一个刷新令牌的并发请求共享一次轮换;60 秒宽限期内重复提交返回同一结果。
|
||||
- 轮换结果仍保存在进程内。若新令牌已签发、旧令牌已撤销,但客户端没收到响应
|
||||
且服务器随后重启,旧令牌可能无法恢复;此时 App 应要求重新登录。首版接受
|
||||
该边界,未实现持久化幂等轮换。
|
||||
- 会话被撤销时,刷新返回 `401 SESSION_REVOKED`,优先于宽限期复用。
|
||||
|
||||
## 5. 错误契约
|
||||
|
||||
统一响应:
|
||||
|
||||
```json
|
||||
{
|
||||
"code": "SESSION_REVOKED",
|
||||
"message": "auth session revoked or expired",
|
||||
"request_id": "8a3bade4-cbb3-485b-8e34-2471e4940fc3",
|
||||
"retryable": false
|
||||
}
|
||||
```
|
||||
|
||||
- 401 由 `code` 区分 `TOKEN_EXPIRED`、`SESSION_REVOKED`、`INVALID_CREDENTIALS`。
|
||||
- 403 表示权限或账号状态,不触发刷新。
|
||||
- 429 带 `Retry-After`,客户端必须等待。
|
||||
- 5xx / `SERVICE_UNAVAILABLE` / `retryable=true` 表示可安全重试。
|
||||
|
||||
## 6. 数据迁移与回滚
|
||||
|
||||
- 新表 `auth_sessions` 与 `refresh_tokens.auth_session_id` 由现有 AutoMigrate
|
||||
创建,属于增量变更,不清库。
|
||||
- SQLite 已验证;PostgreSQL 迁移需要在有实例的环境中单独执行
|
||||
`go test ./internal/database ./internal/repository -count=1` 后才能宣称通过。
|
||||
- 回滚到旧版本不会删除新表;旧程序忽略新增字段。回滚前应先确认不需要再
|
||||
依赖 `sid` 即时撤销能力。
|
||||
|
||||
## 7. 已知限制
|
||||
|
||||
- 单实例部署;未实现多副本共享会话。
|
||||
- 外部播放令牌尚未继承 `sid`(属于 M3 播放会话范围),当前不能按设备即时撤销。
|
||||
- 反代子路径、自签名证书信任、多服务器配置均未支持。
|
||||
- App 目前只开放连接、登录、会话恢复与退出;媒体与阅读入口未实现。
|
||||
@@ -1,389 +0,0 @@
|
||||
openapi: 3.0.3
|
||||
info:
|
||||
title: MeBox Mobile API
|
||||
version: 1.0.0
|
||||
description: |
|
||||
MeBox 安卓客户端的稳定接入契约。所有路径以 `/api` 为前缀挂载,
|
||||
本文档描述 `/api/v1` 部分;既有 `/api` 与 Emby/Jellyfin 入口保持兼容。
|
||||
|
||||
约定:
|
||||
- JSON 字段使用 snake_case;
|
||||
- 时间点为 RFC 3339 UTC 字符串,播放位置与时长使用整数毫秒;
|
||||
- 集合为空时返回 `[]`,未知字段客户端必须忽略;
|
||||
- 错误响应统一为 `code`、`message`、`request_id`、`retryable`;
|
||||
- 能力开关只有在接口实现且当前可运行时才为 true。
|
||||
servers:
|
||||
- url: /api
|
||||
security:
|
||||
- bearerAuth: []
|
||||
tags:
|
||||
- name: server
|
||||
- name: auth
|
||||
paths:
|
||||
/v1/server-info:
|
||||
get:
|
||||
tags: [server]
|
||||
summary: 匿名读取实例身份与移动端能力
|
||||
security: []
|
||||
responses:
|
||||
'200':
|
||||
description: 实例可连接
|
||||
headers:
|
||||
Cache-Control:
|
||||
schema:
|
||||
type: string
|
||||
description: 固定为 no-store
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ServerInfo'
|
||||
'503':
|
||||
description: 暂时无法读取实例身份
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/MobileError'
|
||||
/v1/auth/login:
|
||||
post:
|
||||
tags: [auth]
|
||||
summary: 账号密码登录并创建认证会话
|
||||
security: []
|
||||
parameters:
|
||||
- $ref: '#/components/parameters/RequestId'
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/LoginRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: 登录成功
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/AuthResponse'
|
||||
'400':
|
||||
$ref: '#/components/responses/InvalidArgument'
|
||||
'401':
|
||||
$ref: '#/components/responses/InvalidCredentials'
|
||||
'403':
|
||||
description: 账号被禁用或已到期
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/MobileError'
|
||||
'429':
|
||||
$ref: '#/components/responses/RateLimited'
|
||||
'503':
|
||||
$ref: '#/components/responses/ServiceUnavailable'
|
||||
/v1/auth/refresh:
|
||||
post:
|
||||
tags: [auth]
|
||||
summary: 使用刷新令牌轮换令牌对
|
||||
security: []
|
||||
description: |
|
||||
刷新令牌必须由 v1 登录签发并关联认证会话。同一 refresh token 的
|
||||
并发提交只会真正轮换一次;轮换后 60 秒内重复提交返回同一次结果。
|
||||
会话被撤销后刷新返回 SESSION_REVOKED。
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/RefreshRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: 刷新成功,新令牌继续归属同一 auth_session_id
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/AuthResponse'
|
||||
'400':
|
||||
$ref: '#/components/responses/InvalidArgument'
|
||||
'401':
|
||||
description: 刷新令牌无效、过期或会话已撤销
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/MobileError'
|
||||
'503':
|
||||
$ref: '#/components/responses/ServiceUnavailable'
|
||||
/v1/auth/session:
|
||||
get:
|
||||
tags: [auth]
|
||||
summary: 读取当前用户与认证会话
|
||||
responses:
|
||||
'200':
|
||||
description: 会话有效
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/SessionResponse'
|
||||
'401':
|
||||
$ref: '#/components/responses/SessionInvalid'
|
||||
'503':
|
||||
$ref: '#/components/responses/ServiceUnavailable'
|
||||
/v1/auth/logout:
|
||||
post:
|
||||
tags: [auth]
|
||||
summary: 撤销当前认证会话
|
||||
description: 幂等;重复退出同样返回 200。
|
||||
responses:
|
||||
'200':
|
||||
description: 已退出(本机与远端)
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
example: ok
|
||||
'401':
|
||||
$ref: '#/components/responses/SessionInvalid'
|
||||
'503':
|
||||
$ref: '#/components/responses/ServiceUnavailable'
|
||||
components:
|
||||
securitySchemes:
|
||||
bearerAuth:
|
||||
type: http
|
||||
scheme: bearer
|
||||
bearerFormat: JWT
|
||||
parameters:
|
||||
RequestId:
|
||||
name: X-Request-ID
|
||||
in: header
|
||||
required: false
|
||||
description: |
|
||||
可选的诊断 ID(8—128 位 ASCII 字母、数字或 `-_.:`)。服务器会在
|
||||
响应头与错误体回传同一个值;非法值会被替换为新 UUID。该值不参与鉴权。
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
InvalidArgument:
|
||||
description: 请求字段缺失或格式错误
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/MobileError'
|
||||
InvalidCredentials:
|
||||
description: 用户名或密码错误
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/MobileError'
|
||||
SessionInvalid:
|
||||
description: 访问令牌无效、过期或认证会话已撤销
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/MobileError'
|
||||
RateLimited:
|
||||
description: 请求过于频繁
|
||||
headers:
|
||||
Retry-After:
|
||||
schema:
|
||||
type: integer
|
||||
description: 建议等待秒数
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/MobileError'
|
||||
ServiceUnavailable:
|
||||
description: 暂时性服务/存储错误,可安全重试
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/MobileError'
|
||||
schemas:
|
||||
ServerInfo:
|
||||
type: object
|
||||
required:
|
||||
- name
|
||||
- server_id
|
||||
- server_version
|
||||
- api_version
|
||||
- min_supported_app_version_code
|
||||
- capabilities
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
example: MeBox
|
||||
server_id:
|
||||
type: string
|
||||
format: uuid
|
||||
description: 实例持久身份;备份克隆成独立实例时必须显式重置。
|
||||
server_version:
|
||||
type: string
|
||||
example: MeBox-v0.1.16
|
||||
api_version:
|
||||
type: string
|
||||
example: v1
|
||||
min_supported_app_version_code:
|
||||
type: integer
|
||||
minimum: 1
|
||||
capabilities:
|
||||
$ref: '#/components/schemas/ServerCapabilities'
|
||||
ServerCapabilities:
|
||||
type: object
|
||||
required:
|
||||
- device_sessions
|
||||
- playback_sessions
|
||||
- reader_progress_v1
|
||||
- reader_content_batch
|
||||
- local_transcode
|
||||
properties:
|
||||
device_sessions:
|
||||
type: boolean
|
||||
description: M1 起为 true
|
||||
playback_sessions:
|
||||
type: boolean
|
||||
description: 播放会话接口未实现前必须为 false
|
||||
reader_progress_v1:
|
||||
type: boolean
|
||||
description: v1 阅读锚点/版本冲突未实现前必须为 false
|
||||
reader_content_batch:
|
||||
type: boolean
|
||||
description: v1 批量正文与资源引用未实现前必须为 false
|
||||
local_transcode:
|
||||
type: boolean
|
||||
description: 移动端可用的本地转码会话未实现前必须为 false
|
||||
MobileUser:
|
||||
type: object
|
||||
required: [id, username, role, tier, is_active, force_password_reset]
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
username:
|
||||
type: string
|
||||
nickname:
|
||||
type: string
|
||||
role:
|
||||
type: string
|
||||
enum: [admin, user]
|
||||
tier:
|
||||
type: string
|
||||
example: free
|
||||
is_active:
|
||||
type: boolean
|
||||
force_password_reset:
|
||||
type: boolean
|
||||
expires_at:
|
||||
type: string
|
||||
format: date-time
|
||||
nullable: true
|
||||
TokenPair:
|
||||
type: object
|
||||
required: [access_token, refresh_token, expires_in, token_type]
|
||||
properties:
|
||||
access_token:
|
||||
type: string
|
||||
refresh_token:
|
||||
type: string
|
||||
expires_in:
|
||||
type: integer
|
||||
description: 访问令牌有效秒数
|
||||
token_type:
|
||||
type: string
|
||||
example: Bearer
|
||||
LoginRequest:
|
||||
type: object
|
||||
required: [username, password, device_id]
|
||||
properties:
|
||||
username:
|
||||
type: string
|
||||
password:
|
||||
type: string
|
||||
device_id:
|
||||
type: string
|
||||
maxLength: 128
|
||||
description: App 安装随机生成,不使用 IMEI/MAC 等硬件标识。
|
||||
device_name:
|
||||
type: string
|
||||
maxLength: 128
|
||||
client_name:
|
||||
type: string
|
||||
maxLength: 64
|
||||
example: MeBox Android
|
||||
client_version:
|
||||
type: string
|
||||
maxLength: 64
|
||||
RefreshRequest:
|
||||
type: object
|
||||
required: [refresh_token]
|
||||
properties:
|
||||
refresh_token:
|
||||
type: string
|
||||
AuthResponse:
|
||||
type: object
|
||||
required: [auth_session_id, user, tokens]
|
||||
properties:
|
||||
auth_session_id:
|
||||
type: string
|
||||
format: uuid
|
||||
user:
|
||||
$ref: '#/components/schemas/MobileUser'
|
||||
tokens:
|
||||
$ref: '#/components/schemas/TokenPair'
|
||||
SessionDevice:
|
||||
type: object
|
||||
properties:
|
||||
device_id:
|
||||
type: string
|
||||
device_name:
|
||||
type: string
|
||||
client_name:
|
||||
type: string
|
||||
client_version:
|
||||
type: string
|
||||
last_used_at:
|
||||
type: string
|
||||
format: date-time
|
||||
expires_at:
|
||||
type: string
|
||||
format: date-time
|
||||
SessionResponse:
|
||||
type: object
|
||||
required: [auth_session_id, user]
|
||||
properties:
|
||||
auth_session_id:
|
||||
type: string
|
||||
format: uuid
|
||||
user:
|
||||
$ref: '#/components/schemas/MobileUser'
|
||||
session:
|
||||
$ref: '#/components/schemas/SessionDevice'
|
||||
MobileError:
|
||||
type: object
|
||||
required: [code, message, request_id, retryable]
|
||||
properties:
|
||||
code:
|
||||
type: string
|
||||
enum:
|
||||
- INVALID_ARGUMENT
|
||||
- INVALID_CREDENTIALS
|
||||
- TOKEN_EXPIRED
|
||||
- SESSION_REVOKED
|
||||
- ACCOUNT_DISABLED
|
||||
- ACCOUNT_EXPIRED
|
||||
- PERMISSION_DENIED
|
||||
- PROFILE_PIN_REQUIRED
|
||||
- RATE_LIMITED
|
||||
- UPSTREAM_UNAVAILABLE
|
||||
- TRANSCODE_BUSY
|
||||
- PLAYBACK_SESSION_NOT_FOUND
|
||||
- RESOURCE_EXPIRED
|
||||
- PROGRESS_CONFLICT
|
||||
- SERVICE_UNAVAILABLE
|
||||
message:
|
||||
type: string
|
||||
request_id:
|
||||
type: string
|
||||
retryable:
|
||||
type: boolean
|
||||
retry_after_sec:
|
||||
type: integer
|
||||
minimum: 0
|
||||
details:
|
||||
description: 可选的稳定结构化细节,未定义时客户端必须忽略。
|
||||
@@ -1,167 +0,0 @@
|
||||
# MeBox 阅读功能实施计划(legado 书源兼容)
|
||||
|
||||
> 分支:`feature/reading`
|
||||
> 目标:在首页增加「影视 / 阅读」模式切换,阅读模式完整兼容阅读 3.0(legado)书源体系,覆盖 **文本(bookSourceType=0)、音频(=1)、漫画/图片(=2)** 三类源。
|
||||
> 实现方式(用户明确要求):**样式与逻辑全部仿造 refgd/legado 本体**,不参考其他重实现项目;相当于用 Go + React 18 + TypeScript 5 重写该项目。
|
||||
> 界面与交互的唯一规格:`docs/reader-ui-spec.md`(从 legado 源码逐屏调研产出)。
|
||||
> 规则引擎的唯一语义基准:legado `app/src/main/java/io/legado/app/model/analyzeRule/` 源码,Go 侧逐方法移植对拍(源码克隆在 `C:\MyProject\_ref\legado`,仅作对照,不进入构建)。
|
||||
|
||||
## 1. 范围
|
||||
|
||||
**做:**
|
||||
- 首页「影视/阅读」切换,阅读模式下有独立首页(书架/搜索/发现/最近阅读)
|
||||
- legado 书源导入与管理(URL 导入、文本/JSON 粘贴导入、启停、分组、排序)
|
||||
- 三类书源的完整链路:搜索 → 详情 → 目录 → 正文/播放列表/图片列表
|
||||
- Go 侧规则引擎:CSS(jsoup 风格) / JSONPath / XPath / 正则 / 内嵌 JS 五种语法及其组合
|
||||
- 文本阅读器、音频播放器、漫画阅读器三套前端 UI
|
||||
- 追更、阅读进度同步(服务端存储,多端一致)、换源、替换净化规则
|
||||
|
||||
**不做(本期明确排除):**
|
||||
- `webView` 类规则(需要无头浏览器,识别后标记该源为不兼容并提示)
|
||||
- `webView` 真人校验类登录(loginUrl 走 WebView 人工过验证码的场景;
|
||||
纯 JS / 表单类登录已支持,见 P4.5)
|
||||
- RSS/订阅源、TTS 朗读、文件类型源(bookSourceType=3)
|
||||
- 本地 TXT/EPUB 导入(列为后续可选)
|
||||
|
||||
## 2. 总体架构
|
||||
|
||||
沿用 MeBox 现有分层,全部新增代码集中在:
|
||||
|
||||
```
|
||||
internal/
|
||||
model/ # 新增 5 张表,注册进 AllModels() 自动迁移
|
||||
repository/ # reader 相关 GORM 封装
|
||||
service/reader/ # 规则引擎 + 书源业务(核心新增,预计占全部后端代码 70%)
|
||||
handler/ # /api/reader/* 路由组
|
||||
web/src/
|
||||
pages/reader/ # 阅读端独立页面群(懒加载路由)
|
||||
components/reader/
|
||||
```
|
||||
|
||||
**基建复用**:`internal/helper/http.go`(浏览器 UA + 代理回退 HTTP 客户端)、`internal/service/runtime_cache.go`(影视侧 JSON/对象缓存)、`internal/service/image_proxy*`(封面与漫画图片代理)、`internal/handler/ws.go` 的 WSHub(搜索进度、追更任务推送,新增 `reader:*` topic)。
|
||||
|
||||
**数据流**:书源 JSON 存库 → 搜索/发现时按启用的源并发抓取(errgroup + 信号量限流,超时熔断)→ 结果聚合 → 前端。正文、播放地址、图片列表由服务端组装(含 `nextContentUrl` 翻页合并)后带 TTL 缓存下发;音频流与漫画图片按需经服务端代理补 UA/Referer 头。
|
||||
|
||||
## 3. 规则引擎(核心工作)
|
||||
|
||||
语义基准:gedoor/legado `app/src/main/java/io/legado/app/model/analyzeRule/` 下的 AnalyzeRule / AnalyzeByJSoup / AnalyzeByJSonPath / AnalyzeByRegex / AnalyzeUrl,逐项对拍测试。
|
||||
|
||||
### 3.1 组件与选型
|
||||
|
||||
| 组件 | 选型 | 说明 |
|
||||
|---|---|---|
|
||||
| HTML/CSS | `PuerkitoBio/goquery` | jsoup 等价物;jsoup 特有语法(class.x / id.x / tag.x / text.x / children / @text / @textNodes / @html / 属性选择)自己包一层 |
|
||||
| XPath | `antchfx/htmlquery` | 对齐 JsoupXpath 语义 |
|
||||
| JSONPath | `PaesslerAG/jsonpath`(备选 ohler55/ojg) | Jayway 语义 + 自实现 `\|\|`/`&&` 合并层,选型阶段需验证 |
|
||||
| 正则 | Go regexp(RE2) | legado 部分源用 Java 正则语法,回退换 `dlclark/regexp2` |
|
||||
| JS | `dop251/goja` | ES2017+,跑书源内嵌 JS |
|
||||
| 字符集 | `golang.org/x/text` | GBK/GB18030 解码 |
|
||||
|
||||
### 3.2 引擎能力清单
|
||||
|
||||
- 规则模式识别:`@css:` / `$.`(JSONPath) / `@XPath:`或`//` / `<js>`与`@js:` / `##` 正则替换段
|
||||
- 列表组合符 `&&` / `||` / `%%`,变量存取 `@put:{}` / `@get:{}`,内嵌 JS `{{ }}`
|
||||
- jsoup 分析器、JSONPath 分析器、XPath 分析器、正则分析器,以及混合规则的链式解析(AnalyzeRule 的分段执行语义)
|
||||
- AnalyzeUrl:`{{key}}`/`{{page}}` 变量、`<js>` 生成 URL、URL 后 `,{...}` 选项(method/body/charset/headers/retry/timeout/type/proxy/js/webView)
|
||||
- JS 沙箱:goja 运行时 + 执行超时中断 + 禁止直接 IO;上下文注入 `java`、`source`、`book`、`baseUrl`、`result` 等对象
|
||||
- `java.*` 桥接函数(按书源实际使用频率分批实现):
|
||||
- 网络:ajax / ajaxAll / connect / get / post / head
|
||||
- 编解码:base64Decode/Encode(含 URL-safe)、hexDecode、encodeURI/decodeURI、htmlDecode
|
||||
- 加解密:md5(16/32)、sha1/sha256、AES/DES/3DES/RSA(CBC/ECB + 常见 padding/key 语义,legado 源里最常见的坑)
|
||||
- 字符串与时间:replaceAll/substring/正则族、timeFormat 等
|
||||
- 规则回调:`java.getString/getElement` 等,桥回 Go 规则引擎(JS 与规则互相嵌套的关键)
|
||||
|
||||
### 3.3 兼容策略
|
||||
|
||||
- 引擎按能力分层实现,每个能力配真实书源样本的单测(fixtures 放 `internal/service/reader/testdata/`)
|
||||
- 提供 CLI 冒烟工具(如 `cmd/reader-smoke`):对批量导入的公开书源集跑 搜索/详情/目录/正文 全链路,输出成功率报告,作为每个阶段验收依据
|
||||
- 含 `webView` 选项的源直接判定不兼容并在书源管理页标注
|
||||
|
||||
## 4. 数据模型(新增表)
|
||||
|
||||
| 表 | 关键字段 |
|
||||
|---|---|
|
||||
| book_sources | name, group, type(0/1/2), source_url, json(原文), enabled, custom_order, last_check_at, comment |
|
||||
| books(书架) | source_url, book_url, name, author, cover_url, intro, kind, type(文本/音频/图片), latest_chapter, total_chapters, last_read_chapter_index, last_read_at |
|
||||
| book_chapters | book_id, index, title, url, is_volume, update_time |
|
||||
| read_progress | book_id(唯一), chapter_index, position(滚动/秒/图片序), updated_at |
|
||||
| replace_rules | name, find, replace, scope, is_regex, enabled, order |
|
||||
|
||||
阅读器显示设置(主题/字体/翻页方式)存前端 localStorage,不上服务端。
|
||||
|
||||
## 5. API 设计(/api/reader/*)
|
||||
|
||||
- 书源:`GET/POST/DELETE /sources`、`POST /sources/import`(URL 或 JSON/base64 文本,自动识别格式与类型)、`PATCH /sources/:id`(启停/排序)
|
||||
- 搜索:`POST /search {keyword}` → 后台聚合任务,结果经 WS `reader:search` 增量推送;结果可一键加入书架
|
||||
- 发现:`GET /explore?source=&group=`(解析 exploreUrl 的 `分组名::url` 结构)
|
||||
- 书架:`GET/POST/DELETE /books`、`GET /books/:id/info`、`GET /books/:id/toc`、`POST /books/:id/refresh`(追更)
|
||||
- 本地书籍:`POST /local/books`(multipart 上传 TXT/EPUB,导入即入书架)
|
||||
- 内容:`GET /books/:id/chapters/:idx/content` —— 按书籍类型返回:
|
||||
- 文本:`{type:"text", content:"..."}`(服务端已合并 nextContentUrl 翻页、已应用替换规则)
|
||||
- 音频:`{type:"audio", tracks:[{url,title}]}`(含代理路径与所需请求头)
|
||||
- 图片:`{type:"image", images:[{url, style}]}`(同样经代理)
|
||||
- 进度:`PUT /books/:id/progress`
|
||||
- 替换规则:`/replace-rules` CRUD
|
||||
- 调试:`POST /debug {source_id, rule, url}`(书源调试器后端)
|
||||
- 图片/流代理:复用现有 image_proxy / stream_proxy 模式,按源配置注入 UA/Referer
|
||||
|
||||
## 6. 前端设计
|
||||
|
||||
- **首页切换**:`HomePage.tsx` 顶部加分段控件(仿 `LibraryTagBar` tab 模式),「阅读」切到阅读首页;选择持久化(zustand + localStorage)
|
||||
- **阅读首页**:继续阅读横排 + 书架封面网格 + 搜索入口 + 追更提示
|
||||
- **页面群**(懒加载,仿 `appRoutes.tsx`):`/reader`(首页)、`/reader/search`(多源并发搜索 + 实时进度)、`/reader/explore`、`/reader/book/:id`(详情 + 目录 + 换源)、`/reader/sources`(书源管理 + 调试器)
|
||||
- **三套阅读器**:
|
||||
- 文本:滚动 + 分页双模式(CSS 分栏测量分页)、主题(含夜间)、字体/行距/边距、点击翻页区、章节预加载、进度上报
|
||||
- 音频:`hls.js`(已是依赖)+ `<audio>` 兜底,播放列表、倍速、记忆进度、锁屏/息屏策略
|
||||
- 漫画:上下滚动 / 左右翻页双模式、相邻图片预加载、`imageStyle` 支持
|
||||
|
||||
## 7. 阶段划分
|
||||
|
||||
| 阶段 | 内容 | 交付物 |
|
||||
|---|---|---|
|
||||
| P0 引擎地基 ✅ | 规则引擎核心(四分析器 + 规则拆分/组合/变量)+ AnalyzeUrl v1(GET/POST/charset/headers/变量/页码模式)+ 表结构 + 书源导入/管理 API + 搜索/详情/目录/正文/书架/进度/调试 API | 已完成:`internal/service/reader/rule/`(规则引擎,~2800 行,对齐 AnalyzeRule/AnalyzeByJSoup/AnalyzeByJSonPath/AnalyzeByXPath/AnalyzeByRegex/AnalyzeUrl/RuleAnalyzer)+ 服务层 + `/api/reader/*` 路由 + 单测/端到端测试全绿 |
|
||||
| P1 文本源全链路 + 首页切换 | 搜索聚合(WS 进度)/详情/目录/正文(nextContentUrl 合并、缓存)+ 前端首页切换、书架、搜索、详情、文本阅读器 v1(阅读器样式仿 legado:9 宫格点击、主题、翻页动画) | 用纯规则型文本源完成「搜书→加入→阅读」全流程 |
|
||||
| P2 JS 与兼容率爬坡 ✅ | goja 接入 + `java.*` 桥(网络/编解码/摘要/对称加密全家桶/规则回调,函数名对齐 JsExtensions)+ URL 规则 JS(analyzeJs/{{}}/js/bodyJs)+ cookie jar + 用户替换净化规则(含正则超时保护)+ 替换净化页 + 结构化冒烟链路(SmokeChain)+ `cmd/reader-smoke` 冒烟 CLI | JS 源可用;冒烟 CLI 跑公开书源集出各阶段通过率报告 |
|
||||
| P3 音频源 ✅ | 正文按音频类型返回播放列表(绝对化)+ `/api/reader/media` 签名媒体代理(HMAC 防滥用、Range 透传支持拖动、m3u8 分片/密钥地址重写)+ 听书面板(hls.js 播 m3u8、直链 `<audio>`、上一章/-15s/播放暂停/+15s/下一章、章节选择抽屉、定时关闭 0–180 分钟、倍速 0.5–3.0、跳过片头片尾按书持久化 `PUT /api/reader/books/:id/audio-config`、进度按秒记忆、播完/片尾到点自动下一章) | 音频源可听 |
|
||||
| P4 漫画/图片源 ✅ | 图片列表绝对化 + 经签名代理(带书源 Referer 防盗链头)+ 漫画阅读器(上下滚动/左右单页双模式、图片懒加载与加载失败占位、点击分区翻页/呼菜单、菜单进度条按图片序号、进度按图片序号记忆、下一章预取)+ imageStyle 透传 | 漫画源可看 |
|
||||
| P4.5 书源登录 ✅ | `jsLib` 一次装载(对应 legado SharedJsScope)+ `source.*` 会话方法(getVariable/setVariable/getLoginInfo/putLoginInfo/getLoginHeader/putLoginHeader/get/put)+ `cookie.*`(getCookie/setCookie/replaceCookie/removeCookie/getKey,按 eTLD+1 隔离)+ 请求自动携带 Cookie 与 loginHeader + `loginUrl`/`loginUi`(解析表单 → 按钮 action 拼在 loginUrl 后执行 → result 为表单值)+ `loginCheckJs`(会话失效自动重登/重取)+ 源变量落库 + 登录信息/Cookie 加密存储 + 服务端 toast/startBrowser 回传前端 + 登录面板与变量编辑器 | 登录类书源可登录、可留存登录态 |
|
||||
| P4.6 本地书籍 ✅ | `POST /api/reader/local/books` 上传 TXT / EPUB(上限 64MB)→ 落盘 `data/reader/local/<bookID>.<txt\|epub>` + 解析目录入 `reader_chapters` + 落库为 `origin=""`、`is_local=true` 的书架条目;TXT 自动识别 BOM/UTF-8/GBK/Big5/UTF-16 并按 legado 默认 TXT 目录规则切章(RE2 无 lookbehind,改行首锚定 + 句子启发式过滤),章定位信息存字节区间 `start:end`,读章只读该区间;EPUB 走 container.xml → OPF spine,标题优先取 NCX/NAV,正文去标签与实体;移出书架同步删落盘文件;同名重复导入覆盖更新并尽量保留进度 | 本地书可上传、可读、可删 |
|
||||
| P4.10 书源按用户独立 ✅ | 书源从全局唯一改为按用户独立:`ReaderBookSource` 增加 `user_id`,唯一键改为 `(user_id, source_url)`;导入/列表/启停/删除/搜索全部按当前用户限定;老库迁移自动删旧唯一索引、按「谁书架上有这本书」回填归属并给多引用用户复制副本、清理软删历史行;删除改为物理删除(软删会占住唯一键导致「删掉再导入」失败);正文缓存键随之改为「书源行 ID + 书本地址」,不同用户改过规则的同名书源不再共享缓存 | 用户的启停/规则/变量/删除互不影响 |
|
||||
| P4.7 正文持久缓存 ✅ | 服务端正文持久缓存(`reader_content_cache.go`:书源侧产物 + 索引落库 + 内容落盘 `cache_dir/reader-content/`、TTL/容量 LRU、目录刷新 remap、换源/移出书架清理、读穿透 singleflight)+ 批量取正文接口 `POST /api/reader/books/:id/content-batch`(对应 CacheBook 协议)+ 前端窗口预取(默认 3 章) | 慢源连续翻章不再每章等待;重复阅读零网络 |
|
||||
| P4.8 图片/字体兼容 ✅ | `coverDecodeJs`(封面解密代理,含搜索结果未入库场景)/ `ruleContent.imageDecode`(正文图片解密)+ 图片 URL 尾部 `,{headers}` options 逐图应用(options 优先于书源 header 与 Cookie)+ `java.queryTTF` / `queryBase64TTF` / `replaceFont`(sfnt cmap 0/4/6、loca 短/长、glyf 简单+复合字形) | 加密图与字体混淆正文可读 |
|
||||
| P4.9 规则稳定性 ✅ | `@put` 回写书源变量(修复跨请求丢失);`book.getVariable/putVariable` 真正注入书籍上下文并落库(对应 Book.upVariable);全部书源 `regexp2` 统一 3s 匹配超时;解压输出 32MB 上限;非 UTF-8 TXT 托管副本按 UTF-8 落盘(外部引用读时解码);换源单事务;JS `cache` 按书源命名空间隔离并落盘;HLS 双端识别(服务端 `#EXTM3U` 嗅探 + `hls` 标志下发) | 与阅读 App 行为对齐,坏源不再拖死服务 |
|
||||
| P5 体验完善 | 换源(ChangeBookSourceDialog 四档排序)、追更(定时刷新目录 + 缓存清理)、发现页(exploreUrl 标签条)、阅读器高级设置(页眉页脚提示、点击区域自定义)、书源编辑器六 Tab、备份导出 | 完整体验 |
|
||||
|
||||
### 实施记录:书源会话状态仍是跨用户共享(下一步)
|
||||
|
||||
书源本身已按用户独立,但 `ReaderSourceState`(Cookie / 登录信息 / loginHeader / 源变量)
|
||||
仍以 `source_url` 为唯一键、跨用户共享一份。两个用户导入同一书源时:
|
||||
|
||||
- 一方登录后,另一方复用同一份 Cookie;一方的登出会清掉另一方的登录态。
|
||||
|
||||
彻底隔离需要给状态表也加 `user_id`(或按书源行 ID 组织),涉及登录面板与变量读写
|
||||
的一批调用点,留作单独一轮处理。
|
||||
|
||||
### 实施记录:关于「宽松 @put 触发 panic」的复核
|
||||
|
||||
前期评估曾报告 `sourcerule.go` 的宽松 `@put` 回退正则含 RE2 不支持的反向引用、可能 panic。
|
||||
逐行复核后该结论**不成立**:`splitPutRule` 的下标全部由固定捕获分组数保证。
|
||||
真实缺陷是另外两个并已修复:
|
||||
|
||||
- `AnalyzeRule.Put` 没有 `sourcePutter` 分支,`@put` 只写进一次性的 `bookVars`,跨请求丢失;
|
||||
- `applyBookContext` 的三处调用点都在传 `book=nil`,`book.getVariable/putVariable` 与 `book.name` 长期是死代码。
|
||||
|
||||
P0–P2 是主体(约全部工作量 60–70%),P3/P4 相对独立可并行。
|
||||
|
||||
## 8. 风险与对策
|
||||
|
||||
- **书源质量参差**:单源解析全程超时与重试上限;正文翻页循环设页数上限防死循环
|
||||
- **goja 性能**:复杂 JS 源解析慢 → 正文/目录强缓存、单源并发限 1、全局执行预算
|
||||
- **Java 正则/JSoup 细节差异**:以对拍测试驱动修正,regex 备选 regexp2
|
||||
- **热源防盗链**:图片与音频一律走带请求头的代理
|
||||
- **合规**:不内置任何书源,全部由用户自行导入,管理页附免责说明
|
||||
|
||||
## 9. 参考
|
||||
|
||||
- **唯一语义与样式基准**:https://github.com/refgd/legado (规则引擎 analyzeRule 源码 + UI 布局/交互,见 docs/reader-ui-spec.md)
|
||||
- 书源规则教程:https://mgz0227.github.io/The-tutorial-of-Legado/
|
||||
@@ -1,260 +0,0 @@
|
||||
# legado UI/交互仿制规格(React 18 + Tailwind Web 版实现依据)
|
||||
|
||||
> 来源:对 `refgd/legado`(克隆于 `C:\MyProject\_ref\legado`)源码的调研。
|
||||
> 路径缩写:`<src>` = `app/src/main/java/io/legado/app/`,布局在 `app/src/main/res/layout/`。
|
||||
|
||||
## 1. 首页/书架
|
||||
|
||||
文件:`<src>ui/main/bookshelf/`(BookshelfFragment、BooksAdapterGrid/List)、`fragment_bookshelf1/2.xml`、`item_bookshelf_grid*.xml`、`item_bookshelf_list*.xml`。主界面底部 BottomNavigation(书架/发现/我的)+ 右上悬浮搜索按钮。
|
||||
|
||||
**布局结构(从上到下)**
|
||||
- style1(标签页风格):标题行(书架标题 + 下拉箭头,点开分组切换菜单)→ 搜索按钮 + 更多按钮 → 一级分组 tab 条(tab 长按可删分组)→ 次级分组扩展标签 → ViewPager(每 tab 一个书籍列表/网格)。
|
||||
- style2(单 RecyclerView 混排):title_bar → SwipeRefresh → 书籍列表(根分组时「分组网格项 + 书籍项」混排,进入分组只显示书籍)→ 空态文案。
|
||||
- 网格项:封面 + 本地角标 + 未读数角标 + 加载中 + 书名 + 长按遮罩。
|
||||
- 列表项:封面 + 本地图标 + 有更新标记 + 未读数 + 书名 + 作者 + 最后更新时间 + 当前读到(章节名)+ 最新章节(章节名)+ 长按遮罩。
|
||||
|
||||
**交互逻辑**
|
||||
- 内置分组 id:全部(IdRoot=-100)、本地(IdLocal=-2)、未分组(IdUngrouped=-4),其余用户分组。
|
||||
- 单击书 → 直接进入阅读;单击分组 → 进入该分组。
|
||||
- 长按书 → 跳转书籍详情页;长按分组 → 重命名/删除对话框;style1 长按 tab 删除分组。
|
||||
- 右上菜单:搜索、Wi-Fi 传书、刷新目录、书架布局切换、分组管理、导出/导入书架、下载离线、本地导入、网址添加、日志。
|
||||
|
||||
**MeBox 的「影视 / 阅读」首页模式**(`stores/readerSettings.homeMode` + 顶栏 `LayoutReaderModeToggle`)
|
||||
- 切换入口在**顶栏**,位于搜索框与账号菜单之间,**只显示图标不显示文字**:影视模式显示场记板图标,阅读模式显示书图标(并带品牌色高亮),点一下切到另一个模块、图标随之变化。悬停提示写明「当前是 X 模式,点击切换到 Y」,不在首页时点击会先跳回 `/`。
|
||||
- 两种模式共用一个首页路由 `/`:影视模式渲染媒体首页,阅读模式渲染书架(`ReaderHomeContent embedded`)。首页内容区不再放分段式「影视 / 阅读」开关(原 `ReaderModeSwitch` 仅留给独立布局的 `/reader` 首页兜底)。
|
||||
- 切到阅读模式时,顶部搜索框换成**书搜索**(`LayoutHeaderBookSearch`,占位「搜索书籍…」):聚焦即下拉书架(本地即时过滤书名/作者,点条目进阅读器),回车优先打开书架首条;下拉底部固定一行「在书源中搜索「xxx」」,带 `?key=` 跳到 `/reader/search` 由多源聚合搜索页自动开搜。账号/主题菜单照常显示。
|
||||
- 阅读模式下移动端底部导航(首页/媒体库/收藏/列表/更多)隐藏,避免影视导航混进书架。
|
||||
- `/reader/*` 本来就是独立全屏布局(不套影视 Layout),不受影响。
|
||||
|
||||
**MeBox 书架已实现的布局与信息(`ReaderHomeContent.tsx` + `BookshelfCard.tsx` + `BookshelfSettingsDialog.tsx`)**
|
||||
- 三套布局,设置在顶栏「书架设置」弹窗里(对应 legado dialog_bookshelf_config),存 `stores/readerSettings.ts`:
|
||||
- 网格:封面宫格,列数 2–6 或「自适应」;窄屏自动降到 2–3 列兜底。卡片含封面 + 本地角标 + 未读章数徽标 + 双行书名 + 详情/移出按钮。
|
||||
- 列表:66×90 封面 + 书名 + 作者 + 更新时间 + 读到(当前章)+ 最新章节;对应 legado `item_bookshelf_list.xml` 的四行信息。
|
||||
- 紧凑列表:48×64 小封面 + 书名 +「作者 · 读到」,一屏放更多书(对应 legado `layout_list_compact`)。
|
||||
- 排序六档,对齐 legado `AppConfig.getBookSortByGroupId`:最近阅读(dur_chapter_time,默认)/ 最近更新(latest_chapter_time)/ 综合 / 按书名 / 按作者 / 手动顺序(order)。顶栏有快捷排序下拉,弹窗里也可选。
|
||||
- 显示项开关:未读章数徽标、更新时间。
|
||||
- 「更新目录」(对应 legado `menu_update_toc`):`POST /reader/shelf/refresh-toc` 并发重抓书架内网络书籍的目录,覆盖章节缓存;末章标题变化时刷新 `latest_chapter_time`,用于「最近更新」排序与更新时间展示。本地书籍与无书源信息的书跳过。返回 `total/updated/unchanged/failed` 四档——抓到但章数没变(完结书)记 `unchanged`「已是最新」,只有抓取或写入真的失败才记 `failed`,避免把正常结果报成「更新失败」;失败会打 Warn 日志(含书名与书源)。
|
||||
- 未实现(与 legado 的差距):书籍二级分组网格(进入分组后的封面网格)、导出/导入书架、离线下载管理界面(服务端批量缓存接口与窗口预取已可用,见下)。
|
||||
- 章节预取:阅读页对当前章之后默认 3 章走 `POST /reader/books/:id/content-batch` 批量抓取(服务端并发 + 持久缓存),翻到后续章直接命中;单章串行预取在高延迟书源上赶不上连续翻章。
|
||||
- 书源按用户独立:书源管理(列表/导入/启停/删除)与搜索都只作用于当前用户自己的书源。同一份书源不同用户可以各导入一份,各自启停、排序、改规则与变量,互不可见;Web 端无需额外交互,接口按登录用户自动隔离。
|
||||
|
||||
**书架分组(`/reader/book-groups`,仿影视模块的媒体库标签)**
|
||||
- 按用户存服务端:`reader_book_groups` 表每个用户一条,`groups` 列是 `[{name, book_ids}]` 的 JSON。结构、语义与影视的媒体库标签(`User.LibraryTags`)同构——组名 → 成员 ID、整份替换、一个成员只归一个组、组内顺序即展示顺序。
|
||||
- 接口:`GET /reader/book-groups`(没有分组返回空数组)、`PUT /reader/book-groups`(整份替换)。服务端落库前做两条需要「知道书是否存在」的收敛:只保留该用户书架上的书(书移出书架后分组里不留死 ID)、一本书只归一个组(越靠前的分组优先)。空分组保留,方便先建组再放书。
|
||||
- 与影视的差异:书架有两个内置页签「全部」「未分组」(未分组是「没有被任何分组认领」的视图,不持久化,只有存在分组时才出现,且固定在分组栏最后,避免挤开用户自己拖拽排好的分组顺序);书籍不进管理弹窗逐个分配,而是在卡片上用「分组」按钮指定(书架可能有上千本,列出来既慢又难找)。
|
||||
- 前端:`utils/readerBookGroups.ts`(纯逻辑)+ `hooks/useBookGroups.ts`(乐观更新、串行提交、失败回滚,接口不可用时退回 localStorage,照搬 `useLibraryTags`)+ `components/BookGroupBar.tsx`(分组栏)+ `ManageBookGroupsDialogView.tsx`(新建/重命名/删除/拖拽排序)+ `BookGroupPickerDialog.tsx`(移到分组)。
|
||||
|
||||
**阅读器偏好按账号同步(跨设备)**
|
||||
- 主题 / 夜间模式 / 排版(字号、行距、段距)/ 翻页或滚动模式 / 听书倍速与定时 / 书架布局·排序·显示项,原先只存浏览器 localStorage(设备级,换设备就丢),现在按用户落库到 `reader_profiles`(`model.ReaderProfile`,`user_id` 唯一索引),接口 `GET|PUT /reader/profile`。
|
||||
- 服务端是权威来源,localStorage(zustand persist 的 `mebox-reader-settings`)退化成首屏缓存:登录后 `hydrateReaderSettings()` 拉一次覆盖本地,之后本地改动防抖 600ms 回写(`utils/readerSettingsSync.ts`)。
|
||||
- 账号还没有偏好记录时 `GET` 返回 `null`,前端把本地现值推上去「播种」,升级前在本机调好的设置不会被重置。
|
||||
- 服务端只做存储 + 范围收敛(数值夹区间、枚举未知回落默认、主题标识限长),不做语义解释;前端另有本地 clamp,两处范围需同步(见 `service/reader/profile.go` 顶部注释)。
|
||||
- 首页的「影视 / 阅读」模式(homeMode)是设备级偏好,故意不参与同步。
|
||||
|
||||
## 2. 阅读界面(重点)
|
||||
|
||||
文件:`<src>ui/book/read/`(ReadBookActivity、ReadMenu、SearchMenu、MangaMenu、config/*Dialog)、`ui/book/read/page/`(ReadView、PageView、ContentTextView、ChapterProvider)。
|
||||
|
||||
**布局结构(单 FrameLayout 栈)**:read_view 正文 → 文字选择光标 → read_menu 主菜单 → search_menu 全文搜索 → 朗读回原文浮条。
|
||||
|
||||
**正文渲染**
|
||||
- ReadView 内含 3 个 PageView(prev/cur/next 缓存),ContentTextView 纯 Canvas 自绘:按字号/行距/段距/缩进/两端对齐排版,Web 版用 CSS multi-column 或 JS 分页等效实现。
|
||||
- 翻页动画(0–5):0 覆盖、1 平移、2 仿真、3 上下滚动、4 无、5 平移覆盖;速度可调(默认 300ms)。
|
||||
- 滚动模式支持背景跟随、自动翻页(定时滚动/定时翻页)。
|
||||
- 图片/漫画书切换独立配置集 + MangaMenu:顶栏 + 底部胶囊(上一页/页码进度条/下一页),支持横滚、缩放。
|
||||
|
||||
**点击区域(9 宫格,边缘留 pageTouchClick px)**
|
||||
- 区块:左上/中上/右上/左中/中/右中/左下/中下/右下。
|
||||
- 默认:左列与上中=上一页;右列与下中=下一页;正中=呼出菜单。
|
||||
- 全部可配动作:0 呼出菜单、1 下一页、2 上一页、3 下一章、4 上一章、7 书签、10 目录、11 搜索、12 同步进度等。
|
||||
|
||||
**主菜单 ReadMenu(自上而下)**
|
||||
- 半透明遮罩(点击收起)。
|
||||
- 顶部 title_bar:返回 + 书名(点击进详情)+ 章节名/章节链接(点击打开原页面)+ 书源按钮(弹菜单:编辑书源/禁用书源等)。
|
||||
- 底部 bottom_menu(圆角面板):上一章 | 进度条 | 下一章 → 亮度条 + 自动亮度 → 快捷按钮行(搜索、自动翻页、替换规则、夜间/日间切换)→ 动作面板行(目录、朗读、界面、设置)。
|
||||
- 菜单配色可跟随页面背景或用主题底色,透明度 35–100。
|
||||
|
||||
**设置面板**
|
||||
- 「界面」三 Tab:文本(字体文件、字重、字号 5–50、字距、行距 0–20、段距、缩进、下划线、阴影);样式(白天/夜间/E-Ink 三态主题:文字色、背景色/图、强调色、菜单底色、菜单透明度、背景透明度,可恢复/管理/分享);页面(6 种翻页动画、状态栏深浅、滚动背景跟随、四边距、页眉页脚提示、简繁转换)。
|
||||
- 「设置」:屏幕方向、保持亮屏、隐藏状态栏、两端/底部对齐、竖排、双页、进度条行为(按页/按章)、音量键/滚轮翻页、点击区域配置、动画速度、自动换源等。
|
||||
- 页眉页脚提示项:无/章节名/时间/电量/电量百分比/页码/总进度/页码+总页/时间+电量/书名;页眉默认 左=时间/右=电量,页脚默认 左=章节名/右=页码/总页。
|
||||
|
||||
**内置主题与配色(assets/defaultData/readConfig.json,6 套 + 自定义)**
|
||||
|
||||
| 名称 | 背景(日/夜) | 文字(日/夜) | 强调(日/夜) | 字号 |
|
||||
|---|---|---|---|---|
|
||||
| 微信读书 | #FFC0EDC6 / #000000 | #FF0B0B0B / #ADADAD | #E53935 / #FE4D55 | 24 |
|
||||
| 预设1 | #FFFFFF / #000000 | #000000 / #FFFFFF | #E53935 / #FE4D55 | 20 |
|
||||
| 预设2(羊皮纸) | #DDC090 / #3C3F43 | #3E3422 / #DCDFE1 | #834E00 / #FE4D55 | 20 |
|
||||
| 预设3(护眼绿) | #C2D8AA / #3C3F43 | #596C44 / #88C16F | #E53935 / #FE4D55 | 20 |
|
||||
| 预设4(粉紫) | #DBB8E2 / #3C3F43 | #68516C / #F6AEAE | #801314 / #90BFF5 | 20 |
|
||||
| 预设5(淡蓝) | #ABCEE0 / #3C3F43 | #3D4C54 / #90BFF5 | #E53935 / #FE4D55 | 20 |
|
||||
|
||||
默认排版:textSize 20、letterSpacing 0.1、lineSpacingExtra 12、paragraphSpacing 2、缩进「 」、padding 上下6/左右16、页脚线 true。未选样式时默认:bg #EEEEEE / 夜 #000000 / E-Ink #FFFFFF,文字 #3E3D3B / 夜 #ADADAD,强调 #E53935 / 夜 #FE4D55。
|
||||
|
||||
**MeBox 文本阅读器已实现的排版/菜单细节**(`ReaderViewPage.tsx`)
|
||||
- 正文留边:左右 16px、上下 8px(对齐 legado 默认左右16/上下6),分页列宽按留边后的视口宽计算,正文不贴屏幕边。
|
||||
- 菜单打开时正文整体下移一个顶栏高度(用 `transform`,不改视口高度、不触发重新分页),顶栏不再压住开头 1–2 行。
|
||||
- 界面面板的字号/行距/段距三个调节组用 `flex-wrap`,窄屏自动折行,不会把「段距」挤出屏幕。
|
||||
- 点击分区:翻页模式渲染一层 `absolute inset-0` 的三分区按钮(左 30% 上一页 / 中 40% 呼出菜单 / 右 30% 下一页);**滚动模式不能渲染这层覆盖层**——它不是滚动容器的子节点,手机上手指落在覆盖层按钮上时浏览器找不到可滚动的祖先,纵向滑动完全失效、只剩点左右能翻屏。滚动模式改为在滚动容器自身的 `onClick` 上按 x 坐标分区(`handleZoneTap`),手指拖动不会产生 click,原生纵向滚动照常。
|
||||
- 手机横向滑动翻页(`hooks/useHorizontalSwipe.ts`):翻页模式(文本/漫画)在三分区覆盖层上再接一层触摸手势——**从左往右滑=上一页、从右往左滑=下一页**,并且**跟手**:位移超过 12px 且横向明显大于纵向(1.2 倍)之后,内容就跟着手指走,松手再按「位移 ≥45px」决定翻页还是回弹(跟手手势不再看手势时长,慢慢拖过去同样是拖动)。跟手手势一律吞掉随之而来的 click,否则短距离拖动会「回弹 + 再翻一页」;没走跟手的手势仍按原来的「≥45px + 时长 ≤800ms」判定一次滑动,短距离当点击交给分区按钮。`consumeSwipe()` 让三个分区按钮的 `onClick` 先判断这次 click 是否已被手势吃掉,标记在每次 `touchstart` 重置。
|
||||
- 跟手拖拽平移的是两个不同的元素。文本:正文列外面单挂一层「跟手层」(`pageDragRef`),分页平移由 `applyTextPageTransform` 命令式写在里层(`contentRef`),跟手层只管手指位移;松手时两层同时动(跟手位移归零 + 页码变化),合起来就是一次连续滑动。正文用 `ReaderTextPageBody` memo,避免长章每次 `setPage` 重渲染整棵段落树(手机会先卡一下再翻页)。漫画:平移 `ReaderComic` 的舞台,舞台左右各摆一页(见下一条)。
|
||||
- 漫画单页翻页的跟手轨道与预取(`ReaderComic` 的 `draggable` 分支):翻页模式且没有并排铺开两页时,当前页左右各摆一页,手指横滑整条舞台跟着走。单元格按图片序号做 key、位置用 `left` 百分比铺开(不是固定三个槽位换内容),所以翻页时变的只是 `left`,`<img>` 的 src 不变,浏览器不会重新解码、也不会先闪一下转圈。松手要翻页时先把新页瞬移到手指离开的位置(这一步必须关掉过渡,否则会先反着滑一段),读一次布局把这一帧定成过渡起点,再打开过渡滑回 0;同时页码 +1/-1,单元格的 `left` 在同一次提交里跟着换,两边相抵,屏幕上看不出切换。**两侧那两页同时就是下一页/上一页的预取**(带 `eager`:它们被 `overflow-hidden` 裁在屏幕外,懒加载会认为「离视口还远」而不去取,横滑过去就会看到转圈)——这正是「手机上翻一页要等一秒、电脑上(双页开着会顺带往后探测 8 张)不卡」的根因。
|
||||
- 滚动模式的滚轮(`useSmoothWheelScroll`):把滚轮格数累加成一个目标位置,再逐帧向它逼近,滚动连续、松手后自己滑行一段,仿手机上下滑动,而不是浏览器整格跳变。只在文本/漫画的上下滚动模式接管;翻页模式仍走下面的翻页监听器。按真实帧间隔换算逼近比例,120Hz 屏上速度不会翻倍;`ctrl/cmd+滚轮` 保留缩放;手指按下(滑动、拖滚动条、点分区)立刻停掉动画把控制权交还用户。
|
||||
- 漫画双页铺开(`hooks/useComicSpreads.ts` + `utils/comicSpread.ts`,legado 无对应项,是桌面端补充):窗口宽度 ≥900px 且漫画处于翻页模式时,一屏并排显示两页(`settings.comicDoublePage` 为设备级偏好,默认开,可在菜单里关;窗口不够宽时自动退回单页)。分组规则同 Tachiyomi 的 dual page——宽度明显大于高度(比值 ≥1.1)的图视为「跨页宽图」独占一屏,其余连续的竖版页两两配对;列表接口只给 URL,尺寸靠 `new Image()` 探测(`<img>` 渲染时顺带回填),只探测当前页往后 8 张的窗口,避免整章预载。进度仍按图片序号记,翻页时换算成「第几屏」,所以关掉再开双页进度不会错位。菜单动作行改为 `flex` 等分,容纳「双页/单页」入口(`grid-cols-N` 得写死列数字面量,多一个按钮无法复用)。
|
||||
- 漫画图片显示尺寸(`utils/comicImageFit.ts`,仅上下滚动模式):legado 的漫画阅读有「缩放」,Web 版原先只有一种写死的宽度(正文列封顶 900px),桌面端放不大也缩不小,所以补上一组档位,在界面面板的「图片尺寸」一行切换。`default` 就是老样子(900px 居中),`width` 适应宽度(正文列不再封顶、铺满窗口),`height` 适应高度(一屏一页),`long` 适应长边(整页完整可见),`original` 原图(原始像素 1:1,超出部分横向滚动)。`default`/`width` 由外层列宽决定,其余三个由 `<img>` 自身约束,**所以后三种必须放开 900px 列宽上限**,否则会被列再压回去。`height`/`long` 要按「一屏多高」换算,所以量的是滚动容器本身而不是 `window.innerHeight`(正文区是 root 里的 `flex-1`,另挂上下条之后就不等于窗口高度了),并用 `ResizeObserver` 跟随;只在启用了自尺寸档位时才挂观察器,默认档位不白白重渲染整章。`settings.comicImageFit` 是设备级偏好(不同屏幕和源分辨率合适的尺寸不同),和 `comicDoublePage` 一样只存本机、不参与账号同步。翻页模式是整页缩放进视口,本来就不存在「太大/太小」,档位对它不生效、也不显示入口。`ctrl/cmd+滚轮` 依然留给浏览器缩放,本功能只用档位做粗调。
|
||||
- **文本型漫画源按图片下发**(`internal/service/reader` 的 `imageMarkersOnly`):拷贝漫画这类书源 `bookSourceType=0`(文本),正文规则直接给 `<img>`,服务端把整行标签转成 `[img]<签名地址>` 标记行后类型仍是 `text`,前端就会走文本阅读器——分页把每张图当成一列,一屏只看得到一张,桌面端也谈不上双页铺开。现在 `GetContentForBook` / `LocalChapterContent` 在标记化之后判断「非空行全部是 `[img]` 标记」,是则把 `type` 改成 `image` 并给出 `images`,交由漫画阅读器渲染(整页缩放、双页铺开、进度按图片序号)。判定只认「全是标记」:混了正文的章节一律保持 `text`,孤立的 HTML 标签行(`<div>`/`</div>`)与空行当作无内容忽略,绝不吞掉可读文字。
|
||||
- 鼠标滚轮翻页(仅翻页模式):向上滚=上一页,向下滚=下一页;菜单打开时也不翻页。鼠标滚轮一格一页(间隔至少 220ms,与翻页动画对齐),触控板小步长累计到阈值翻一页且一次手势只翻一页(避免惯性连翻)。`ctrl/cmd+滚轮` 保留浏览器缩放。
|
||||
- **浏览器全屏(沉浸式)**:阅读页本身已经是 `fixed inset-0` 的独立布局(`/reader/*` 不套影视 Layout),所以屏幕上的留白只剩浏览器自带的地址栏/工具栏。底部动作行加「全屏 / 还原」,对 `readerRef` 调标准 Fullscreen API(`requestFullscreen` / `exitFullscreen`),进全屏前先收起菜单。按钮只在 `document.fullscreenEnabled === true` 时出现——**iOS 上的 Safari 至今不支持元素全屏**(只有 `<video>` 能全屏),所以那里不显示按钮,而不是显示一个点了没反应的死按钮;iPhone 想彻底去掉浏览器界面只能「添加到主屏幕」。离开阅读页时卸载 effect 主动 `exitFullscreen`,否则返回书架后浏览器仍停在全屏、整站都被罩住。全屏状态由 `fullscreenchange` 事件回写,不做乐观更新(用户按 Esc / 系统手势退出时也要跟着变)。
|
||||
- **手机端双击中间区域进出全屏**(`hooks/useDoubleTap.ts` + `hooks/useIsTouchDevice.ts`):中间区域单击本来就是呼出菜单,现在双击再切一次全屏,两个动作在同一块屏幕上,得先等一小会儿看有没有第二下。`useDoubleTap` 把这段窗口做成纯函数 `decideDoubleTap`(第一下进 `tap` 窗口等第二下;第二下到达取消单击、改判双击),**双击回调在第二次点击的事件里同步执行**——浏览器只认用户手势上下文里的 `requestFullscreen`,挪进定时器再调会被直接拒绝。只在「触摸设备(`(hover: none)`)+ 支持元素全屏」时启用:桌面端根本不装这套,单击立刻生效,点中间呼出菜单的手感与以前完全一致;iOS 也不装(它不支持元素全屏)。三条中间点击路径(翻页模式的三分区覆盖层、文本滚动模式的 `handleZoneTap`、漫画滚动模式的 `onZone`)统一走 `centerTap()`,左右分区点击会 `cancel()` 掉待判定的单击,免得点完翻页又弹出菜单。菜单打开时整屏遮罩先吃掉那次点击,遮罩在中间区域关闭菜单的同时 `arm()` 一个双击窗口,「双击中间切全屏」在菜单开着时也成立。手机端再给阅读根节点挂 `touch-action: manipulation`,关掉浏览器自带的双击缩放(纵向滚动与双指缩放不受影响),避免同一手势被浏览器抢着缩一次。
|
||||
- 目录:整屏面板(顶部返回 + 书名 + 章数,Virtuoso 虚拟列表,定位并高亮当前章,点章跳转)。**必须渲染在底部菜单之外**:菜单带 `backdrop-blur`,会成为 `fixed` 后代的包含块,放里面 `h-full` 只能拿到菜单高度;历史上它写的是 `top-0 + bottom-full`,两者同时存在时高度被算成 0,整块目录完全看不见。
|
||||
|
||||
**本地书籍(对应 legado 本地 TXT / EPUB)**
|
||||
- 入口:书架页右上「本地导入」按钮(书架为空时另有「上传本地书籍」),支持 TXT / EPUB,单文件上限 64MB,上传后自动入库并直接进入阅读页。
|
||||
- 书架卡片:本地书打「本地」角标,右上角有删除按钮(二次确认),删除会连服务器上的文件一起清掉。
|
||||
- 存储:正文落盘 `data/reader/local/<bookID>.<txt|epub>`;目录信息与网络书共用 `reader_chapters`,用 `Tag` 记定位:TXT 存 UTF-8 规范化后文件内的字节区间 `start:end`,EPUB 存 zip 内的 XHTML 条目路径。读章只取所需区间/条目,不整本载入内存。
|
||||
- TXT:自动识别 BOM(UTF-8/UTF-16) 与 UTF-8 / GBK / Big5,统一转 UTF-8 落盘;目录按 legado 默认 TXT 规则切章(`第X章/节/卷/集/部/篇`、序章、楔子、番外等),并对「第一章的正文内容」这类正文行做启发式过滤,切不出章名时整本当一章「全文」,章前内容(书名/简介)并入第一章。
|
||||
- EPUB:`META-INF/container.xml` → OPF → `spine` 顺序出章。目录标题优先取 NCX / EPUB3 NAV,**逐 token 走并用栈收任意层级的 navPoint**——Epubor 等工具导出的 EPUB 常漏 `</navPoint>`,标题会整棵嵌进上一个节点,按固定层级解会丢掉一大半标题;取不到时依次退回正文首行 → 封面页(文件名含 cover 且该页只有图)标「封面」→ `<title>`(过滤 Cover/Table of Contents 这类无信息量的)→ `第 N 章`。
|
||||
- EPUB 图片:正文里的 `<img>` 在转纯文本时就地换成 `[img]<zip 条目>` 标记行(相对路径按该 XHTML 所在目录解析),下发前把标记换成签名地址 `/api/reader/local/asset?b=&p=&s=`(HMAC,`<img>` 带不了 JWT),前端把 `[img]` 开头的行渲染成居中图片(`max-width:100%` + `max-height:70vh`,保证不撑破分栏)。网络书正文不受影响。
|
||||
- 进度:与网络书同一套 `durChapter*` 字段,跨端一致;同名文件重复上传按覆盖更新处理(章数不变则保留进度)。
|
||||
|
||||
**音频书播放条(AudioPlayActivity + AudioPlayService,即「听书」)**
|
||||
- 背景与封面:书籍封面强模糊(blur 32px)铺满做底,叠一层很淡的主题底色(opacity 0.3)保住日/夜对比度;正中圆形显示封面原图(对应 legado `upCover` 的 ivBg 模糊图 + ivCover 圆图)。封面缺失或加载失败时退回主题色圆点,不留破图。
|
||||
- transport 行:上一章 | -15s | 播放暂停 | +15s | 下一章(SEEK_STEP=15s,进度按秒)。
|
||||
- 动作行(常驻底部,抽屉打开时仍可点):章节(目录选择,见下)、定时关闭、倍速、片头片尾。
|
||||
- 章节选择:底部抽屉列全部章节,定位到当前章、当前章高亮、点章即跳;卷名行不可点。
|
||||
- 定时关闭:0/5/10/15/30/60/90/180 分钟;暂停期间不倒计时;归零自动暂停播放;选定值持久化为下次默认(对应 AppConfig.ttsTimer 在服务启动时 setTimer)。
|
||||
- 倍速:滑杆 0.5–3.0(步进 0.1)+ 0.5/0.75/1/1.25/1.5/1.75/2/2.5/3 快捷档;持久化(对应 AudioPlay.playSpeed,Android 6 以下不支持调速)。
|
||||
- 跳过片头片尾:抽屉内两条滑杆(片头/片尾,秒,0 不跳过,上限 300),按书持久化(Book.openCredits/closeCredits,落库 books.open_credits / close_credits)。语义:全新开播(该章进度为 0)时 seek 到片头秒数;播放到 duration-片尾秒数即等同播完,有下一章则自动续播,末章则停在片尾处。**单位是秒,不是章数。**
|
||||
- 播放进度按秒记忆(节流 5s 上报),跨端一致;播完自动下一章。
|
||||
- legado 的「播放模式」(顺序/单章循环/随机/列表循环)与「音频服务唤醒锁」是客户端能力,Web 端未实现。
|
||||
|
||||
## 3. 搜索
|
||||
|
||||
文件:`<src>ui/book/search/` + `<src>model/webBook/SearchModel.kt`。
|
||||
|
||||
- 布局:顶部 SearchView + 转圈进度条 → 结果流 → 书架命中提示卡 → 搜索历史 chips + 清空 → 右下 开始/停止 悬浮按钮。
|
||||
- 结果项:封面、在书架角标、书源数角标(可换源数)、书名、作者、分类标签、最新章节、简介。
|
||||
- 多源并发:所有启用书源(按搜索范围过滤),固定线程池并发(全局设置 threadCount),单源 30s 超时。
|
||||
- 实时结果流:每源返回即刷新列表;结束后 onSearchFinish(isEmpty, hasMore)(任一源有结果即可翻页,searchPage++)。
|
||||
- 聚合去重 mergeItems 四档:书名或作者等于关键词 > kind 含关键词 > 书名/作者含关键词 > 其他;同名同作者合并为一项并 addOrigin(角标显示可换源数);档内按书源数降序。
|
||||
- 顶部菜单:精准搜索开关、搜索范围(分组/全选)、书源管理、日志。点结果 → 换源对话框/直接打开。
|
||||
|
||||
## 4. 发现
|
||||
|
||||
`<src>ui/main/explore/` + `ui/book/explore/`。布局:标题栏 → SwipeRefresh → 源选择行(当前源名 + 下拉、源内搜索、标签筛选、更多)→ 二级筛选条 → 分类标签条(横滑 chip,可展开)→ 书籍网格(封面+书名)→ 兜底列表。数据来自启用书源的 exploreUrl + ruleExplore;切源刷新标签;点标签拼 URL 加载、分页加载更多。
|
||||
|
||||
## 5. 书籍详情
|
||||
|
||||
`<src>ui/book/info/BookInfoActivity.kt`。布局:模糊封面背景 → 标题栏(返回/刷新/菜单)→ 下拉刷新 → 滚动区:封面 + 书名 + 作者 + 最新章节(点击刷新目录)+ 阅读时长 + 分类标签 + 分组行 + 书源行(换源)+ 目录入口行 → 双 Tab(简介 / 目录预览,可全屏、点章节跳读)→ 底部动作区:tv_shelf 加入/移出书架(描边按钮)+ tv_read 开始阅读/继续阅读(实心主色按钮)。菜单含置顶、去书源网页、登录、删除(勾选删缓存)、分享。
|
||||
|
||||
## 6. 目录页
|
||||
|
||||
`<src>ui/book/toc/`。布局:标题栏(返回 + 书名 + SearchView 搜章节)→ Tab(章节/书签)→ 章节 RecyclerView + 底部信息条(当前位置 + 跳顶/跳底)。菜单:倒序开关、使用净化替换、加载字数、长章分卷合并、TXT 目录规则。倒序即列表反转;卷名行可折叠;已读章节变色;点击章节回传 index 跳读。
|
||||
|
||||
## 7. 书源管理
|
||||
|
||||
- **主列表**:标题栏(SearchView 过滤 + 菜单)→ RecyclerView(item:域名、复选、启停 Switch、编辑、更多菜单、发现、快速调试、响应耗时条)→ 多选操作栏。菜单:排序(手动/自动/名称/URL/更新时间/响应时间/启用)、分组筛选(启用/禁用/需登录/无分组/启用发现/禁用发现)、添加书源(本地/网络/二维码)。
|
||||
- **编辑**:标题栏(保存/调试入口)→ 类型下拉 + 六个开关(启用/启用发现/CookieJar/段评/事件监听/自定义按钮)→ 六个 Tab:基本/搜索/发现/详情/目录/正文,每 Tab 为「标签 + 输入框 + 帮助弹层」表单。
|
||||
- **调试**:顶部 SearchView 输入关键词 → 串行执行 搜索→详情→目录→正文,日志逐条流式显示;可查看各阶段原始 HTML、切换探索分类调试。
|
||||
|
||||
## 8. 替换规则
|
||||
|
||||
- 列表页:标题栏(搜索 + 菜单:分组管理、启停筛选、添加、导入)→ RecyclerView(名称、分组、内容摘要、启停 Switch)→ 多选操作栏。
|
||||
- 编辑页字段:规则名 → 分组 → 替换规则(+ 正则开关 + 帮助)→ 替换为 → 作用于标题 / 作用于正文 → 作用范围(书名) → 排除范围 → 超时毫秒(order 隐含)。
|
||||
|
||||
## 9. 数据实体字段全集
|
||||
|
||||
**BookSource.kt**(rule* 为内嵌对象)
|
||||
|
||||
| 字段 | 类型 | 默认值 |
|
||||
|---|---|---|
|
||||
| bookSourceUrl | String | "" |
|
||||
| bookSourceName | String | "" |
|
||||
| bookSourceGroup | String? | null |
|
||||
| bookSourceType | Int (0文本/1音频/2图片/3文件/4视频) | 0 |
|
||||
| bookUrlPattern | String? | null |
|
||||
| customOrder | Int | 0 |
|
||||
| enabled | Boolean | true |
|
||||
| jsLib | String? | null |
|
||||
| enabledExplore | Boolean | true |
|
||||
| enabledCookieJar | Boolean? | true |
|
||||
| concurrentRate | String? | null |
|
||||
| header | String? | null |
|
||||
| loginUrl / loginUi / loginCheckJs / coverDecodeJs | String? | null |
|
||||
| bookSourceComment | String? | null |
|
||||
| variableComment | String? | null |
|
||||
| lastUpdateTime | Long | 0 |
|
||||
| respondTime | Long | 180000 |
|
||||
| weight | Int | 0 |
|
||||
| exploreUrl / exploreScreen | String? | null |
|
||||
| ruleExplore / ruleSearch / ruleBookInfo / ruleToc / ruleContent / ruleReview | 对象 | null |
|
||||
| eventListener / customButton | Boolean | false |
|
||||
|
||||
**Book.kt**
|
||||
|
||||
| 字段 | 类型 | 默认值 |
|
||||
|---|---|---|
|
||||
| bookUrl (PK) / tocUrl | String | "" / "" |
|
||||
| origin / originName | String | localTag / "" |
|
||||
| name / author | String | "" / "" |
|
||||
| kind / customTag / coverUrl / customCoverUrl / intro / customIntro / charset | String? | null |
|
||||
| type | Int (BookType) | text |
|
||||
| group | Long | 0 |
|
||||
| latestChapterTitle | String? | null |
|
||||
| latestChapterTime / lastCheckTime | Long | now |
|
||||
| lastCheckCount / totalChapterNum | Int | 0 |
|
||||
| durChapterTitle | String? | null |
|
||||
| durChapterIndex / durVolumeIndex / chapterInVolumeIndex / durChapterPos | Int | 0 |
|
||||
| durChapterTime | Long | now |
|
||||
| wordCount | String? | null |
|
||||
| canUpdate | Boolean | true |
|
||||
| order / originOrder | Int | 0 |
|
||||
| variable | String? | null |
|
||||
| readConfig(ReadConfig 内嵌) | reverseToc、pageAnim、reSegment、imageStyle、useReplaceRule、delTag、ttsEngine、splitLongChapter=true、readSimulating、startDate、startChapter、dailyChapters=3、openCredits=0、closeCredits=0、playMode=0、playSpeed=1.0、manga* 系列、mangaPageAnim | |
|
||||
|
||||
**BookChapter.kt**
|
||||
|
||||
| 字段 | 类型 | 默认值 |
|
||||
|---|---|---|
|
||||
| url / title | String | "" / "" |
|
||||
| isVolume | Boolean | false |
|
||||
| baseUrl / bookUrl | String | "" / "" |
|
||||
| index | Int | 0 |
|
||||
| isVip / isPay | Boolean | false |
|
||||
| resourceUrl / tag / wordCount | String? | null |
|
||||
| start / end | Long? | null |
|
||||
| startFragmentId / endFragmentId / variable / imgUrl | String? | null |
|
||||
|
||||
**ReplaceRule.kt**
|
||||
|
||||
| 字段 | 类型 | 默认值 |
|
||||
|---|---|---|
|
||||
| id | Long | now |
|
||||
| name | String | "" |
|
||||
| group | String? | null |
|
||||
| pattern | String | "" |
|
||||
| replacement | String | "" |
|
||||
| scope | String? | null |
|
||||
| scopeTitle | Boolean | false |
|
||||
| scopeContent | Boolean | true |
|
||||
| excludeScope | String? | null |
|
||||
| isEnabled | Boolean | true |
|
||||
| isRegex | Boolean | true |
|
||||
| timeoutMillisecond | Long | 3000 |
|
||||
| order | Int | Int.MIN_VALUE |
|
||||
|
||||
## 10. 主题与视觉
|
||||
|
||||
- 全局:主背景 `#F7F7FA`、主文字 `#DE000000`、品牌色 `#FFF6FBF8`(浅绿白调)。
|
||||
- 界面主题由 ThemeConfig(themes.json)控制 6 套;阅读菜单/底栏用 bottomBackground(跟随所选界面主题),沉浸模式(readBarStyleFollowPage)直接取页面背景/文字色。
|
||||
- 强调色 accentColor 用于选中态、光标、Tab 选中;E-Ink 模式菜单改描边。
|
||||
- 视觉风格:大圆角面板、1dp 描边、玻璃拟态半透明条、图标+文字标签的动作面板。
|
||||
|
||||
## Web 版实现要点
|
||||
|
||||
- 正文分页仿 ReadView 三页缓存 + 9 宫格点击映射。
|
||||
- 主题模型照抄 ReadBookConfig.Config(含日/夜/E-Ink 三态字段),内置 6 套主题色值直接使用上表。
|
||||
- 搜索并发用 Promise 池 + 流式合并,合并逻辑照抄 mergeItems 四档排序。
|
||||
- 搜索分页:滚到底自动取下一页(`POST /reader/search` 的 `page`,从 1 开始,对应书源 `searchUrl` 的 `{{page}}`),逐页增量合并(跨页按「书名+作者」去重、并书源,见 `utils/searchBooks.ts`)。收口比 legado 严一档:**新一页没带来新书就停止翻页**——不支持分页的源每页都重复返回首页结果,照 legado「任一源有结果即可翻页」会一直转圈加载;单次搜索最多 20 页。
|
||||
- 书源/替换编辑器按第 7/8 节 Tab/字段一一对应。
|
||||
@@ -1,36 +0,0 @@
|
||||
# Segment Coverage Implementation Plan
|
||||
|
||||
> **For Claude:** REQUIRED SUB-SKILL: Use superpowers:executing-plans to implement this plan task-by-task.
|
||||
|
||||
**Goal:** IntroDB prewarm + same-season intro propagation + shorter miss TTL + playback-only duration probe (option C).
|
||||
|
||||
**Architecture:** Extend `MediaSegmentService` for merge/propagate/prewarm; add scheduler job `segment_prewarm`; repository queries for candidates and season siblings.
|
||||
|
||||
**Tech Stack:** Go, GORM/SQLite, existing SchedulerService + IntroDB client.
|
||||
|
||||
---
|
||||
|
||||
### Task 1: Negative cache TTL + ledgerFresh tests
|
||||
|
||||
**Files:** `internal/service/media_segment.go`, `internal/service/media_segment_test.go`
|
||||
|
||||
- Change `segmentMissingTTL` to 24h; update tests for fresh/stale miss.
|
||||
|
||||
### Task 2: Playback merge + propagation
|
||||
|
||||
**Files:** `media_segment.go`, `media_segment_repository.go`, `media_repository.go`, tests
|
||||
|
||||
- Constant `PropagatedSource = "propagated"`.
|
||||
- `ListForPlayback` merges sources with priority manual > theintrodb > propagated.
|
||||
- After successful IntroDB refresh with intro, propagate to same-season siblings (shared `tm_db_id` or `series_id`).
|
||||
|
||||
### Task 3: Prewarm API + scheduler job
|
||||
|
||||
**Files:** `media_segment.go`, `media_segment_repository.go`, `scheduler.go`, `scheduler_segment_jobs.go`, `service_builder.go`, tests
|
||||
|
||||
- `Prewarm(ctx, limit)` rate-limited refreshes.
|
||||
- Job `segment_prewarm` every 6h.
|
||||
|
||||
### Task 4: Verify
|
||||
|
||||
- `go test` for affected packages.
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user