Compare commits

...

19 Commits

Author SHA1 Message Date
truewhile c9c612df1b bug处理 2026-09-23 23:07:01 +08:00
truewhile e2cd32af53 处理yamby继续播放bug 2026-09-23 22:31:09 +08:00
truewhile 28485ed429 优化 2026-09-23 17:01:08 +08:00
truewhile 34ccf14cda 优化视频头尾跳过功能 2026-09-23 16:07:28 +08:00
truewhile 44fde6c5a0 优化 2026-09-23 13:53:50 +08:00
truewhile 94ef0116b1 添加跳过片头片尾功能 2026-09-23 10:22:13 +08:00
truewhile 016c6687e9 优化起播 2026-09-22 22:30:52 +08:00
truewhile b5ce4646cf 添加新功能,完善项目 2026-09-22 16:22:29 +08:00
truewhile 47899284a5 优化缩略图 2026-09-20 15:16:40 +08:00
truewhile c24ebe181d 优化缩略图 2026-09-20 14:13:49 +08:00
truewhile 9b2b592003 优化 2026-09-20 13:33:45 +08:00
truewhile 0c4668c156 优化 2026-09-19 21:30:32 +08:00
truewhile 474513f18a bug处理 2026-09-18 23:35:56 +08:00
truewhile 0810bfb234 bug处理 2026-09-18 22:52:09 +08:00
truewhile 61a7260eaf 优化,现有bug处理 2026-09-18 21:55:12 +08:00
truewhile 45f4763b0c 添加metatube部署文件 2026-09-18 12:00:04 +08:00
truewhile f4f57759ce 优化移动端播放 2026-09-18 11:28:33 +08:00
truewhile 6ec9adc976 优化移动端播放 2026-09-18 10:09:08 +08:00
truewhile f4abdf78e2 优化在线字幕 2026-09-17 23:53:22 +08:00
214 changed files with 17959 additions and 791 deletions
+216
View File
@@ -0,0 +1,216 @@
# 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:
test: ["CMD-SHELL", "busybox wget -qO- http://127.0.0.1:8080/api/health || exit 1"]
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"
+3 -20
View File
@@ -44,30 +44,13 @@ services:
# 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
- ./media: /media
environment:
TZ: Asia/Shanghai
PUID: "1000"
PGID: "1000"
PUID: "0"
PGID: "0"
MEBOX_APP_HOST: 0.0.0.0
MEBOX_APP_PORT: 8080
-190
View File
@@ -1,190 +0,0 @@
# 【开源推荐】MeBox:把 NAS / 网盘 / 远程 Emby 统一家里的观影入口,Docker 一键部署
> 配图已托管在 GitHub 仓库(`raw.githubusercontent.com` 直链),发帖时可直接引用,或下载 `docs/tutorial-screenshots/` 后作为附件上传。
---
## 写在前面
给论坛的朋友们推荐一个我维护的开源项目 —— **MeBox**,一个面向 NAS 与家庭影音场景的**自托管私人媒体中心**(GPL-3.0,Go + React)。
GitHub:https://github.com/truewhile/MeBox
一句话介绍:**部署一个服务,同时获得媒体库后台、网盘 STRM 整理、Emby 客户端协议网关三件套。** 内置完整 Emby/Jellyfin 服务端协议实现——手机、电视、平板上的 Infuse、SenPlayer、Fileball、Emby/Jellyfin 官方客户端直接「添加 Emby 服务器」就能连,一套账号体系全搞定,Emby 老用户零学习成本。
项目 fork 自 MediaStationGo 并持续二开,围绕网盘播放、任务队列、远程挂载和权限体系做了大量增强。
---
## 它能解决什么问题?
家里看电影电视的痛点,MeBox 基本一把梭:
| 痛点 | MeBox 的解法 |
| --- | --- |
| 硬盘散落各处,海报墙乱七八糟 | 多根目录媒体库 + TMDb/Bangumi/Douban 自动刮削,海报墙、继续观看、多季剧集一应俱全 |
| 网盘资源看一部下一部太麻烦 | OpenList / CloudDrive2 / 115 / WebDAV 接入,STRM 同步 + 直链/302 播放,不占本地空间 |
| 已经有一台 Emby,出门还得开 App | **远程 Emby 挂载**:把远程 Emby 的媒体库直接挂进 MeBox 界面统一浏览 |
| 家人乱动设置、小孩看不该看的 | 多用户 + 有效期 + 成人内容开关 + 播放配置 PIN,细粒度权限 |
| 每个设备装一套专属 App 太折腾 | **完整兼容 Emby/Jellyfin 客户端**:Infuse、SenPlayer、Fileball、官方客户端按「添加 Emby 服务器」填地址 + MeBox 账号即可,海报墙、观看进度、多用户直接同步 |
---
## 特点一览
**1. 现代化 Web UI,海报墙开箱即用**
![登录页](https://raw.githubusercontent.com/truewhile/MeBox/main/docs/tutorial-screenshots/01-login.png)
深色系登录页,默认账号 `admin / admin123`(首次登录请立即改密)。
![首页](https://raw.githubusercontent.com/truewhile/MeBox/main/docs/tutorial-screenshots/02-home.png)
首页自带焦点推荐轮播 + 媒体库入口卡片,继续观看、最近添加直接呈现。
**2. 媒体库与刮削**
![媒体库总览](https://raw.githubusercontent.com/truewhile/MeBox/main/docs/tutorial-screenshots/03-libraries.png)
20 个媒体库、1600+ 条目一眼尽收:每库自带封面拼贴、条目数统计,支持「全库修复+重刮」「刮削队列」批量处理。
![海报墙](https://raw.githubusercontent.com/truewhile/MeBox/main/docs/tutorial-screenshots/04-library-posters.png)
库内海报墙带评分、集数角标,支持按最后集添加日期排序,点开即看。
**3. 详情页与多季管理**
![详情页](https://raw.githubusercontent.com/truewhile/MeBox/main/docs/tutorial-screenshots/05-media-detail.png)
剧情简介、类型标签、多季分集(特别篇/第 1-N 季)、每集缩略图与时长;一键立即播放、调用外部播放器、加入收藏。
**4. Emby/Jellyfin 客户端无缝兼容**
这是我最想强调的一点:**MeBox 内置了完整的 Emby 服务端协议实现**。手机、电视、平板上的 Infuse、SenPlayer、Fileball,甚至 Emby/Jellyfin 官方客户端,都不需要任何插件或改造——按「添加 Emby 服务器」填入 `http://服务器IP:18080`,用 MeBox 账号登录,海报墙、观看进度、收藏、多用户权限全部无缝衔接。已经习惯 Emby 生态的朋友可以零成本迁移,家人只用电视端 App 也完全无感。
**5. 网页播放器 + 弹幕自动匹配**
![播放器与弹幕](https://raw.githubusercontent.com/truewhile/MeBox/main/docs/tutorial-screenshots/06-player-danmu.png)
内置网页播放器支持 HLS 转码、字幕、播放配置档;**弹幕按剧名自动匹配全季分集**(截图中自动匹配到《一拳超人》39 集),屏幕占比/透明度/字号随意调,追新番体验直接拉满。
**6. 网盘 STRM:网盘当本地盘用**
![STRM 管理](https://raw.githubusercontent.com/truewhile/MeBox/main/docs/tutorial-screenshots/07-strm-cloud.png)
添加网盘账号(**115 支持二维码扫码登录**)→ 添加同步目录 → 系统把网盘/本地目录里的视频生成 `.strm` 文件,元数据经下载/上传队列双向同步,播放走直链/302 不落盘。
**7. 远程 Emby 挂载(特色功能)**
![Emby 挂载](https://raw.githubusercontent.com/truewhile/MeBox/main/docs/tutorial-screenshots/08-emby-mount.png)
已有远程 Emby 服务器?填一次账号,按需勾选要挂载的媒体库(支持同服务器多线路自动切换、直连开关、排序),远程库直接出现在 MeBox 首页,不必再开 Emby 客户端。
**8. 任务队列统一管理**
![任务队列](https://raw.githubusercontent.com/truewhile/MeBox/main/docs/tutorial-screenshots/09-task-queue.png)
刮削 / 下载 / 上传三类任务统一看板,排队中、进行中、已匹配、失败分类计数,支持搜索与批量清理。
**9. 下载与自动整理**
![文件管理](https://raw.githubusercontent.com/truewhile/MeBox/main/docs/tutorial-screenshots/11-file-manager.png)
配合任意下载器(qBittorrent、Transmission 等下载到本地目录即可),MeBox 定时自动整理入媒体库:智能分类子库、自动注册目的地媒体库、复制/移动/硬链/软链多种整理方式,命名规则可配。
**10. 多用户与权限**
![用户管理](https://raw.githubusercontent.com/truewhile/MeBox/main/docs/tutorial-screenshots/12-user-admin.png)
管理员/普通用户分级、单实例用户数上限、账号有效期、成人内容开关、播放配置 PIN——给家人开号放心给。
**11. 运维省心**
![系统设置](https://raw.githubusercontent.com/truewhile/MeBox/main/docs/tutorial-screenshots/10-settings.png)
FFmpeg/FFprobe 一键下载安装、转码与硬件加速开关、TMDb 语言、识别词、弹幕、Adult/NSFW 开关全在设置页分组管理;另有 DLNA 投屏、存储统计、海报墙聚合视图:
![海报墙聚合](https://raw.githubusercontent.com/truewhile/MeBox/main/docs/tutorial-screenshots/13-poster-wall.png)
---
## 使用教程:从零到海报墙只要 5 步
### 第 1 步:Docker 一键部署
推荐 Docker Compose(仓库提供 4 份互相独立的完整模板,无需 `.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 档、Redis 档、OpenSearch 档,见仓库 README「部署档位」
docker compose up -d
```
浏览器访问 `http://服务器IP:18080`,镜像:`ghcr.io/truewhile/mebox:latest`(amd64 / arm64 都有,也提供 Windows/Linux/macOS 单文件可执行程序,不想装 Docker 直接下载跑)。
### 第 2 步:登录并修改密码
默认账号 `admin / admin123`,登录后右上角头像 → 个人资料修改密码。
### 第 3 步:创建媒体库 + 扫库
后台 → 媒体库 → 管理媒体库,添加本地路径(Docker 部署记得填**容器内**路径,如 `/media/电影`,`volumes` 左侧挂宿主机真实目录)→ 执行扫库。
### 第 4 步:配置元数据刮削
系统设置 → 外部 API,填入 TMDb / Bangumi / Douban 等 API Key;媒体库页可对单个库「全库修复+重刮」,刮削进度在任务队列实时可见。
### 第 5 步(可选但强烈推荐):
- **网盘用户**:STRM 管理 → 添加网盘账号(115 可扫码)→ 添加同步目录 → 生成 STRM 后直链播放;
- **已有 Emby**:Emby 挂载 → 添加 Emby 账号 → 勾选要挂载的媒体库;
- **第三方播放器(Emby 客户端全兼容)**:Infuse / SenPlayer / Fileball / Emby、Jellyfin 官方客户端,按「添加 Emby 服务器」填 `http://服务器IP:18080`,用 MeBox 账号登录即可,原有使用习惯完全不变;
- **下载党**:qBittorrent 等任意下载器把视频下到下载目录,在文件管理里把它设为整理源,下完自动分类入库。
### 路径映射小抄(Docker 最常见坑)
```yaml
volumes:
- /vol1/1000/Media:/media # 左:宿主机真实路径;右:容器内路径(网页里填这个)
environment:
MEBOX_MEDIA_DIR: /vol1/1000/Media
MEBOX_MEDIA_CONTAINER_DIR: /media
```
硬链接要求同一文件系统/子卷,跨盘请改复制或软链。
---
## 部署档位怎么选?
| 档位 | 文件 | 组件 | 适合 |
| --- | --- | --- | --- |
| 极简 | `docker-compose.simple.yml` | 单镜像 + SQLite | 个人使用、低配设备 |
| 标准 | `docker-compose.yml` | + PostgreSQL | 多用户家庭共享 |
| 增强 | `docker-compose.standard.yml` | + Redis | 大媒体库高频访问 |
| 搜索 | `docker-compose.search.yml` | + OpenSearch | 超大库全文搜索 |
---
## 技术栈与致谢
- 后端:Go · Gin · GORM · SQLite/PostgreSQL · 可选 Redis / OpenSearch
- 前端:React 18 · Vite · TypeScript · Tailwind CSS · Zustand
- 部署:Docker Compose 多档模板,amd64/arm64 镜像 + 单文件可执行
感谢上游 [MediaStationGo](https://github.com/ShukeBta/MediaStationGo) 的奠基,网盘同步/STRM/整理部分参考了 [qmediasync](https://github.com/qicfan/qmediasync) 的思路。
---
## 链接
- GitHub:https://github.com/truewhile/MeBox
- Issue / PR:欢迎提 bug(附部署方式+复现步骤+日志)与功能建议
- License:GPL-3.0
觉得有用的话求个 Star ⭐,也欢迎论坛里的朋友反馈使用体验,我长期维护。
Binary file not shown.

Before

Width:  |  Height:  |  Size: 620 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 743 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 793 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 612 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 85 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 247 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 376 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 285 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 319 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 306 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 265 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.1 MiB

+3 -2
View File
@@ -44,9 +44,10 @@ func setDefaults(v *viper.Viper) {
v.SetDefault("logging.max_backups", 10)
v.SetDefault("cache.cache_dir", "./cache")
v.SetDefault("cache.images_max_size_mb", 500)
v.SetDefault("cache.images_max_size_mb", 2000)
v.SetDefault("cache.images_originals_max_size_mb", 256)
v.SetDefault("cache.images_originals_ttl_hours", 168)
v.SetDefault("cache.memory_max_size_mb", DefaultCacheMemoryMaxSizeMB)
v.SetDefault("cache.cleanup_interval_min", 60)
v.SetDefault("cache.redis_url", "")
v.SetDefault("cache.redis_prefix", "mebox")
v.SetDefault("cache.media_ttl_seconds", 90)
+6
View File
@@ -47,6 +47,12 @@ func (c *Config) normalize() error {
if c.Cache.ImagesMaxSizeMB < 0 {
c.Cache.ImagesMaxSizeMB = 0
}
if c.Cache.ImagesOriginalsMaxSizeMB < 0 {
c.Cache.ImagesOriginalsMaxSizeMB = 0
}
if c.Cache.ImagesOriginalsTTLHours < 0 {
c.Cache.ImagesOriginalsTTLHours = 0
}
if c.Cache.MemoryMaxSizeMB <= 0 {
c.Cache.MemoryMaxSizeMB = DefaultCacheMemoryMaxSizeMB
}
+10 -8
View File
@@ -117,15 +117,17 @@ type LoggingConfig struct {
type CacheConfig struct {
CacheDir string `mapstructure:"cache_dir"`
ImagesMaxSizeMB int `mapstructure:"images_max_size_mb"`
// ImagesOriginalsMaxSizeMB 限制 cache/images 下原图子配额(MB)。原图只是
// 生成缩略图的原料,丢了可以重新回源;0 表示不单独限制(只受总量约束)。
ImagesOriginalsMaxSizeMB int `mapstructure:"images_originals_max_size_mb"`
// ImagesOriginalsTTLHours 是原图的保留时长(小时),超过即删除;0 表示
// 不按时间淘汰。缩短它能让原图缓存保持在一个滚动窗口内。
ImagesOriginalsTTLHours int `mapstructure:"images_originals_ttl_hours"`
// MemoryMaxSizeMB 限制进程内 L1 缓存总字节数,JSON/对象缓存共用该预算。
MemoryMaxSizeMB int `mapstructure:"memory_max_size_mb"`
MaxDiskUsageMB int `mapstructure:"max_disk_usage_mb"`
TTLHours int `mapstructure:"ttl_hours"`
AutoCleanup bool `mapstructure:"auto_cleanup"`
CleanupIntervalMin int `mapstructure:"cleanup_interval_min"`
RedisURL string `mapstructure:"redis_url"`
RedisPrefix string `mapstructure:"redis_prefix"`
MediaTTLSeconds int `mapstructure:"media_ttl_seconds"`
MemoryMaxSizeMB int `mapstructure:"memory_max_size_mb"`
RedisURL string `mapstructure:"redis_url"`
RedisPrefix string `mapstructure:"redis_prefix"`
MediaTTLSeconds int `mapstructure:"media_ttl_seconds"`
// EmbyLatestTTLSeconds 是 Emby「最新添加」(Items/Latest) 的缓存时长。
// 客户端刷新首页时会并发请求全部媒体库的 Latest(生产环境观察到 73 个
// 并发),缓存过短会让这批请求同时穿透并各自重建 payload,在低配主机
+26 -2
View File
@@ -20,6 +20,12 @@ type settingReq struct {
Value string `json:"value"`
}
// maskedSettingKeys 里的设置值绝不能被完整下发:它们是可用于对外操作的凭据。
// 下发脱敏值,保存时再靠 isMaskedSettingValue 还原为「保持原值」。
var maskedSettingKeys = map[string]bool{
service.SettingTelegramBotToken: true,
}
func listSettingsHandler(svc *service.Container) gin.HandlerFunc {
return func(c *gin.Context) {
settings, err := svc.Repo.Setting.All(c.Request.Context())
@@ -27,10 +33,21 @@ func listSettingsHandler(svc *service.Container) gin.HandlerFunc {
c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
return
}
for i := range settings {
if maskedSettingKeys[settings[i].Key] {
settings[i].Value = service.MaskSecret(settings[i].Value)
}
}
c.JSON(http.StatusOK, settings)
}
}
// isMaskedSettingValue 识别「前端把脱敏值原样提交回来」的情况。此时必须保留
// 已存的真实值,否则一次保存就会把凭据覆盖成 ***。
func isMaskedSettingValue(value string) bool {
return strings.Contains(value, "***")
}
func updateSettingHandler(svc *service.Container) gin.HandlerFunc {
return func(c *gin.Context) {
var req settingReq
@@ -38,6 +55,11 @@ func updateSettingHandler(svc *service.Container) gin.HandlerFunc {
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
return
}
// 脱敏值回传 == 用户没改这个凭据,保留库里已存的真实值。
if maskedSettingKeys[req.Key] && isMaskedSettingValue(req.Value) {
c.Status(http.StatusNoContent)
return
}
oldValue := ""
if req.Key == service.AdultLibraryIDsSettingKey {
oldValue, _ = svc.Repo.Setting.Get(c.Request.Context(), req.Key)
@@ -65,8 +87,10 @@ func updateSettingHandler(svc *service.Container) gin.HandlerFunc {
if req.Key == "transcode.hw_enabled" || req.Key == "transcode.hw_accel" || req.Key == "transcoder.hardware_accel" || req.Key == "transcoder.encoder" {
svc.Transcoder.StopAll()
}
if req.Key == "cache.images_max_size_mb" && svc.Scheduler != nil {
_ = svc.Scheduler.RunNowAsync(c.Request.Context(), "image_cache_cleanup")
if req.Key == "cache.images_max_size_mb" || req.Key == "cache.images_originals_max_size_mb" || req.Key == "cache.images_originals_ttl_hours" {
if svc.Scheduler != nil {
_ = svc.Scheduler.RunNowAsync(c.Request.Context(), "image_cache_cleanup")
}
}
if req.Key == "cache.memory_max_size_mb" && svc.Cache != nil {
svc.Cache.SetMaxSizeMB(svc.Cfg.Cache.MemoryMaxSizeMB)
+173
View File
@@ -0,0 +1,173 @@
package handler
import (
"net/http"
"strings"
"github.com/gin-gonic/gin"
"github.com/truewhile/MeBox/internal/middleware"
"github.com/truewhile/MeBox/internal/model"
"github.com/truewhile/MeBox/internal/service"
)
// 设备管理接口。
//
// 普通用户只能操作自己的设备(路由挂在 /me 下,用户 ID 始终取自会话);
// 管理员通过 /admin/users/:id/devices 代管任意用户。两组接口共用同一份
// DeviceService,因此「谁上线过、谁被踢掉」只有一处事实来源。
// deviceListPayload 是设备列表的下发形状。Fingerprint 不外发:它是防共享
// 判定用的内部标识,暴露出去只会方便伪造。
type deviceListPayload struct {
Devices []devicePayload `json:"devices"`
}
type devicePayload struct {
ID string `json:"id"`
DeviceID string `json:"device_id"`
DeviceName string `json:"device_name,omitempty"`
Client string `json:"client,omitempty"`
LastIP string `json:"last_ip,omitempty"`
LastSeenAt string `json:"last_seen_at,omitempty"`
LastPlayAt string `json:"last_play_at,omitempty"`
Kicked bool `json:"kicked"`
Online bool `json:"online"`
Playing bool `json:"playing"`
Warnings int `json:"warnings"`
}
func toDevicePayload(d model.UserDevice) devicePayload {
out := devicePayload{
ID: d.ID,
DeviceID: d.DeviceID,
DeviceName: d.DeviceName,
Client: d.Client,
LastIP: d.LastIP,
Kicked: d.Kicked,
Online: d.Online,
Playing: d.Playing,
Warnings: d.Warnings,
}
if !d.LastSeenAt.IsZero() {
out.LastSeenAt = d.LastSeenAt.Format("2006-01-02T15:04:05Z07:00")
}
if d.LastPlayAt != nil && !d.LastPlayAt.IsZero() {
out.LastPlayAt = d.LastPlayAt.Format("2006-01-02T15:04:05Z07:00")
}
return out
}
func deviceListResponse(devices []model.UserDevice) deviceListPayload {
items := make([]devicePayload, 0, len(devices))
for _, d := range devices {
items = append(items, toDevicePayload(d))
}
return deviceListPayload{Devices: items}
}
// myDevicesHandler 返回当前会话用户的设备列表。
func myDevicesHandler(svc *service.Container) gin.HandlerFunc {
return func(c *gin.Context) {
userID := sessionUserID(c)
devices, err := svc.Device.ListDevices(c.Request.Context(), userID)
if err != nil {
c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
return
}
c.JSON(http.StatusOK, deviceListResponse(devices))
}
}
// myKickDeviceHandler 踢掉当前用户的一台设备。
func myKickDeviceHandler(svc *service.Container) gin.HandlerFunc {
return func(c *gin.Context) {
userID := sessionUserID(c)
deviceID := strings.TrimSpace(c.Param("deviceID"))
if deviceID == "" {
c.JSON(http.StatusBadRequest, gin.H{"error": "device id required"})
return
}
if err := svc.Device.KickDevice(c.Request.Context(), userID, deviceID); err != nil {
c.JSON(http.StatusNotFound, gin.H{"error": err.Error()})
return
}
c.Status(http.StatusNoContent)
}
}
// myKickAllDevicesHandler 踢掉当前用户的全部设备。
func myKickAllDevicesHandler(svc *service.Container) gin.HandlerFunc {
return func(c *gin.Context) {
userID := sessionUserID(c)
if err := svc.Device.KickAllDevices(c.Request.Context(), userID); err != nil {
c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
return
}
c.Status(http.StatusNoContent)
}
}
// adminUserDevicesHandler 返回指定用户的设备列表。
func adminUserDevicesHandler(svc *service.Container) gin.HandlerFunc {
return func(c *gin.Context) {
userID := strings.TrimSpace(c.Param("id"))
// FindByID 对「不存在」返回 (nil, nil),必须判空而不是判 error,
// 否则「用户不存在」会伪装成「该用户没有设备」的空列表。
user, err := svc.Repo.User.FindByID(c.Request.Context(), userID)
if err != nil {
c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
return
}
if user == nil {
c.JSON(http.StatusNotFound, gin.H{"error": "user not found"})
return
}
devices, err := svc.Device.ListDevices(c.Request.Context(), userID)
if err != nil {
c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
return
}
c.JSON(http.StatusOK, deviceListResponse(devices))
}
}
// adminKickUserDeviceHandler 由管理员踢掉指定用户的一台设备。
func adminKickUserDeviceHandler(svc *service.Container) gin.HandlerFunc {
return func(c *gin.Context) {
userID := strings.TrimSpace(c.Param("id"))
deviceID := strings.TrimSpace(c.Param("deviceID"))
if deviceID == "" {
c.JSON(http.StatusBadRequest, gin.H{"error": "device id required"})
return
}
if err := svc.Device.KickDevice(c.Request.Context(), userID, deviceID); err != nil {
c.JSON(http.StatusNotFound, gin.H{"error": err.Error()})
return
}
c.Status(http.StatusNoContent)
}
}
// adminKickAllUserDevicesHandler 由管理员踢掉指定用户的全部设备。
func adminKickAllUserDevicesHandler(svc *service.Container) gin.HandlerFunc {
return func(c *gin.Context) {
userID := strings.TrimSpace(c.Param("id"))
if err := svc.Device.KickAllDevices(c.Request.Context(), userID); err != nil {
c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
return
}
c.Status(http.StatusNoContent)
}
}
// sessionUserID 读取会话用户 ID。调用方路由都挂在鉴权中间件之后,因此这里
// 只做类型断言兜底,不做权限判断。
func sessionUserID(c *gin.Context) string {
if v, ok := c.Get(middleware.CtxUserID); ok {
if s, ok := v.(string); ok {
return s
}
}
return ""
}
+232
View File
@@ -0,0 +1,232 @@
package handler
import (
"context"
"encoding/json"
"net/http"
"net/http/httptest"
"strings"
"testing"
"github.com/gin-gonic/gin"
"github.com/glebarez/sqlite"
"go.uber.org/zap"
"gorm.io/gorm"
"github.com/truewhile/MeBox/internal/middleware"
"github.com/truewhile/MeBox/internal/model"
"github.com/truewhile/MeBox/internal/repository"
"github.com/truewhile/MeBox/internal/service"
)
// newDeviceTestEnv 搭一个只挂设备/Telegram 路由的最小环境,并预置两个用户,
// 用于验证「只能操作自己的设备」这条边界。
func newDeviceTestEnv(t *testing.T) (*gin.Engine, *service.Container) {
t.Helper()
gin.SetMode(gin.TestMode)
db, err := gorm.Open(sqlite.Open(":memory:"), &gorm.Config{})
if err != nil {
t.Fatalf("open db: %v", err)
}
if err := db.AutoMigrate(&model.User{}, &model.UserDevice{}, &model.Setting{}); err != nil {
t.Fatalf("migrate: %v", err)
}
repos := repository.New(db)
svc := &service.Container{Repo: repos, Log: zap.NewNop()}
svc.Device = service.NewDeviceService(zap.NewNop(), repos)
svc.Device.SetSessionTracker(service.NewSessionTrackerService(zap.NewNop()))
svc.Telegram = service.NewTelegramService(zap.NewNop(), repos)
const secret = "test-secret"
router := gin.New()
authed := router.Group("/api", func(c *gin.Context) {
// 测试里直接注入会话身份,绕开真实 JWT 解析。
if uid := c.GetHeader("X-Test-User"); uid != "" {
c.Set(middleware.CtxUserID, uid)
c.Set(middleware.CtxUserRole, c.GetHeader("X-Test-Role"))
}
c.Next()
})
authed.GET("/me/devices", myDevicesHandler(svc))
authed.POST("/me/devices/kick-all", myKickAllDevicesHandler(svc))
authed.POST("/me/devices/:deviceID/kick", myKickDeviceHandler(svc))
authed.GET("/me/telegram", getTelegramStatusHandler(svc))
authed.POST("/me/telegram/bind-code", startTelegramBindHandler(svc))
authed.DELETE("/me/telegram", unbindTelegramHandler(svc))
authed.GET("/admin/users/:id/devices", adminUserDevicesHandler(svc))
authed.POST("/admin/users/:id/devices/:deviceID/kick", adminKickUserDeviceHandler(svc))
_ = secret
return router, svc
}
func seedDeviceUsers(t *testing.T, svc *service.Container) {
t.Helper()
ctx := context.Background()
for _, id := range []string{"user-a", "user-b"} {
if err := svc.Repo.User.Create(ctx, &model.User{
Base: model.Base{ID: id}, Username: id, PasswordHash: "x", Role: "user", IsActive: true,
}); err != nil {
t.Fatal(err)
}
}
}
func doJSON(t *testing.T, router *gin.Engine, method, path, userID, role string) *httptest.ResponseRecorder {
t.Helper()
req := httptest.NewRequest(method, path, nil)
req.Header.Set("X-Test-User", userID)
if role != "" {
req.Header.Set("X-Test-Role", role)
}
w := httptest.NewRecorder()
router.ServeHTTP(w, req)
return w
}
// /me/devices 只能返回调用者自己的设备。
func TestMyDevicesScopedToCaller(t *testing.T) {
router, svc := newDeviceTestEnv(t)
seedDeviceUsers(t, svc)
ctx := context.Background()
svc.Device.RecordLogin(ctx, "user-a", "dev-a", "A-Phone", "Infuse", "1.1.1.1")
svc.Device.RecordLogin(ctx, "user-b", "dev-b", "B-Phone", "Infuse", "2.2.2.2")
w := doJSON(t, router, http.MethodGet, "/api/me/devices", "user-a", "user")
if w.Code != http.StatusOK {
t.Fatalf("status = %d body=%s", w.Code, w.Body.String())
}
var payload struct {
Devices []struct {
DeviceID string `json:"device_id"`
} `json:"devices"`
}
if err := json.Unmarshal(w.Body.Bytes(), &payload); err != nil {
t.Fatal(err)
}
if len(payload.Devices) != 1 || payload.Devices[0].DeviceID != "dev-a" {
t.Fatalf("devices = %+v, want only dev-a", payload.Devices)
}
// 设备指纹属于内部判定标识,不能下发。
if strings.Contains(w.Body.String(), "fingerprint") {
t.Fatalf("response must not expose fingerprint: %s", w.Body.String())
}
}
// 踢别人的设备必须失败:/me 路由用会话身份,deviceID 属于他人时查不到。
func TestKickForeignDeviceFails(t *testing.T) {
router, svc := newDeviceTestEnv(t)
seedDeviceUsers(t, svc)
svc.Device.RecordLogin(context.Background(), "user-b", "dev-b", "B-Phone", "Infuse", "2.2.2.2")
w := doJSON(t, router, http.MethodPost, "/api/me/devices/dev-b/kick", "user-a", "user")
if w.Code == http.StatusNoContent {
t.Fatal("user-a must not be able to kick user-b's device")
}
}
func TestMyKickOwnDeviceSucceeds(t *testing.T) {
router, svc := newDeviceTestEnv(t)
seedDeviceUsers(t, svc)
svc.Device.RecordLogin(context.Background(), "user-a", "dev-a", "A-Phone", "Infuse", "1.1.1.1")
w := doJSON(t, router, http.MethodPost, "/api/me/devices/dev-a/kick", "user-a", "user")
if w.Code != http.StatusNoContent {
t.Fatalf("status = %d body=%s", w.Code, w.Body.String())
}
}
// 管理员接口对不存在的用户返回 404,避免把「用户不存在」和「用户没有设备」
// 混成同一个空列表。
func TestAdminDevicesUnknownUserReturns404(t *testing.T) {
router, svc := newDeviceTestEnv(t)
seedDeviceUsers(t, svc)
w := doJSON(t, router, http.MethodGet, "/api/admin/users/nope/devices", "admin-1", "admin")
if w.Code != http.StatusNotFound {
t.Fatalf("status = %d, want 404", w.Code)
}
}
func TestTelegramStatusAndBindCode(t *testing.T) {
router, svc := newDeviceTestEnv(t)
seedDeviceUsers(t, svc)
w := doJSON(t, router, http.MethodGet, "/api/me/telegram", "user-a", "user")
if w.Code != http.StatusOK {
t.Fatalf("status = %d", w.Code)
}
if !strings.Contains(w.Body.String(), `"bound":false`) {
t.Fatalf("body = %s, want bound=false", w.Body.String())
}
w = doJSON(t, router, http.MethodPost, "/api/me/telegram/bind-code", "user-a", "user")
if w.Code != http.StatusOK {
t.Fatalf("status = %d body=%s", w.Code, w.Body.String())
}
var code struct {
Code string `json:"code"`
ExpiresIn int `json:"expires_in_seconds"`
}
if err := json.Unmarshal(w.Body.Bytes(), &code); err != nil {
t.Fatal(err)
}
if len(code.Code) != 6 {
t.Fatalf("code = %q, want 6 chars", code.Code)
}
if code.ExpiresIn <= 0 {
t.Fatalf("expires_in_seconds = %d, want > 0", code.ExpiresIn)
}
}
func TestAdminSettingsMasksBotToken(t *testing.T) {
router, svc := newDeviceTestEnv(t)
ctx := context.Background()
if err := svc.Repo.Setting.Set(ctx, service.SettingTelegramBotToken, "123456:AAHsecretTOKEN"); err != nil {
t.Fatal(err)
}
router.GET("/api/admin/settings", listSettingsHandler(svc))
router.PUT("/api/admin/settings", updateSettingHandler(svc))
w := doJSON(t, router, http.MethodGet, "/api/admin/settings", "admin-1", "admin")
if w.Code != http.StatusOK {
t.Fatalf("status = %d", w.Code)
}
if strings.Contains(w.Body.String(), "AAHsecretTOKEN") {
t.Fatalf("bot token leaked: %s", w.Body.String())
}
if !strings.Contains(w.Body.String(), "***") {
t.Fatalf("bot token should be masked: %s", w.Body.String())
}
}
// 把脱敏值原样提交回来时,必须保留库里真实 Token —— 否则一次保存就把凭据毁掉。
func TestSavingMaskedTokenKeepsRealValue(t *testing.T) {
router, svc := newDeviceTestEnv(t)
ctx := context.Background()
const real = "123456:AAHsecretTOKEN"
if err := svc.Repo.Setting.Set(ctx, service.SettingTelegramBotToken, real); err != nil {
t.Fatal(err)
}
router.PUT("/api/admin/settings", updateSettingHandler(svc))
body := `{"key":"telegram.bot_token","value":"12***EN"}`
req := httptest.NewRequest(http.MethodPut, "/api/admin/settings", strings.NewReader(body))
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-Test-User", "admin-1")
req.Header.Set("X-Test-Role", "admin")
w := httptest.NewRecorder()
router.ServeHTTP(w, req)
if w.Code != http.StatusNoContent {
t.Fatalf("status = %d body=%s", w.Code, w.Body.String())
}
got, err := svc.Repo.Setting.Get(ctx, service.SettingTelegramBotToken)
if err != nil {
t.Fatal(err)
}
if got != real {
t.Fatalf("stored token = %q, want the original value preserved", got)
}
}
+122
View File
@@ -0,0 +1,122 @@
package handler
import (
"net/http"
"strconv"
"strings"
"github.com/gin-gonic/gin"
"github.com/truewhile/MeBox/internal/service"
)
// Emby 发现类接口的 handler:NextUp / Similar / Genres。
//
// 这三个接口此前返回空列表,导致第三方客户端首页「接下来播放」、详情页
// 「相似推荐」、按类型浏览全部为空白。它们必须始终返回 200 + 合法信封,
// 因为客户端在首页刷新时会并发请求,任何 4xx/5xx 都会被判定为服务端异常。
func embyNextUpHandler(svc *service.Container) gin.HandlerFunc {
return func(c *gin.Context) {
userID := embyScopedUserID(c)
if userID == "" {
c.JSON(http.StatusOK, embyEmptyItemsPayload())
return
}
limit, _ := strconv.Atoi(embyFirstNonEmptyString(firstQueryValue(c, "Limit", "limit"), ""))
// YamBy / Emby 进剧集详情会带 SeriesId 请求「本剧下一集」。
// 忽略该参数会把全站 NextUp 第一条塞进详情页「继续播放」。
// 注意:不要把普通 ParentId(媒体库)当成 SeriesId,否则首页 NextUp 会被滤空。
seriesID := firstQueryValue(c, "SeriesId", "seriesId", "seriesid")
if seriesID == "" {
if parentID := firstQueryValue(c, "ParentId", "parentId", "parentid"); parentID != "" {
if strings.HasPrefix(parentID, "msgo-series-") || service.IsEmbyRemoteID(parentID) {
seriesID = parentID
}
}
}
out, err := svc.Emby.NextUp(c.Request.Context(), userID, seriesID, limit)
if err != nil {
c.JSON(http.StatusOK, embyEmptyItemsPayload())
return
}
embyAttachRequestTokenToMediaSources(c, out)
c.JSON(http.StatusOK, out)
}
}
// embyShowNextUpHandler 处理 /Shows/{id}/NextUp:把路径上的剧集 ID 当作 SeriesId。
func embyShowNextUpHandler(svc *service.Container) gin.HandlerFunc {
return func(c *gin.Context) {
userID := embyScopedUserID(c)
if userID == "" {
c.JSON(http.StatusOK, embyEmptyItemsPayload())
return
}
seriesID := strings.TrimSpace(c.Param("id"))
if seriesID == "" || strings.EqualFold(seriesID, "NextUp") {
c.JSON(http.StatusOK, embyEmptyItemsPayload())
return
}
limit, _ := strconv.Atoi(embyFirstNonEmptyString(firstQueryValue(c, "Limit", "limit"), ""))
out, err := svc.Emby.NextUp(c.Request.Context(), userID, seriesID, limit)
if err != nil {
c.JSON(http.StatusOK, embyEmptyItemsPayload())
return
}
embyAttachRequestTokenToMediaSources(c, out)
c.JSON(http.StatusOK, out)
}
}
func embySimilarHandler(svc *service.Container) gin.HandlerFunc {
return func(c *gin.Context) {
mediaID := strings.TrimSpace(c.Param("id"))
if mediaID == "" {
c.JSON(http.StatusOK, embyEmptyItemsPayload())
return
}
limit, _ := strconv.Atoi(embyFirstNonEmptyString(firstQueryValue(c, "Limit", "limit"), ""))
out, err := svc.Emby.SimilarItems(c.Request.Context(), mediaID, embyEffectiveUserID(c), limit)
if err != nil {
c.JSON(http.StatusOK, embyEmptyItemsPayload())
return
}
embyAttachRequestTokenToMediaSources(c, out)
c.JSON(http.StatusOK, out)
}
}
func embyGenresHandler(svc *service.Container) gin.HandlerFunc {
return func(c *gin.Context) {
parentID := firstQueryValue(c, "ParentId", "parentId", "parentid")
out, err := svc.Emby.Genres(c.Request.Context(), embyEffectiveUserID(c), parentID)
if err != nil {
c.JSON(http.StatusOK, embyEmptyItemsPayload())
return
}
c.JSON(http.StatusOK, out)
}
}
// embyScopedUserID 解析「按用户请求」的 Emby 接口的生效用户。
//
// 路由上带 :userId 时(/Users/{uid}/Shows/NextUp),只允许查询自己:客户端
// 偶尔会带着别人的 id 请求,直接采信等于开放他人观看历史的读取。管理员同样
// 按自己处理,避免出现一条无人使用的越权路径。
func embyScopedUserID(c *gin.Context) string {
caller := embyEffectiveUserID(c)
requested := strings.TrimSpace(c.Param("userId"))
if requested == "" {
return caller
}
if requested == caller {
return caller
}
return ""
}
// embyEmptyItemsPayload 与 embyEmptyItemsHandler 保持同一形状。
func embyEmptyItemsPayload() gin.H {
return gin.H{"Items": []any{}, "TotalRecordCount": 0}
}
+372
View File
@@ -0,0 +1,372 @@
package handler
import (
"context"
"encoding/json"
"net/http"
"net/http/httptest"
"strconv"
"testing"
"time"
"github.com/gin-gonic/gin"
"github.com/glebarez/sqlite"
"go.uber.org/zap"
"gorm.io/gorm"
"github.com/truewhile/MeBox/internal/config"
"github.com/truewhile/MeBox/internal/model"
"github.com/truewhile/MeBox/internal/repository"
"github.com/truewhile/MeBox/internal/service"
)
// newEmbyDiscoveryEnv 搭一个跑在内存库上的 Emby 路由环境。
func newEmbyDiscoveryEnv(t *testing.T) (*gin.Engine, *service.Container, string) {
t.Helper()
gin.SetMode(gin.TestMode)
db, err := gorm.Open(sqlite.Open(":memory:"), &gorm.Config{})
if err != nil {
t.Fatalf("open db: %v", err)
}
if err := db.AutoMigrate(
&model.User{}, &model.Library{}, &model.Media{}, &model.PlaybackHistory{},
&model.Setting{}, &model.Favorite{}, &model.UserDevice{},
); err != nil {
t.Fatalf("migrate: %v", err)
}
repos := repository.New(db)
cfg := &config.Config{}
cfg.Secrets.JWTSecret = "test-secret"
svc := &service.Container{Repo: repos, Log: zap.NewNop()}
svc.Emby = service.NewEmbyService(cfg, zap.NewNop(), repos).
SetDiscovery(service.NewMediaDiscoveryService(zap.NewNop(), repos))
const userID = "user-1"
if err := repos.User.Create(context.Background(), &model.User{
Base: model.Base{ID: userID}, Username: "tester", PasswordHash: "x",
Role: "user", IsActive: true,
}); err != nil {
t.Fatal(err)
}
router := gin.New()
registerEmbyRoutes(router, cfg.Secrets.JWTSecret, svc)
return router, svc, userID
}
func seedEmbyLibrary(t *testing.T, svc *service.Container, typ string) string {
t.Helper()
lib := &model.Library{Name: "库-" + typ, Path: "/media/" + typ, Type: typ, Enabled: true}
if err := svc.Repo.Library.Create(context.Background(), lib); err != nil {
t.Fatal(err)
}
return lib.ID
}
func embyGet(t *testing.T, router *gin.Engine, path, token string) *httptest.ResponseRecorder {
t.Helper()
req := httptest.NewRequest(http.MethodGet, path, nil)
if token != "" {
req.Header.Set("X-Emby-Token", token)
}
w := httptest.NewRecorder()
router.ServeHTTP(w, req)
return w
}
func decodeItemsEnvelope(t *testing.T, body []byte) []map[string]any {
t.Helper()
var payload struct {
Items []map[string]any `json:"Items"`
TotalRecordCount int64 `json:"TotalRecordCount"`
}
if err := json.Unmarshal(body, &payload); err != nil {
t.Fatalf("decode %s: %v", string(body), err)
}
return payload.Items
}
// NextUp 必须真的返回下一集,而不是空数组。
func TestEmbyNextUpReturnsNextEpisode(t *testing.T) {
router, svc, userID := newEmbyDiscoveryEnv(t)
libID := seedEmbyLibrary(t, svc, "tv")
watchedAt := time.Now().Add(-time.Hour)
for episode, watched := range map[int]bool{1: true, 2: false, 3: false} {
m := &model.Media{
LibraryID: libID, SeriesID: "series-1", Title: "剧一",
SeasonNum: 1, EpisodeNum: episode,
Path: "/media/tv/S1E" + string(rune('0'+episode)) + ".mkv",
}
if err := svc.Repo.DB.Create(m).Error; err != nil {
t.Fatal(err)
}
if watched {
h := &model.PlaybackHistory{
UserID: userID, MediaID: m.ID, PositionMs: 2000, DurationMs: 2000,
WatchedAt: watchedAt, Completed: true, // 第 1 集已看完
}
if err := svc.Repo.DB.Create(h).Error; err != nil {
t.Fatal(err)
}
}
}
w := embyGet(t, router, "/emby/Shows/NextUp", signedTestToken(t, "test-secret"))
if w.Code != http.StatusOK {
t.Fatalf("status = %d body=%s", w.Code, w.Body.String())
}
items := decodeItemsEnvelope(t, w.Body.Bytes())
if len(items) != 1 {
t.Fatalf("items = %d, want 1 (body=%s)", len(items), w.Body.String())
}
if index, ok := items[0]["IndexNumber"].(float64); !ok || int(index) != 2 {
t.Fatalf("IndexNumber = %v, want 2 (body=%s)", items[0]["IndexNumber"], w.Body.String())
}
}
// 回归:用户在剧集详情页点播放、只看了几秒就退出(历史行 completed=false)后,
// Yamby 再次进入详情页带的 NextUp 仍要指向那一集本身,否则「继续播放」会跳到下一集。
func TestEmbyNextUpKeepsPartiallyWatchedEpisode(t *testing.T) {
router, svc, userID := newEmbyDiscoveryEnv(t)
libID := seedEmbyLibrary(t, svc, "tv")
episodeIDs := map[int]string{}
for ep := 1; ep <= 3; ep++ {
m := &model.Media{
LibraryID: libID, SeriesID: "series-1", Title: "剧一",
SeasonNum: 1, EpisodeNum: ep,
Path: "/media/tv/S1E" + strconv.Itoa(ep) + ".mkv",
}
if err := svc.Repo.DB.Create(m).Error; err != nil {
t.Fatal(err)
}
episodeIDs[ep] = m.ID
}
// 第 2 集播放了 3 秒后退出:有进度、未标记看完。
if err := svc.Repo.DB.Create(&model.PlaybackHistory{
UserID: userID, MediaID: episodeIDs[2], PositionMs: 3582, DurationMs: 1440064,
WatchedAt: time.Now(), Completed: false,
}).Error; err != nil {
t.Fatal(err)
}
w := embyGet(t, router, "/emby/Shows/NextUp?SeriesId=series-1&Limit=1", signedTestToken(t, "test-secret"))
if w.Code != http.StatusOK {
t.Fatalf("status = %d body=%s", w.Code, w.Body.String())
}
items := decodeItemsEnvelope(t, w.Body.Bytes())
if len(items) != 1 {
t.Fatalf("items = %d, want 1 (body=%s)", len(items), w.Body.String())
}
if id, _ := items[0]["Id"].(string); id != episodeIDs[2] {
t.Fatalf("Id = %q, want the partially watched episode %q (body=%s)", id, episodeIDs[2], w.Body.String())
}
if index, ok := items[0]["IndexNumber"].(float64); !ok || int(index) != 2 {
t.Fatalf("IndexNumber = %v, want 2 (body=%s)", items[0]["IndexNumber"], w.Body.String())
}
}
// 没有历史时必须返回合法空信封,不能 404/500。
func TestEmbyNextUpEmptyWithoutHistory(t *testing.T) {
router, _, _ := newEmbyDiscoveryEnv(t)
w := embyGet(t, router, "/emby/Shows/NextUp", signedTestToken(t, "test-secret"))
if w.Code != http.StatusOK {
t.Fatalf("status = %d body=%s", w.Code, w.Body.String())
}
if items := decodeItemsEnvelope(t, w.Body.Bytes()); len(items) != 0 {
t.Fatalf("items = %d, want 0", len(items))
}
}
// 小写别名路由同样要走到真实实现(客户端路径大小写并不统一)。
func TestEmbyNextUpLowercaseAlias(t *testing.T) {
router, svc, _ := newEmbyDiscoveryEnv(t)
_ = seedEmbyLibrary(t, svc, "tv")
w := embyGet(t, router, "/emby/shows/nextup", signedTestToken(t, "test-secret"))
if w.Code != http.StatusOK {
t.Fatalf("status = %d body=%s", w.Code, w.Body.String())
}
}
// Similar 对不存在的条目返回空列表(客户端详情页会无条件请求)。
func TestEmbySimilarUnknownItemReturnsEmpty(t *testing.T) {
router, _, _ := newEmbyDiscoveryEnv(t)
w := embyGet(t, router, "/emby/Items/does-not-exist/Similar", signedTestToken(t, "test-secret"))
if w.Code != http.StatusOK {
t.Fatalf("status = %d body=%s", w.Code, w.Body.String())
}
if items := decodeItemsEnvelope(t, w.Body.Bytes()); len(items) != 0 {
t.Fatalf("items = %d, want 0", len(items))
}
}
func TestEmbySimilarReturnsCandidates(t *testing.T) {
router, svc, _ := newEmbyDiscoveryEnv(t)
libID := seedEmbyLibrary(t, svc, "movie")
source := &model.Media{
LibraryID: libID, Title: "源片", Genres: "Action", Year: 2010, Rating: 8,
Path: "/media/movie/source.mkv",
}
if err := svc.Repo.DB.Create(source).Error; err != nil {
t.Fatal(err)
}
other := &model.Media{
LibraryID: libID, Title: "同类片", Genres: "Action", Year: 2011, Rating: 8,
Path: "/media/movie/other.mkv",
}
if err := svc.Repo.DB.Create(other).Error; err != nil {
t.Fatal(err)
}
w := embyGet(t, router, "/emby/Items/"+source.ID+"/Similar", signedTestToken(t, "test-secret"))
if w.Code != http.StatusOK {
t.Fatalf("status = %d body=%s", w.Code, w.Body.String())
}
items := decodeItemsEnvelope(t, w.Body.Bytes())
if len(items) != 1 {
t.Fatalf("items = %d, want 1 (body=%s)", len(items), w.Body.String())
}
if name, _ := items[0]["Name"].(string); name != "同类片" {
t.Fatalf("Name = %q, want 同类片", name)
}
}
// Genres 必须返回真实类型与计数。
func TestEmbyGenresReturnsCounts(t *testing.T) {
router, svc, _ := newEmbyDiscoveryEnv(t)
libID := seedEmbyLibrary(t, svc, "movie")
for i, genres := range []string{"Action,Drama", "Action"} {
m := &model.Media{
LibraryID: libID, Title: "片" + string(rune('A'+i)), Genres: genres,
Path: "/media/movie/m" + string(rune('0'+i)) + ".mkv",
}
if err := svc.Repo.DB.Create(m).Error; err != nil {
t.Fatal(err)
}
}
w := embyGet(t, router, "/emby/Genres", signedTestToken(t, "test-secret"))
if w.Code != http.StatusOK {
t.Fatalf("status = %d body=%s", w.Code, w.Body.String())
}
items := decodeItemsEnvelope(t, w.Body.Bytes())
if len(items) != 2 {
t.Fatalf("items = %d, want 2 (body=%s)", len(items), w.Body.String())
}
// 排序按计数降序:Action(2) 在前。
if name, _ := items[0]["Name"].(string); name != "Action" {
t.Fatalf("first Name = %q, want Action", name)
}
if count, ok := items[0]["ItemCount"].(float64); !ok || int(count) != 2 {
t.Fatalf("ItemCount = %v, want 2", items[0]["ItemCount"])
}
if id, _ := items[0]["Id"].(string); len(id) == 0 {
t.Fatal("genre item must carry a stable Id")
}
}
// 按别人的 userId 请求 NextUp 不允许泄露他人历史。
func TestEmbyNextUpRejectsForeignUserID(t *testing.T) {
router, _, _ := newEmbyDiscoveryEnv(t)
w := embyGet(t, router, "/emby/Users/someone-else/Shows/NextUp", signedTestToken(t, "test-secret"))
if w.Code != http.StatusOK {
t.Fatalf("status = %d body=%s", w.Code, w.Body.String())
}
if items := decodeItemsEnvelope(t, w.Body.Bytes()); len(items) != 0 {
t.Fatalf("items = %d, want 0", len(items))
}
}
// YamBy 等客户端进入剧集详情会带 SeriesId 调 NextUp;必须只返回该剧的下一集,
// 不能回落成全站「继续观看」第一条,否则详情页播放会串到别的片子。
func TestEmbyNextUpFiltersBySeriesID(t *testing.T) {
router, svc, userID := newEmbyDiscoveryEnv(t)
libID := seedEmbyLibrary(t, svc, "tv")
recent := time.Now().Add(-time.Minute)
older := time.Now().Add(-2 * time.Hour)
seedSeries := func(seriesID, title string, watchedAt time.Time) (watchedID, nextID string) {
t.Helper()
for ep := 1; ep <= 3; ep++ {
m := &model.Media{
LibraryID: libID, SeriesID: seriesID, Title: title,
SeasonNum: 1, EpisodeNum: ep,
Path: "/media/tv/" + seriesID + "/S1E" + strconv.Itoa(ep) + ".mkv",
}
if err := svc.Repo.DB.Create(m).Error; err != nil {
t.Fatal(err)
}
switch ep {
case 1:
watchedID = m.ID
h := &model.PlaybackHistory{
UserID: userID, MediaID: m.ID, PositionMs: 2000, DurationMs: 2000,
WatchedAt: watchedAt, Completed: true, // 第 1 集已看完,下一集是 S1E2
}
if err := svc.Repo.DB.Create(h).Error; err != nil {
t.Fatal(err)
}
case 2:
nextID = m.ID
}
}
return watchedID, nextID
}
_, _ = seedSeries("series-hot", "热门剧", recent)
_, wantNext := seedSeries("series-cold", "目标剧", older)
token := signedTestToken(t, "test-secret")
global := embyGet(t, router, "/emby/Shows/NextUp?Limit=10", token)
if global.Code != http.StatusOK {
t.Fatalf("global status = %d body=%s", global.Code, global.Body.String())
}
if items := decodeItemsEnvelope(t, global.Body.Bytes()); len(items) < 2 {
t.Fatalf("global items = %d, want >= 2 (body=%s)", len(items), global.Body.String())
}
scoped := embyGet(t, router, "/emby/Shows/NextUp?SeriesId=series-cold&Limit=10", token)
if scoped.Code != http.StatusOK {
t.Fatalf("scoped status = %d body=%s", scoped.Code, scoped.Body.String())
}
items := decodeItemsEnvelope(t, scoped.Body.Bytes())
if len(items) != 1 {
t.Fatalf("scoped items = %d, want 1 (body=%s)", len(items), scoped.Body.String())
}
if id, _ := items[0]["Id"].(string); id != wantNext {
t.Fatalf("scoped Id = %q, want %q (body=%s)", id, wantNext, scoped.Body.String())
}
if seriesID, _ := items[0]["SeriesId"].(string); seriesID != "series-cold" {
t.Fatalf("scoped SeriesId = %q, want series-cold", seriesID)
}
empty := embyGet(t, router, "/emby/Shows/NextUp?SeriesId=series-never-watched", token)
if empty.Code != http.StatusOK {
t.Fatalf("empty status = %d body=%s", empty.Code, empty.Body.String())
}
if items := decodeItemsEnvelope(t, empty.Body.Bytes()); len(items) != 0 {
t.Fatalf("never-watched items = %d, want 0 (body=%s)", len(items), empty.Body.String())
}
pathScoped := embyGet(t, router, "/emby/Shows/series-cold/NextUp?Limit=10", token)
if pathScoped.Code != http.StatusOK {
t.Fatalf("path scoped status = %d body=%s", pathScoped.Code, pathScoped.Body.String())
}
pathItems := decodeItemsEnvelope(t, pathScoped.Body.Bytes())
if len(pathItems) != 1 {
t.Fatalf("path scoped items = %d, want 1 (body=%s)", len(pathItems), pathScoped.Body.String())
}
if id, _ := pathItems[0]["Id"].(string); id != wantNext {
t.Fatalf("path scoped Id = %q, want %q", id, wantNext)
}
}
+31 -1
View File
@@ -40,9 +40,28 @@ func parseEmbyItemsParams(c *gin.Context) service.ItemsParams {
SortOrder: firstQueryValue(c, "SortOrder", "sortOrder", "sortorder"),
Limit: limit,
StartIndex: offset,
SeasonIndex: parseEmbySeasonIndexQuery(c),
}
}
// parseEmbySeasonIndexQuery 读取客户端请求的季序号。
//
// Emby 客户端有两种表达方式:SeasonId(虚拟季 ID)与 Season / SeasonIndex
// (季序号,特别篇为 0)。两者都是合法入参,SeasonId 更精确。这里只解析季序号,
// 返回 nil 表示客户端没有按季过滤(区别于 Season=0 的特别篇)。
func parseEmbySeasonIndexQuery(c *gin.Context) *int {
raw := firstQueryValue(c, "Season", "season", "SeasonIndex", "seasonIndex", "seasonindex")
if raw == "" {
return nil
}
value, err := strconv.Atoi(raw)
if err != nil {
// 客户端偶尔传入季名称之类的非数字值;按「未过滤」处理,避免整季空结果。
return nil
}
return &value
}
func embyFirstNonEmptyString(values ...string) string {
for _, value := range values {
if strings.TrimSpace(value) != "" {
@@ -113,7 +132,10 @@ func embyResumeItemsHandler(svc *service.Container) gin.HandlerFunc {
return func(c *gin.Context) {
uid := embyEffectiveUserID(c)
limit, _ := strconv.Atoi(embyFirstNonEmptyString(firstQueryValue(c, "Limit", "limit"), "20"))
out, err := svc.Emby.ResumeItems(c.Request.Context(), uid, limit)
startIndex, _ := strconv.Atoi(embyFirstNonEmptyString(firstQueryValue(c, "StartIndex", "startIndex", "startindex"), "0"))
// ParentId / SeriesId 收窄到当前库或当前剧,避免详情页继续播放串到全站历史。
parentID := firstQueryValue(c, "ParentId", "parentId", "parentid", "SeriesId", "seriesId", "seriesid")
out, err := svc.Emby.ResumeItems(c.Request.Context(), uid, parentID, limit, startIndex)
if err != nil {
c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
return
@@ -199,8 +221,15 @@ func embyShowSeasonsHandler(svc *service.Container) gin.HandlerFunc {
func embyShowEpisodesHandler(svc *service.Container) gin.HandlerFunc {
return func(c *gin.Context) {
parentID := firstQueryValue(c, "SeasonId", "seasonId")
// 客户端常用季序号而不是虚拟季 ID 请求剧集。缺了这层过滤,
// /Shows/{id}/Episodes?Season=2 会把整部剧的所有季都返回。
seasonIndex := parseEmbySeasonIndexQuery(c)
if parentID == "" {
parentID = c.Param("id")
} else {
// SeasonId 已经限定了具体季,忽略同时传来的季序号,避免两者
// 不一致时把结果过滤成空集。
seasonIndex = nil
}
params := service.ItemsParams{
UserID: embyEffectiveUserID(c),
@@ -208,6 +237,7 @@ func embyShowEpisodesHandler(svc *service.Container) gin.HandlerFunc {
IncludeItemTypes: []string{"Episode"},
Recursive: true,
Limit: 500,
SeasonIndex: seasonIndex,
}
out, err := svc.Emby.Items(c.Request.Context(), params)
if err != nil {
+151
View File
@@ -0,0 +1,151 @@
// Package handler — Emby / Jellyfin 媒体分段(片头、片尾)兼容接口。
//
// GET /MediaSegments/{itemId}
// GET /Items/{itemId}/MediaSegments
// GET /Users/{userId}/Items/{itemId}/MediaSegments
//
// 契约对齐 Jellyfin 10.10 引入的 Media Segments API(Emby 采用同一形状),
// 也是 TheIntroDB 官方 Jellyfin 插件走的同一条路:
//
// QueryResult<MediaSegmentDto> = {"Items": [...], "TotalRecordCount": N}
// MediaSegmentDto = {"Id", "ItemId", "Type", "StartTicks", "EndTicks"}
//
// 时间是 .NET ticks(1 tick = 100ns,即每秒 10,000,000、每毫秒 10,000);
// Type 是枚举名字符串 Intro / Outro / Recap / Preview / Commercial。
package handler
import (
"context"
"net/http"
"strings"
"time"
"github.com/gin-gonic/gin"
"go.uber.org/zap"
"github.com/truewhile/MeBox/internal/model"
"github.com/truewhile/MeBox/internal/service"
)
// 第三方客户端会在起播前后同步请求分段,不能被一次外网抓取无限拖住。超时后
// 退回已有缓存(可能为空),请求本身永远不失败。
const embyMediaSegmentsFetchBudget = 5 * time.Second
// 1 秒 = 10,000,000 ticks => 1 毫秒 = 10,000 ticks。
const embyTicksPerMillisecond int64 = 10_000
func embyMediaSegmentsHandler(svc *service.Container) gin.HandlerFunc {
return func(c *gin.Context) {
// 未知条目、虚拟剧集/季、远程 Emby 挂载、以及当前不可见的内容一律返回
// 空结果而不是 404:客户端会把 404 判成「条目损坏」(同 emby_routes.go
// 里 AdditionalParts 的说明),而「没有可跳过的片段」本来就是个合法状态。
empty := gin.H{"Items": []any{}, "TotalRecordCount": 0}
if svc == nil || svc.Repo == nil || svc.Segments == nil {
c.JSON(http.StatusOK, empty)
return
}
id := c.Param("id")
// 远程 Emby 挂载的条目是上游库的投影,本地没有可查询的外部 ID 关联。
if service.IsEmbyRemoteID(id) {
c.JSON(http.StatusOK, empty)
return
}
m, err := svc.Repo.Media.FindByID(c.Request.Context(), id)
if err != nil || m == nil || !mediaVisibleForRequest(c, svc, m) {
c.JSON(http.StatusOK, empty)
return
}
ctx, cancel := context.WithTimeout(c.Request.Context(), embyMediaSegmentsFetchBudget)
defer cancel()
rows, listErr := svc.Segments.ListForPlayback(ctx, m)
if listErr != nil && svc.Log != nil {
svc.Log.Debug("emby media segments lookup failed",
zap.String("media_id", m.ID), zap.Error(listErr))
}
items := embySegmentItems(m, rows, embyRequestedSegmentTypes(c))
c.JSON(http.StatusOK, gin.H{"Items": items, "TotalRecordCount": len(items)})
}
}
// embySegmentItems 把库内片段转换成 MediaSegmentDto 列表。
func embySegmentItems(m *model.Media, rows []model.MediaSegment, want map[string]bool) []gin.H {
// 末段在库内用 end_ms = 0 表示「一直到片尾」(TheIntroDB 对片尾返回 end_ms: null),
// 这里必须换算成真实结束时间;拿不到时长就丢弃该分段,否则会给出一个零长度区间,
// 客户端要么忽略要么画出一个错误的跳转点。
durationMs := int64(m.DurationSec) * 1000
items := make([]gin.H, 0, len(rows))
for _, row := range rows {
typeName := embySegmentTypeName(row.Kind)
if typeName == "" {
continue
}
if len(want) > 0 && !want[typeName] {
continue
}
endMs := row.EndMs
if endMs <= 0 {
if durationMs <= 0 {
continue
}
endMs = durationMs
}
if endMs <= row.StartMs {
continue
}
items = append(items, gin.H{
"Id": row.ID,
"ItemId": m.ID,
"Type": typeName,
"StartTicks": row.StartMs * embyTicksPerMillisecond,
"EndTicks": endMs * embyTicksPerMillisecond,
})
}
return items
}
// embySegmentTypeName 把库内 kind 映射成 Emby/Jellyfin 的 MediaSegmentType 名字。
// 库内的 credits 取自 TheIntroDB 的字段名,在 Emby 一侧对应 Outro。
func embySegmentTypeName(kind string) string {
switch kind {
case model.SegmentKindIntro:
return "Intro"
case model.SegmentKindRecap:
return "Recap"
case model.SegmentKindCredits:
return "Outro"
case model.SegmentKindPreview:
return "Preview"
default:
return ""
}
}
// embyRequestedSegmentTypes 解析 includeSegmentTypes(Jellyfin 的过滤参数)。
// 支持重复参数与逗号分隔两种写法;返回空集合表示不过滤。
//
// 只认枚举名字符串。数字枚举虽然 ASP.NET 模型绑定也接受,但各家定义的顺序并
// 不一致,猜错会把过滤结果算错;认不出来时按「不过滤」处理,返回的是超集,
// 客户端自己仍会再过滤一次。
func embyRequestedSegmentTypes(c *gin.Context) map[string]bool {
raw := make([]string, 0, 4)
for _, key := range []string{"includeSegmentTypes", "IncludeSegmentTypes", "includesegmenttypes"} {
raw = append(raw, c.QueryArray(key)...)
}
want := make(map[string]bool, len(raw))
for _, value := range raw {
for _, part := range strings.Split(value, ",") {
part = strings.TrimSpace(part)
if part == "" {
continue
}
for _, name := range []string{"Intro", "Outro", "Recap", "Preview", "Commercial"} {
if strings.EqualFold(part, name) {
want[name] = true
}
}
}
}
return want
}
@@ -0,0 +1,217 @@
package handler
import (
"encoding/json"
"net/http"
"net/http/httptest"
"sync/atomic"
"testing"
"github.com/gin-gonic/gin"
"github.com/glebarez/sqlite"
"go.uber.org/zap"
"gorm.io/gorm"
"github.com/truewhile/MeBox/internal/config"
"github.com/truewhile/MeBox/internal/model"
"github.com/truewhile/MeBox/internal/repository"
"github.com/truewhile/MeBox/internal/service"
)
type embySegmentsPayload struct {
Items []struct {
ID string `json:"Id"`
ItemID string `json:"ItemId"`
Type string `json:"Type"`
StartTicks int64 `json:"StartTicks"`
EndTicks int64 `json:"EndTicks"`
} `json:"Items"`
TotalRecordCount int `json:"TotalRecordCount"`
}
// 电影:intro 有明确结束点;credits 的 end_ms 为 null(库内落成 0),
// 必须用媒体时长补齐 —— 这是最容易写错的一处。
const embySegmentsProviderBody = `{"tmdb_id":27205,"type":"movie","intro":[{"start_ms":null,"end_ms":38000}],"credits":[{"start_ms":6480000,"end_ms":null}]}`
const (
embySegmentsMovieDurationSec = 8880
embySegmentsTicksPerSecond = 10_000_000
)
func newEmbySegmentsTestRouter(t *testing.T, durationSec int) (*gin.Engine, string, *int32) {
t.Helper()
gin.SetMode(gin.TestMode)
db, err := gorm.Open(sqlite.Open(":memory:"), &gorm.Config{})
if err != nil {
t.Fatal(err)
}
if err := db.AutoMigrate(model.AllModels()...); err != nil {
t.Fatal(err)
}
repos := repository.New(db)
if err := repos.User.Create(t.Context(), &model.User{
Base: model.Base{ID: "user-1"},
Username: "tester",
PasswordHash: "x",
Role: "admin",
Tier: "plus",
IsActive: true,
}); err != nil {
t.Fatal(err)
}
lib := model.Library{Base: model.Base{ID: "lib-movies"}, Name: "电影", Path: "D:\\media\\movies", Type: "movie", Enabled: true}
if err := repos.Library.Create(t.Context(), &lib); err != nil {
t.Fatal(err)
}
if err := db.Create(&model.Media{
Base: model.Base{ID: "movie-1"},
LibraryID: lib.ID,
Title: "Inception",
Path: "D:\\media\\movies\\Inception.mkv",
DurationSec: durationSec,
TMDbID: 27205,
}).Error; err != nil {
t.Fatal(err)
}
var calls int32
provider := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
atomic.AddInt32(&calls, 1)
w.Header().Set("Content-Type", "application/json")
_, _ = w.Write([]byte(embySegmentsProviderBody))
}))
t.Cleanup(provider.Close)
segments := service.NewMediaSegmentService(zap.NewNop(), repos).
SetIntroDB(service.NewIntroDBService(zap.NewNop()).SetBaseURL(provider.URL))
const secret = "test-secret"
router := gin.New()
registerEmbyRoutes(router, secret, &service.Container{
Repo: repos,
Emby: service.NewEmbyService(&config.Config{}, zap.NewNop(), repos),
Segments: segments,
Log: zap.NewNop(),
})
return router, secret, &calls
}
func embySegmentsRequest(t *testing.T, router *gin.Engine, secret, path string) embySegmentsPayload {
t.Helper()
req := httptest.NewRequest(http.MethodGet, path, nil)
req.Header.Set("X-Emby-Token", signedTestToken(t, secret))
w := httptest.NewRecorder()
router.ServeHTTP(w, req)
if w.Code != http.StatusOK {
t.Fatalf("%s status = %d body=%s", path, w.Code, w.Body.String())
}
var payload embySegmentsPayload
if err := json.Unmarshal(w.Body.Bytes(), &payload); err != nil {
t.Fatalf("%s decode: %v", path, err)
}
return payload
}
func TestEmbyMediaSegmentsReturnsTicksAndMapsCreditsToOutro(t *testing.T) {
router, secret, _ := newEmbySegmentsTestRouter(t, embySegmentsMovieDurationSec)
payload := embySegmentsRequest(t, router, secret, "/MediaSegments/movie-1")
if payload.TotalRecordCount != 2 || len(payload.Items) != 2 {
t.Fatalf("segments = %#v (total %d), want 2", payload.Items, payload.TotalRecordCount)
}
intro := payload.Items[0]
if intro.Type != "Intro" || intro.ItemID != "movie-1" || intro.ID == "" {
t.Fatalf("intro segment = %#v", intro)
}
// start_ms null 表示从片头开始。
if intro.StartTicks != 0 || intro.EndTicks != 38*embySegmentsTicksPerSecond {
t.Fatalf("intro ticks = %d..%d, want 0..%d",
intro.StartTicks, intro.EndTicks, 38*embySegmentsTicksPerSecond)
}
// 库内 credits 在 Emby 一侧是 Outro;end_ms = 0 必须按媒体时长补齐,
// 否则客户端会拿到一个零长度区间。
outro := payload.Items[1]
if outro.Type != "Outro" {
t.Fatalf("credits should map to Outro, got %q", outro.Type)
}
if outro.StartTicks != 6480*embySegmentsTicksPerSecond {
t.Fatalf("outro StartTicks = %d, want %d", outro.StartTicks, 6480*embySegmentsTicksPerSecond)
}
if outro.EndTicks != embySegmentsMovieDurationSec*embySegmentsTicksPerSecond {
t.Fatalf("outro EndTicks = %d, want the media duration %d",
outro.EndTicks, embySegmentsMovieDurationSec*embySegmentsTicksPerSecond)
}
}
func TestEmbyMediaSegmentsIsServedFromTheSameCacheAsTheWebPlayer(t *testing.T) {
router, secret, calls := newEmbySegmentsTestRouter(t, embySegmentsMovieDurationSec)
// 多条路径 + 大小写变体都应命中同一份缓存,而不是各自再打一次外网。
for _, path := range []string{
"/MediaSegments/movie-1",
"/mediasegments/movie-1",
"/Items/movie-1/MediaSegments",
"/items/movie-1/mediasegments",
"/Users/user-1/Items/movie-1/MediaSegments",
} {
payload := embySegmentsRequest(t, router, secret, path)
if len(payload.Items) != 2 {
t.Fatalf("%s returned %#v, want 2 segments", path, payload.Items)
}
}
if got := atomic.LoadInt32(calls); got != 1 {
t.Fatalf("provider calls = %d, want 1 (all routes share the cached rows)", got)
}
}
func TestEmbyMediaSegmentsHonoursIncludeSegmentTypes(t *testing.T) {
router, secret, _ := newEmbySegmentsTestRouter(t, embySegmentsMovieDurationSec)
payload := embySegmentsRequest(t, router, secret, "/MediaSegments/movie-1?includeSegmentTypes=Intro")
if payload.TotalRecordCount != 1 || len(payload.Items) != 1 {
t.Fatalf("filtered segments = %#v (total %d), want only Intro", payload.Items, payload.TotalRecordCount)
}
if payload.Items[0].Type != "Intro" {
t.Fatalf("filtered type = %q, want Intro", payload.Items[0].Type)
}
// 认不出的枚举名按「不过滤」处理:返回超集比返回空集安全。
payload = embySegmentsRequest(t, router, secret, "/MediaSegments/movie-1?includeSegmentTypes=NotAType")
if payload.TotalRecordCount != 2 {
t.Fatalf("unknown filter returned %d segments, want the unfiltered set", payload.TotalRecordCount)
}
}
func TestEmbyMediaSegmentsDropsOpenEndedRangeWhenDurationUnknown(t *testing.T) {
// 时长未知(STRM/云盘媒体探测前)时,credits 无法换算成真实结束点,
// 只能丢弃;有明确结束点的 intro 必须保留。
router, secret, _ := newEmbySegmentsTestRouter(t, 0)
payload := embySegmentsRequest(t, router, secret, "/MediaSegments/movie-1")
if payload.TotalRecordCount != 1 || len(payload.Items) != 1 {
t.Fatalf("segments = %#v (total %d), want only the intro", payload.Items, payload.TotalRecordCount)
}
if payload.Items[0].Type != "Intro" {
t.Fatalf("kept segment = %#v, want Intro", payload.Items[0])
}
}
func TestEmbyMediaSegmentsReturnsEmptyInsteadOfNotFound(t *testing.T) {
router, secret, calls := newEmbySegmentsTestRouter(t, embySegmentsMovieDurationSec)
// 未知条目必须 200 + 空数组:客户端会把 404 判成「条目损坏」。
payload := embySegmentsRequest(t, router, secret, "/MediaSegments/does-not-exist")
if payload.Items == nil || len(payload.Items) != 0 || payload.TotalRecordCount != 0 {
t.Fatalf("unknown item payload = %#v", payload)
}
// 远程 Emby 条目同理(本地没有可查询的外部 ID 关联)。
payload = embySegmentsRequest(t, router, secret, "/MediaSegments/embyremote~acct1~item1")
if len(payload.Items) != 0 {
t.Fatalf("remote emby item payload = %#v, want empty", payload.Items)
}
if got := atomic.LoadInt32(calls); got != 0 {
t.Fatalf("provider calls = %d, want 0 for unresolvable items", got)
}
}
+91
View File
@@ -1,10 +1,13 @@
package handler
import (
"context"
"errors"
"net/http"
"net/url"
"strings"
"sync"
"time"
"github.com/gin-gonic/gin"
@@ -24,10 +27,98 @@ func embyPlaybackInfoHandler(svc *service.Container) gin.HandlerFunc {
return
}
embyAttachRequestTokenToMediaSources(c, out)
// 在后台把本次条目的云盘直链换好:播放器拿到 PlaybackInfo 后通常还要
// 1–2 秒才请求 /Videos/{id}/stream,把换链开销落在这段等待里。
embyPrewarmPlaybackTargets(svc, c, out)
c.JSON(http.StatusOK, out)
}
}
// embyPrewarmTimeout 是单次预热的等待上限。115 开放平台在跨太平洋线路上单次
// 换链实测 0.4–1.1s,这里给足余量;超时只是没预热成功,不影响后续播放。
const embyPrewarmTimeout = 10 * time.Second
// embyPrewarmInFlight 去重同一个条目的并发预热(首页刷新会并发请求多个接口,
// 同一条目可能在短时间内被多次请求)。
var embyPrewarmInFlight sync.Map
// embyPrewarmSlots 限制同时进行的预热数量。客户端可能批量预取 PlaybackInfo
// (逐个剧集的预取请求),预热只是优化,不能反过来把 115 换链接口打出突发。
// 名额满时直接跳过:排队等待的预热往往等真正播放时已经没意义了。
var embyPrewarmSlots = make(chan struct{}, 4)
// embyPrewarmPlaybackTargets 在后台预热本次 PlaybackInfo 涉及条目的云盘直链。
//
// 起播链路里最贵的一步是「服务端拿 pickcode 去 115 开放平台换直链」:服务器在
// 洛杉矶、115 接口在国内,冷启动实测 0.4–1.1s;之后 45 分钟内命中进程内缓存。
// 播放器在 PlaybackInfo 与真正拉流之间有几秒间隔,这里把换链放到那段间隔里,
// 起播时就只剩纯网络耗时。
//
// 只处理云盘/strm 条目,且失败一律静默忽略:预热是尽力而为的优化,不能影响
// PlaybackInfo 的正常返回。
func embyPrewarmPlaybackTargets(svc *service.Container, c *gin.Context, out map[string]any) {
if svc == nil || svc.Strm == nil || svc.Repo == nil || svc.Repo.Media == nil || out == nil {
return
}
ids := embyPrewarmMediaIDs(out)
if len(ids) == 0 {
return
}
userAgent := c.GetHeader("User-Agent")
// 预热是给「后续请求」用的:即便本次 PlaybackInfo 的连接断开,
// 也要把换链跑完。
base := context.WithoutCancel(c.Request.Context())
for _, mediaID := range ids {
if _, loaded := embyPrewarmInFlight.LoadOrStore(mediaID, struct{}{}); loaded {
continue
}
go func(id string) {
defer embyPrewarmInFlight.Delete(id)
select {
case embyPrewarmSlots <- struct{}{}:
defer func() { <-embyPrewarmSlots }()
default:
return
}
ctx, cancel := context.WithTimeout(base, embyPrewarmTimeout)
defer cancel()
m, err := svc.Repo.Media.FindByID(ctx, id)
if err != nil || m == nil {
return
}
raw := strings.TrimSpace(m.STRMURL)
if raw == "" || !service.IsStrmMediaRow(m) {
return
}
// 解析结果由 strm 层按 pickcode+UA 缓存;已缓存时这里是空转。
_, _ = svc.Strm.ResolvePlayTargetWithUA(ctx, raw, userAgent)
}(mediaID)
}
}
// embyPrewarmMediaIDs 取出 PlaybackInfo 载荷里 MediaSources 的条目 ID。
func embyPrewarmMediaIDs(out map[string]any) []string {
sources, ok := out["MediaSources"].([]map[string]any)
if !ok || len(sources) == 0 {
return nil
}
ids := make([]string, 0, len(sources))
seen := make(map[string]struct{}, len(sources))
for _, src := range sources {
id, _ := src["Id"].(string)
id = strings.TrimSpace(id)
if id == "" {
continue
}
if _, dup := seen[id]; dup {
continue
}
seen[id] = struct{}{}
ids = append(ids, id)
}
return ids
}
// embySubtitleStreamHandler serves an external subtitle track advertised in a
// MediaSource's MediaStreams via its Emby index
// (/Videos/:id/Subtitles/:index/Stream). The index maps to a discovered
@@ -0,0 +1,159 @@
package handler
import (
"net/http"
"net/http/httptest"
"testing"
"time"
"github.com/gin-gonic/gin"
"github.com/glebarez/sqlite"
"go.uber.org/zap"
"gorm.io/gorm"
"github.com/truewhile/MeBox/internal/config"
"github.com/truewhile/MeBox/internal/model"
"github.com/truewhile/MeBox/internal/repository"
"github.com/truewhile/MeBox/internal/service"
)
func newPrewarmTestContainer(t *testing.T) *service.Container {
t.Helper()
db, err := gorm.Open(sqlite.Open(":memory:"), &gorm.Config{})
if err != nil {
t.Fatalf("open db: %v", err)
}
if err := db.AutoMigrate(&model.Media{}, &model.Setting{}, &model.StrmAccount{}); err != nil {
t.Fatalf("migrate: %v", err)
}
if sqlDB, err := db.DB(); err == nil {
// 内存库 + 后台预热协程:限制单连接,避免新连接拿到空白的 :memory:。
sqlDB.SetMaxOpenConns(1)
}
repos := repository.New(db)
return &service.Container{
Log: zap.NewNop(),
Repo: repos,
Strm: service.NewStrmService(&config.Config{}, zap.NewNop(), repos, nil),
}
}
func newPrewarmTestContext() *gin.Context {
gin.SetMode(gin.TestMode)
c, _ := gin.CreateTestContext(httptest.NewRecorder())
c.Request = httptest.NewRequest(http.MethodPost, "/emby/Items/media-1/PlaybackInfo", nil)
c.Request.Header.Set("User-Agent", "RodelPlayer/2.2607.7.0")
return c
}
func TestEmbyPrewarmMediaIDsExtractsDeduplicates(t *testing.T) {
out := map[string]any{
"MediaSources": []map[string]any{
{"Id": "src-1"},
{"Id": " src-1 "},
{"Id": "src-2"},
{"Id": ""},
{"Name": "no id"},
},
}
got := embyPrewarmMediaIDs(out)
if len(got) != 2 || got[0] != "src-1" || got[1] != "src-2" {
t.Fatalf("ids = %v, want [src-1 src-2]", got)
}
if got := embyPrewarmMediaIDs(map[string]any{}); len(got) != 0 {
t.Fatalf("missing MediaSources should yield no ids, got %v", got)
}
if got := embyPrewarmMediaIDs(map[string]any{"MediaSources": []any{}}); len(got) != 0 {
t.Fatalf("foreign payload shape should yield no ids, got %v", got)
}
}
// 预热是异步的:调用必须立即返回,并且协程结束后不能残留去重标记。
func TestEmbyPrewarmPlaybackTargetsRunsAsyncAndCleansUp(t *testing.T) {
svc := newPrewarmTestContainer(t)
if err := svc.Repo.DB.Create(&model.Media{
Base: model.Base{ID: "media-1"},
Title: "Cloud",
Path: "cloud://cloud115/Movie.mkv",
Container: "strm",
STRMURL: "/api/strm/play/cloud115/video.mkv?acct=missing&pickcode=pc1",
}).Error; err != nil {
t.Fatal(err)
}
embyPrewarmInFlight.Delete("media-1")
out := map[string]any{"MediaSources": []map[string]any{{"Id": "media-1"}}}
done := make(chan struct{})
go func() {
embyPrewarmPlaybackTargets(svc, newPrewarmTestContext(), out)
close(done)
}()
select {
case <-done:
case <-time.After(2 * time.Second):
t.Fatal("embyPrewarmPlaybackTargets blocked the caller")
}
// 后台协程应很快跑完并释放去重标记,否则同一条目后续再也预热不了。
deadline := time.Now().Add(3 * time.Second)
for time.Now().Before(deadline) {
if _, busy := embyPrewarmInFlight.Load("media-1"); !busy {
return
}
time.Sleep(10 * time.Millisecond)
}
t.Fatal("prewarm in-flight marker leaked")
}
// 各种缺数据的情况都不允许 panic 或阻塞:预热只是尽力而为的优化。
func TestEmbyPrewarmPlaybackTargetsIsNilSafe(t *testing.T) {
svc := newPrewarmTestContainer(t)
c := newPrewarmTestContext()
out := map[string]any{"MediaSources": []map[string]any{{"Id": "media-1"}}}
cases := []struct {
name string
svc *service.Container
out map[string]any
}{
{name: "空容器", svc: &service.Container{}, out: out},
{name: "无 Strm", svc: &service.Container{Repo: svc.Repo}, out: out},
{name: "无 Repo", svc: &service.Container{Strm: svc.Strm}, out: out},
{name: "nil 载荷", svc: svc, out: nil},
{name: "无 MediaSources", svc: svc, out: map[string]any{}},
{name: "条目不存在", svc: svc, out: out},
}
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
embyPrewarmPlaybackTargets(tc.svc, c, tc.out)
})
}
}
// 本地文件条目不该触发换链预热(没有云盘直链可预热)。
func TestEmbyPrewarmSkipsLocalMedia(t *testing.T) {
svc := newPrewarmTestContainer(t)
if err := svc.Repo.DB.Create(&model.Media{
Base: model.Base{ID: "local-1"},
Title: "Local",
Path: "/media/movies/Local.mkv",
LibraryID: "lib-1",
}).Error; err != nil {
t.Fatal(err)
}
embyPrewarmInFlight.Delete("local-1")
embyPrewarmPlaybackTargets(svc, newPrewarmTestContext(),
map[string]any{"MediaSources": []map[string]any{{"Id": "local-1"}}})
// 协程要么已经跑完(标记被清掉),要么根本没起;两种都不该留下标记。
deadline := time.Now().Add(2 * time.Second)
for time.Now().Before(deadline) {
if _, busy := embyPrewarmInFlight.Load("local-1"); !busy {
return
}
time.Sleep(10 * time.Millisecond)
}
t.Fatal("local media must not leave a prewarm marker")
}
+10 -5
View File
@@ -196,15 +196,20 @@ func registerEmbyAuthenticatedItemRoutes(auth *gin.RouterGroup, svc *service.Con
auth.GET("/Shows/:id/Episodes", embyShowEpisodesHandler(svc))
auth.GET("/Users/:userId/Shows/:id/Seasons", embyShowSeasonsHandler(svc))
auth.GET("/Users/:userId/Shows/:id/Episodes", embyShowEpisodesHandler(svc))
auth.GET("/Shows/NextUp", embyEmptyItemsHandler(svc))
auth.GET("/Users/:userId/Shows/NextUp", embyEmptyItemsHandler(svc))
auth.GET("/MediaSegments/:id", embyEmptyItemsHandler(svc))
auth.GET("/Shows/NextUp", embyNextUpHandler(svc))
auth.GET("/Users/:userId/Shows/NextUp", embyNextUpHandler(svc))
// 部分客户端用路径形式 /Shows/{seriesId}/NextUp,而不是 query SeriesId。
auth.GET("/Shows/:id/NextUp", embyShowNextUpHandler(svc))
auth.GET("/Users/:userId/Shows/:id/NextUp", embyShowNextUpHandler(svc))
auth.GET("/MediaSegments/:id", embyMediaSegmentsHandler(svc))
auth.GET("/Items/:id/MediaSegments", embyMediaSegmentsHandler(svc))
auth.GET("/Users/:userId/Items/:id/MediaSegments", embyMediaSegmentsHandler(svc))
auth.GET("/Artists", embyEmptyItemsHandler(svc))
auth.GET("/Persons", embyEmptyItemsHandler(svc))
auth.GET("/Genres", embyEmptyItemsHandler(svc))
auth.GET("/Genres", embyGenresHandler(svc))
auth.GET("/Shows/Upcoming", embyEmptyItemsHandler(svc))
auth.GET("/Users/:userId/Shows/Upcoming", embyEmptyItemsHandler(svc))
auth.GET("/Items/:id/Similar", embyEmptyItemsHandler(svc))
auth.GET("/Items/:id/Similar", embySimilarHandler(svc))
auth.GET("/Items/:id/ThumbnailSet", embyEmptyItemsHandler(svc))
auth.GET("/Items/:id/ThemeMedia", embyThemeMediaHandler(svc))
auth.GET("/Users/:userId/Items/:id/SpecialFeatures", embyEmptyItemsHandler(svc))
+9 -5
View File
@@ -40,15 +40,19 @@ func registerLowercaseEmbyItemRoutes(auth *gin.RouterGroup, svc *service.Contain
auth.GET("/shows/:id/episodes", embyShowEpisodesHandler(svc))
auth.GET("/users/:userId/shows/:id/seasons", embyShowSeasonsHandler(svc))
auth.GET("/users/:userId/shows/:id/episodes", embyShowEpisodesHandler(svc))
auth.GET("/shows/nextup", embyEmptyItemsHandler(svc))
auth.GET("/users/:userId/shows/nextup", embyEmptyItemsHandler(svc))
auth.GET("/mediasegments/:id", embyEmptyItemsHandler(svc))
auth.GET("/shows/nextup", embyNextUpHandler(svc))
auth.GET("/users/:userId/shows/nextup", embyNextUpHandler(svc))
auth.GET("/shows/:id/nextup", embyShowNextUpHandler(svc))
auth.GET("/users/:userId/shows/:id/nextup", embyShowNextUpHandler(svc))
auth.GET("/mediasegments/:id", embyMediaSegmentsHandler(svc))
auth.GET("/items/:id/mediasegments", embyMediaSegmentsHandler(svc))
auth.GET("/users/:userId/items/:id/mediasegments", embyMediaSegmentsHandler(svc))
auth.GET("/artists", embyEmptyItemsHandler(svc))
auth.GET("/persons", embyEmptyItemsHandler(svc))
auth.GET("/genres", embyEmptyItemsHandler(svc))
auth.GET("/genres", embyGenresHandler(svc))
auth.GET("/shows/upcoming", embyEmptyItemsHandler(svc))
auth.GET("/users/:userId/shows/upcoming", embyEmptyItemsHandler(svc))
auth.GET("/items/:id/similar", embyEmptyItemsHandler(svc))
auth.GET("/items/:id/similar", embySimilarHandler(svc))
auth.GET("/items/:id/thumbnailset", embyEmptyItemsHandler(svc))
auth.GET("/items/:id/thememedia", embyThemeMediaHandler(svc))
auth.GET("/users/:userId/items/:id/specialfeatures", embyEmptyItemsHandler(svc))
@@ -0,0 +1,211 @@
package handler
import (
"encoding/json"
"net/http"
"net/http/httptest"
"testing"
"github.com/gin-gonic/gin"
"github.com/glebarez/sqlite"
"go.uber.org/zap"
"gorm.io/gorm"
"github.com/truewhile/MeBox/internal/config"
"github.com/truewhile/MeBox/internal/model"
"github.com/truewhile/MeBox/internal/repository"
"github.com/truewhile/MeBox/internal/service"
)
// embySeasonEpisodesRouter builds an Emby-compatible router over one series with
// two seasons, so /Shows/{id}/Episodes can be exercised with the query forms
// real clients send.
func embySeasonEpisodesRouter(t *testing.T) (*gin.Engine, string, string) {
t.Helper()
gin.SetMode(gin.TestMode)
db, err := gorm.Open(sqlite.Open(":memory:"), &gorm.Config{})
if err != nil {
t.Fatalf("open db: %v", err)
}
if err := db.AutoMigrate(&model.User{}, &model.Library{}, &model.Series{}, &model.Media{}, &model.Favorite{}, &model.PlaybackHistory{}, &model.Setting{}); err != nil {
t.Fatalf("migrate: %v", err)
}
if sqlDB, err := db.DB(); err == nil {
sqlDB.SetMaxOpenConns(1)
}
repos := repository.New(db)
if err := repos.User.Create(t.Context(), &model.User{
Base: model.Base{ID: "user-1"},
Username: "tester",
PasswordHash: "x",
Role: "admin",
Tier: "plus",
IsActive: true,
}); err != nil {
t.Fatalf("create user: %v", err)
}
lib := model.Library{Name: "剧集", Path: "D:\\media\\tv", Type: "tv", Enabled: true}
if err := repos.Library.Create(t.Context(), &lib); err != nil {
t.Fatalf("create library: %v", err)
}
for _, m := range []model.Media{
{
Base: model.Base{ID: "s1e1"},
LibraryID: lib.ID,
Title: "Test Show",
Path: "D:\\media\\tv\\Test Show\\Season 01\\Test Show - S01E01.mkv",
SeasonNum: 1,
EpisodeNum: 1,
Container: "mkv",
},
{
Base: model.Base{ID: "s2e1"},
LibraryID: lib.ID,
Title: "Test Show",
Path: "D:\\media\\tv\\Test Show\\Season 02\\Test Show - S02E01.mkv",
SeasonNum: 2,
EpisodeNum: 1,
Container: "mkv",
},
} {
if err := db.Create(&m).Error; err != nil {
t.Fatalf("create media: %v", err)
}
}
const secret = "test-secret"
router := gin.New()
registerEmbyRoutes(router, secret, &service.Container{
Repo: repos,
Emby: service.NewEmbyService(&config.Config{}, zap.NewNop(), repos),
})
// Resolve the virtual series id the way a client would.
seriesReq := httptest.NewRequest(http.MethodGet, "/Items?ParentId="+lib.ID+"&IncludeItemTypes=Series", nil)
seriesReq.Header.Set("X-Emby-Token", signedTestToken(t, secret))
seriesRec := httptest.NewRecorder()
router.ServeHTTP(seriesRec, seriesReq)
if seriesRec.Code != http.StatusOK {
t.Fatalf("series lookup status=%d body=%s", seriesRec.Code, seriesRec.Body.String())
}
var seriesPayload struct {
Items []map[string]any `json:"Items"`
}
if err := json.Unmarshal(seriesRec.Body.Bytes(), &seriesPayload); err != nil {
t.Fatalf("decode series: %v", err)
}
if len(seriesPayload.Items) != 1 {
t.Fatalf("want one series, got %#v", seriesPayload.Items)
}
seriesID, _ := seriesPayload.Items[0]["Id"].(string)
if seriesID == "" {
t.Fatalf("series payload has no Id: %#v", seriesPayload.Items[0])
}
return router, secret, seriesID
}
func fetchEpisodeIDs(t *testing.T, router *gin.Engine, secret, path string) ([]string, int) {
t.Helper()
req := httptest.NewRequest(http.MethodGet, path, nil)
req.Header.Set("X-Emby-Token", signedTestToken(t, secret))
rec := httptest.NewRecorder()
router.ServeHTTP(rec, req)
if rec.Code != http.StatusOK {
t.Fatalf("%s status=%d body=%s", path, rec.Code, rec.Body.String())
}
var payload struct {
Items []map[string]any `json:"Items"`
TotalRecordCount float64 `json:"TotalRecordCount"`
}
if err := json.Unmarshal(rec.Body.Bytes(), &payload); err != nil {
t.Fatalf("decode %s: %v", path, err)
}
ids := make([]string, 0, len(payload.Items))
for _, item := range payload.Items {
id, _ := item["Id"].(string)
ids = append(ids, id)
}
return ids, int(payload.TotalRecordCount)
}
// TestEmbyShowEpisodesHonoursSeasonQueryParam is the client-facing regression
// test: Emby clients scope episodes with ?Season=<index> (not only SeasonId), and
// the endpoint used to ignore it and return every season of the series.
func TestEmbyShowEpisodesHonoursSeasonQueryParam(t *testing.T) {
router, secret, seriesID := embySeasonEpisodesRouter(t)
cases := []struct {
name string
query string
wantIDs []string
}{
{name: "season 1", query: "Season=1", wantIDs: []string{"s1e1"}},
{name: "season 2", query: "Season=2", wantIDs: []string{"s2e1"}},
{name: "season index alias", query: "SeasonIndex=2", wantIDs: []string{"s2e1"}},
{name: "no season returns all", query: "", wantIDs: []string{"s1e1", "s2e1"}},
{name: "unknown season is empty", query: "Season=9", wantIDs: []string{}},
{name: "non numeric season falls back to all", query: "Season=Specials", wantIDs: []string{"s1e1", "s2e1"}},
}
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
path := "/Shows/" + seriesID + "/Episodes"
if tc.query != "" {
path += "?" + tc.query
}
ids, total := fetchEpisodeIDs(t, router, secret, path)
if len(ids) != len(tc.wantIDs) {
t.Fatalf("episode ids = %#v (total=%d), want %#v", ids, total, tc.wantIDs)
}
for i := range tc.wantIDs {
if ids[i] != tc.wantIDs[i] {
t.Fatalf("episode ids = %#v, want %#v", ids, tc.wantIDs)
}
}
if total != len(tc.wantIDs) {
t.Fatalf("TotalRecordCount = %d, want %d", total, len(tc.wantIDs))
}
})
}
}
// TestEmbyShowEpisodesSeasonIdStillWins pins that the virtual SeasonId form keeps
// working, and that a conflicting Season query cannot empty it out.
func TestEmbyShowEpisodesSeasonIdStillWins(t *testing.T) {
router, secret, seriesID := embySeasonEpisodesRouter(t)
seasonsPath := "/Shows/" + seriesID + "/Seasons"
req := httptest.NewRequest(http.MethodGet, seasonsPath, nil)
req.Header.Set("X-Emby-Token", signedTestToken(t, secret))
rec := httptest.NewRecorder()
router.ServeHTTP(rec, req)
if rec.Code != http.StatusOK {
t.Fatalf("seasons status=%d body=%s", rec.Code, rec.Body.String())
}
var seasons struct {
Items []map[string]any `json:"Items"`
}
if err := json.Unmarshal(rec.Body.Bytes(), &seasons); err != nil {
t.Fatalf("decode seasons: %v", err)
}
var season1ID string
for _, s := range seasons.Items {
if index, ok := s["IndexNumber"].(float64); ok && int(index) == 1 {
season1ID, _ = s["Id"].(string)
}
}
if season1ID == "" {
t.Fatalf("season 1 not found in %#v", seasons.Items)
}
ids, _ := fetchEpisodeIDs(t, router, secret, "/Shows/"+seriesID+"/Episodes?SeasonId="+season1ID)
if len(ids) != 1 || ids[0] != "s1e1" {
t.Fatalf("SeasonId episodes = %#v, want [s1e1]", ids)
}
// A stale/conflicting season number must not override the explicit season id.
ids, _ = fetchEpisodeIDs(t, router, secret, "/Shows/"+seriesID+"/Episodes?SeasonId="+season1ID+"&Season=2")
if len(ids) != 1 || ids[0] != "s1e1" {
t.Fatalf("SeasonId+Season episodes = %#v, want [s1e1]", ids)
}
}
+55
View File
@@ -0,0 +1,55 @@
package handler
import (
"net/http"
"github.com/gin-gonic/gin"
"github.com/truewhile/MeBox/internal/service"
)
// 媒体库筛选面板接口:facets 提供可选项,random 提供「随便看看」。
//
// 两者都走与列表完全相同的可见性判定(mediaVisibilityForRequest)与筛选解析
// (parseLibraryFilters),因此不会出现「列表里有、facets 里没有」或「随机跳
// 到了筛选条件之外的条目」这类不一致。
func libraryFacetsHandler(svc *service.Container) gin.HandlerFunc {
return func(c *gin.Context) {
libraryID := c.Param("id")
facets, err := svc.Media.LibraryFacets(
c.Request.Context(),
libraryID,
mediaVisibilityForRequest(c, svc),
svc.Discovery,
)
if err != nil {
writeInternalOrCanceled(c, err)
return
}
c.JSON(http.StatusOK, facets)
}
}
func libraryRandomHandler(svc *service.Container) gin.HandlerFunc {
return func(c *gin.Context) {
libraryID := c.Param("id")
filters := parseLibraryFilters(c)
// 随机只取一条,因此不带分页参数;未观看筛选仍需要会话用户。
media, err := svc.Media.RandomMedia(
c.Request.Context(),
libraryID,
mediaVisibilityForRequest(c, svc),
filters,
)
if err != nil {
writeInternalOrCanceled(c, err)
return
}
if media == nil {
c.JSON(http.StatusNotFound, gin.H{"error": "no media matches the current filters"})
return
}
c.JSON(http.StatusOK, media)
}
}
+283
View File
@@ -0,0 +1,283 @@
package handler
import (
"context"
"encoding/json"
"net/http"
"net/http/httptest"
"testing"
"github.com/gin-gonic/gin"
"github.com/glebarez/sqlite"
"go.uber.org/zap"
"gorm.io/gorm"
"github.com/truewhile/MeBox/internal/middleware"
"github.com/truewhile/MeBox/internal/model"
"github.com/truewhile/MeBox/internal/repository"
"github.com/truewhile/MeBox/internal/service"
)
func newLibraryFilterEnv(t *testing.T) (*gin.Engine, *service.Container, string, string) {
t.Helper()
gin.SetMode(gin.TestMode)
db, err := gorm.Open(sqlite.Open(":memory:"), &gorm.Config{})
if err != nil {
t.Fatalf("open db: %v", err)
}
if err := db.AutoMigrate(
&model.User{}, &model.Library{}, &model.Media{}, &model.PlaybackHistory{}, &model.Setting{},
); err != nil {
t.Fatalf("migrate: %v", err)
}
repos := repository.New(db)
svc := &service.Container{Repo: repos, Log: zap.NewNop()}
svc.Media = service.NewMediaService(nil, zap.NewNop(), repos)
svc.Discovery = service.NewMediaDiscoveryService(zap.NewNop(), repos)
const userID = "user-1"
if err := repos.User.Create(context.Background(), &model.User{
Base: model.Base{ID: userID}, Username: "tester", PasswordHash: "x", Role: "user", IsActive: true,
}); err != nil {
t.Fatal(err)
}
lib := &model.Library{Name: "电影", Path: "/media/movies", Type: "movie", Enabled: true}
if err := repos.Library.Create(context.Background(), lib); err != nil {
t.Fatal(err)
}
router := gin.New()
authed := router.Group("/api", func(c *gin.Context) {
c.Set(middleware.CtxUserID, userID)
c.Set(middleware.CtxUserRole, "user")
c.Next()
})
authed.GET("/libraries/:id/media", listMediaHandler(svc))
authed.GET("/libraries/:id/facets", libraryFacetsHandler(svc))
authed.GET("/libraries/:id/random", libraryRandomHandler(svc))
return router, svc, userID, lib.ID
}
func seedLibraryMedia(t *testing.T, svc *service.Container, rows ...*model.Media) {
t.Helper()
for _, row := range rows {
if err := svc.Repo.DB.Create(row).Error; err != nil {
t.Fatal(err)
}
}
}
func getJSON(t *testing.T, router *gin.Engine, path string) (int, []byte) {
t.Helper()
req := httptest.NewRequest(http.MethodGet, path, nil)
w := httptest.NewRecorder()
router.ServeHTTP(w, req)
return w.Code, w.Body.Bytes()
}
func TestLibraryFacetsReturnGenresAndYears(t *testing.T) {
router, svc, _, libID := newLibraryFilterEnv(t)
seedLibraryMedia(t, svc,
&model.Media{LibraryID: libID, Title: "A", Genres: "Action,Drama", Year: 1999, Path: "/a.mkv"},
&model.Media{LibraryID: libID, Title: "B", Genres: "Action", Year: 2021, Path: "/b.mkv"},
)
code, body := getJSON(t, router, "/api/libraries/"+libID+"/facets")
if code != http.StatusOK {
t.Fatalf("status = %d body=%s", code, body)
}
var facets struct {
Genres []struct {
Name string `json:"name"`
Count int `json:"count"`
} `json:"genres"`
YearMin int `json:"year_min"`
YearMax int `json:"year_max"`
}
if err := json.Unmarshal(body, &facets); err != nil {
t.Fatalf("decode %s: %v", body, err)
}
if facets.YearMin != 1999 || facets.YearMax != 2021 {
t.Fatalf("year range = %d..%d, want 1999..2021", facets.YearMin, facets.YearMax)
}
if len(facets.Genres) != 2 {
t.Fatalf("genres = %+v, want 2 entries", facets.Genres)
}
if facets.Genres[0].Name != "Action" || facets.Genres[0].Count != 2 {
t.Fatalf("first genre = %+v, want Action:2", facets.Genres[0])
}
}
// 空库时 facets 必须返回空数组而不是 null,前端无需额外判空。
func TestLibraryFacetsEmptyLibrary(t *testing.T) {
router, _, _, libID := newLibraryFilterEnv(t)
code, body := getJSON(t, router, "/api/libraries/"+libID+"/facets")
if code != http.StatusOK {
t.Fatalf("status = %d body=%s", code, body)
}
if !containsSubstring(string(body), `"genres":[]`) {
t.Fatalf("body = %s, want genres:[]", body)
}
}
// 列表筛选:按类型过滤后只返回命中的条目。
func TestListMediaAppliesGenreFilter(t *testing.T) {
router, svc, _, libID := newLibraryFilterEnv(t)
seedLibraryMedia(t, svc,
&model.Media{LibraryID: libID, Title: "动作", Genres: "Action", Path: "/a.mkv"},
&model.Media{LibraryID: libID, Title: "喜剧", Genres: "Comedy", Path: "/b.mkv"},
)
code, body := getJSON(t, router, "/api/libraries/"+libID+"/media?group_versions=0&genre=Action")
if code != http.StatusOK {
t.Fatalf("status = %d body=%s", code, body)
}
var payload struct {
Items []model.Media `json:"items"`
Total int64 `json:"total"`
}
if err := json.Unmarshal(body, &payload); err != nil {
t.Fatalf("decode %s: %v", body, err)
}
if payload.Total != 1 || len(payload.Items) != 1 || payload.Items[0].Title != "动作" {
t.Fatalf("payload = %+v, want only 动作", payload)
}
}
// 筛选条件必须进入缓存键:先请求未筛选列表、再筛选时不能命中旧缓存。
func TestListMediaFilterBypassesUnfilteredCache(t *testing.T) {
router, svc, _, libID := newLibraryFilterEnv(t)
seedLibraryMedia(t, svc,
&model.Media{LibraryID: libID, Title: "动作", Genres: "Action", Path: "/a.mkv"},
&model.Media{LibraryID: libID, Title: "喜剧", Genres: "Comedy", Path: "/b.mkv"},
)
// 先拉全量(可能写缓存),再拉筛选结果。
if code, body := getJSON(t, router, "/api/libraries/"+libID+"/media?group_versions=0"); code != http.StatusOK {
t.Fatalf("unfiltered status = %d body=%s", code, body)
}
code, body := getJSON(t, router, "/api/libraries/"+libID+"/media?group_versions=0&genre=Comedy")
if code != http.StatusOK {
t.Fatalf("filtered status = %d body=%s", code, body)
}
var payload struct {
Total int64 `json:"total"`
}
if err := json.Unmarshal(body, &payload); err != nil {
t.Fatal(err)
}
if payload.Total != 1 {
t.Fatalf("total = %d, want 1 (filtered response must not be served from the unfiltered cache)", payload.Total)
}
}
// 未观看筛选:已看完的不出现,看了一半的仍出现。
func TestListMediaUnwatchedFilter(t *testing.T) {
router, svc, userID, libID := newLibraryFilterEnv(t)
seedLibraryMedia(t, svc,
&model.Media{Base: model.Base{ID: "m-done"}, LibraryID: libID, Title: "看完", Path: "/a.mkv"},
&model.Media{Base: model.Base{ID: "m-half"}, LibraryID: libID, Title: "看一半", Path: "/b.mkv"},
)
for _, h := range []*model.PlaybackHistory{
{UserID: userID, MediaID: "m-done", Completed: true},
{UserID: userID, MediaID: "m-half", Completed: false},
} {
if err := svc.Repo.DB.Create(h).Error; err != nil {
t.Fatal(err)
}
}
code, body := getJSON(t, router, "/api/libraries/"+libID+"/media?group_versions=0&unwatched=1")
if code != http.StatusOK {
t.Fatalf("status = %d body=%s", code, body)
}
var payload struct {
Items []model.Media `json:"items"`
}
if err := json.Unmarshal(body, &payload); err != nil {
t.Fatal(err)
}
if len(payload.Items) != 1 || payload.Items[0].Title != "看一半" {
t.Fatalf("items = %+v, want only 看一半", payload.Items)
}
}
func TestLibraryRandomReturnsMedia(t *testing.T) {
router, svc, _, libID := newLibraryFilterEnv(t)
seedLibraryMedia(t, svc,
&model.Media{LibraryID: libID, Title: "唯一", Genres: "Action", Path: "/a.mkv"},
)
code, body := getJSON(t, router, "/api/libraries/"+libID+"/random")
if code != http.StatusOK {
t.Fatalf("status = %d body=%s", code, body)
}
var media model.Media
if err := json.Unmarshal(body, &media); err != nil {
t.Fatalf("decode %s: %v", body, err)
}
if media.Title != "唯一" {
t.Fatalf("title = %q, want 唯一", media.Title)
}
}
// 筛选后没有命中时返回 404,前端据此提示「没有符合条件的媒体」。
func TestLibraryRandomEmptyResultIs404(t *testing.T) {
router, svc, _, libID := newLibraryFilterEnv(t)
seedLibraryMedia(t, svc,
&model.Media{LibraryID: libID, Title: "动作", Genres: "Action", Path: "/a.mkv"},
)
code, body := getJSON(t, router, "/api/libraries/"+libID+"/random?genre=Nonexistent")
if code != http.StatusNotFound {
t.Fatalf("status = %d body=%s, want 404", code, body)
}
}
// axios 默认把数组序列化为 genre[]=Action 格式;后端必须把它当作 genre=Action 处理。
func TestListMediaAcceptsBracketGenreParam(t *testing.T) {
router, svc, _, libID := newLibraryFilterEnv(t)
seedLibraryMedia(t, svc,
&model.Media{LibraryID: libID, Title: "动作", Genres: "Action", Path: "/a.mkv"},
&model.Media{LibraryID: libID, Title: "喜剧", Genres: "Comedy", Path: "/b.mkv"},
)
// genre[]=Action — axios bracket format without custom paramsSerializer
code, body := getJSON(t, router, "/api/libraries/"+libID+"/media?group_versions=0&genre[]=Action")
if code != http.StatusOK {
t.Fatalf("status = %d body=%s", code, body)
}
var payload struct {
Items []model.Media `json:"items"`
Total int64 `json:"total"`
}
if err := json.Unmarshal(body, &payload); err != nil {
t.Fatalf("decode %s: %v", body, err)
}
if payload.Total != 1 || len(payload.Items) != 1 || payload.Items[0].Title != "动作" {
t.Fatalf("payload = %+v, want only 动作 for genre[]=Action", payload)
}
}
// 随机也遵守筛选:只命中 Action 时,带 Comedy 筛选必须 404。
func TestLibraryRandomHonoursFilters(t *testing.T) {
router, svc, _, libID := newLibraryFilterEnv(t)
seedLibraryMedia(t, svc,
&model.Media{LibraryID: libID, Title: "A", Genres: "Action", Year: 2001, Path: "/a.mkv"},
&model.Media{LibraryID: libID, Title: "B", Genres: "Comedy", Year: 2002, Path: "/b.mkv"},
)
code, body := getJSON(t, router, "/api/libraries/"+libID+"/random?genre=Comedy&year_min=2002")
if code != http.StatusOK {
t.Fatalf("status = %d body=%s", code, body)
}
var media model.Media
if err := json.Unmarshal(body, &media); err != nil {
t.Fatal(err)
}
if media.Title != "B" {
t.Fatalf("title = %q, want B", media.Title)
}
}
+90 -2
View File
@@ -4,6 +4,7 @@ package handler
import (
"context"
"errors"
"math"
"net/http"
"strconv"
"strings"
@@ -407,6 +408,92 @@ func deleteLibraryHandler(svc *service.Container) gin.HandlerFunc {
}
}
// parseLibraryFilters 解析媒体库列表的筛选查询参数。
//
// 全部参数都是可选的:缺省时返回零值,`MediaListFilters.empty()` 为真,列表
// 行为与此前完全一致(不引入任何默认筛选)。
//
// 参数约定:
// - genre=Action&genre=Comedy 类型多选(或关系,整词匹配)
// - year_min / year_max 年份区间,0 或非法值表示不限
// - rating_min 评分下限(浮点)
// - unwatched=1 仅显示未看完;用户 ID 取自会话
func parseLibraryFilters(c *gin.Context) service.MediaListFilters {
filters := service.MediaListFilters{
Genres: parseRepeatedQueryValues(c, "genre"),
YearMin: parseNonNegativeInt(firstQueryValue(c, "year_min", "yearMin")),
YearMax: parseNonNegativeInt(firstQueryValue(c, "year_max", "yearMax")),
RatingMin: parseNonNegativeFloat(firstQueryValue(c, "rating_min", "ratingMin")),
}
if isTruthyQuery(firstQueryValue(c, "unwatched", "unwatched_only", "unwatchedOnly")) {
filters.Unwatched = true
filters.UserID = toString(mustSessionUserID(c))
}
return filters
}
// parseRepeatedQueryValues 读取可重复出现的查询参数,去重并丢弃空值。
// 同时接受 key[] 括号格式(axios 1.x 默认序列化方式)作为向后兼容回退,
// 在前端 paramsSerializer 未正确配置时不会静默返回空结果。
func parseRepeatedQueryValues(c *gin.Context, key string) []string {
raw := c.QueryArray(key)
if len(raw) == 0 {
// fallback: axios bracket format (e.g. genre[]=Action&genre[]=Comedy)
raw = c.QueryArray(key + "[]")
}
if len(raw) == 0 {
return nil
}
seen := make(map[string]struct{}, len(raw))
out := make([]string, 0, len(raw))
for _, value := range raw {
// 客户端可能把多值拼成一次逗号分隔,两种形式都要接受。
for _, part := range strings.Split(value, ",") {
trimmed := strings.TrimSpace(part)
if trimmed == "" {
continue
}
if _, ok := seen[trimmed]; ok {
continue
}
seen[trimmed] = struct{}{}
out = append(out, trimmed)
}
}
return out
}
func parseNonNegativeInt(raw string) int {
value, err := strconv.Atoi(strings.TrimSpace(raw))
if err != nil || value < 0 {
return 0
}
return value
}
func parseNonNegativeFloat(raw string) float64 {
value, err := strconv.ParseFloat(strings.TrimSpace(raw), 64)
if err != nil || value < 0 || math.IsNaN(value) {
return 0
}
return value
}
func isTruthyQuery(raw string) bool {
switch strings.ToLower(strings.TrimSpace(raw)) {
case "1", "true", "yes", "on":
return true
default:
return false
}
}
// mustSessionUserID 取会话用户 ID,缺失时返回空串(筛选逻辑会忽略它)。
func mustSessionUserID(c *gin.Context) any {
uid, _ := c.Get(middleware.CtxUserID)
return uid
}
func listMediaHandler(svc *service.Container) gin.HandlerFunc {
return func(c *gin.Context) {
id := c.Param("id")
@@ -450,9 +537,10 @@ func listMediaHandler(svc *service.Container) gin.HandlerFunc {
if sortSpec.Field == "last_played" {
history = mediaHistoryMap(c, svc)
}
filters := parseLibraryFilters(c)
groupVersions := c.DefaultQuery("group_versions", "1") != "0"
if !groupVersions {
items, total, err := svc.Media.ListMediaVisible(ctx, id, page, size, mediaVisibilityForRequest(c, svc))
items, total, err := svc.Media.ListMediaVisibleFiltered(ctx, id, page, size, mediaVisibilityForRequest(c, svc), filters)
if err != nil {
writeInternalOrCanceled(c, err)
return
@@ -468,7 +556,7 @@ func listMediaHandler(svc *service.Container) gin.HandlerFunc {
})
return
}
grouped, err := svc.Media.GroupedMediaVisible(ctx, id, mediaVisibilityForRequest(c, svc))
grouped, err := svc.Media.GroupedMediaVisibleFiltered(ctx, id, mediaVisibilityForRequest(c, svc), filters)
if err != nil {
writeInternalOrCanceled(c, err)
return
+4
View File
@@ -346,6 +346,9 @@ func newPlaybackScopeTestRouter(t *testing.T) (*gin.Engine, *service.Container,
&model.Library{},
&model.Media{},
&model.PlayProfile{},
&model.Series{},
&model.MediaSegment{},
&model.MediaSegmentFetch{},
); err != nil {
t.Fatal(err)
}
@@ -408,6 +411,7 @@ func newPlaybackScopeTestRouter(t *testing.T) (*gin.Engine, *service.Container,
api := router.Group("/api")
api.Use(middleware.AuthRequired(cfg.Secrets.JWTSecret))
api.GET("/playback/:id/info", playbackInfoHandler(svc))
api.GET("/playback/:id/segments", playbackSegmentsHandler(svc))
api.GET("/playback/:id/external-url", externalURLHandler(svc))
api.GET("/playback/:id/external-players", externalPlayersHandler(svc))
api.GET("/stream/:id", streamHandler(svc))
+55
View File
@@ -0,0 +1,55 @@
// Package handler — 片头/片尾片段接口。
//
// GET /playback/:id/segments
//
// 单独开一个接口而不是塞进 /media/:id/playback,有两个原因:一是抓取外部数据
// 可能要几秒,不能拖慢决定能否起播的那个请求;二是片段与播放来源(本地 / 云盘 /
// 远程 Emby)无关,独立出来对所有媒体一致。
package handler
import (
"net/http"
"github.com/gin-gonic/gin"
"go.uber.org/zap"
"github.com/truewhile/MeBox/internal/service"
)
// playbackSegmentsHandler returns the skippable ranges for one media item.
// The client calls it after playback has already started, so the provider
// lookup never delays a play.
func playbackSegmentsHandler(svc *service.Container) gin.HandlerFunc {
return func(c *gin.Context) {
autoSkip := resolveAutoSkipFlag(c, svc)
segments := []service.SegmentView{}
m, err := findMediaForPlaybackEndpoint(c, svc, c.Param("id"))
if err != nil || m == nil || !mediaVisibleForRequest(c, svc, m) {
c.JSON(http.StatusNotFound, gin.H{"error": "media not found"})
return
}
// 远程 Emby 挂载的条目是上游库的投影,本地没有可查询的外部 ID 关联。
if svc.Segments != nil && !service.IsEmbyRemoteID(m.ID) {
rows, listErr := svc.Segments.ListForPlayback(c.Request.Context(), m)
if listErr != nil && svc.Log != nil {
svc.Log.Debug("list media segments failed",
zap.String("media_id", m.ID), zap.Error(listErr))
}
segments = service.ToSegmentViews(rows)
}
c.JSON(http.StatusOK, gin.H{"segments": segments, "auto_skip": autoSkip})
}
}
// resolveAutoSkipFlag reads the「自动跳过片头」switch off whichever profile is
// currently in effect. It reuses selectedPlayProfile so the server agrees with
// the UI about which profile is active (explicit header first, then the user's
// default profile), and a PIN-locked profile never silently skips for the user.
func resolveAutoSkipFlag(c *gin.Context, svc *service.Container) bool {
profile, locked := selectedPlayProfile(c, svc)
if locked || profile == nil {
return false
}
return profile.SkipIntro
}
+134
View File
@@ -0,0 +1,134 @@
package handler
import (
"encoding/json"
"net/http"
"net/http/httptest"
"sync/atomic"
"testing"
"go.uber.org/zap"
"github.com/truewhile/MeBox/internal/model"
"github.com/truewhile/MeBox/internal/service"
)
type segmentPayload struct {
Segments []struct {
Kind string `json:"kind"`
StartMs int64 `json:"start_ms"`
EndMs int64 `json:"end_ms"`
} `json:"segments"`
AutoSkip bool `json:"auto_skip"`
}
const segmentsProviderBody = `{"tmdb_id":27205,"type":"movie","intro":[{"start_ms":null,"end_ms":38000}],"credits":[{"start_ms":6480000,"end_ms":null}]}`
func TestPlaybackSegmentsReturnsProviderDataAndAutoSkip(t *testing.T) {
router, svc, secret := newPlaybackScopeTestRouter(t)
// 片段数据与播放来源无关,云盘媒体同样适用,只要它能解析出外部 ID。
// 注意列名是 tm_db_id(GORM 对 TMDbID 的默认命名)。
if err := svc.Repo.DB.Model(&model.Media{}).
Where("id = ?", "media-1").Update("tm_db_id", 27205).Error; err != nil {
t.Fatal(err)
}
var calls int32
provider := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
atomic.AddInt32(&calls, 1)
w.Header().Set("Content-Type", "application/json")
_, _ = w.Write([]byte(segmentsProviderBody))
}))
defer provider.Close()
svc.Segments = service.NewMediaSegmentService(zap.NewNop(), svc.Repo).
SetIntroDB(service.NewIntroDBService(zap.NewNop()).SetBaseURL(provider.URL))
// 默认档案打开「自动跳过片头」,接口应把开关原样带出来。
if err := svc.Repo.DB.Create(&model.PlayProfile{
Base: model.Base{ID: "profile-1"},
UserID: "user-1",
Name: "主档案",
IsDefault: true,
SkipIntro: true,
}).Error; err != nil {
t.Fatal(err)
}
loginToken := signedTestToken(t, secret)
fetch := func() segmentPayload {
t.Helper()
req := httptest.NewRequest(http.MethodGet, "http://nas.local/api/playback/media-1/segments", nil)
req.Header.Set("Authorization", "Bearer "+loginToken)
w := httptest.NewRecorder()
router.ServeHTTP(w, req)
if w.Code != http.StatusOK {
t.Fatalf("status = %d body=%s", w.Code, w.Body.String())
}
var payload segmentPayload
if err := json.Unmarshal(w.Body.Bytes(), &payload); err != nil {
t.Fatalf("decode: %v", err)
}
return payload
}
first := fetch()
if !first.AutoSkip {
t.Fatal("auto_skip should reflect the active profile's skip_intro switch")
}
if len(first.Segments) != 2 {
t.Fatalf("segments = %#v, want 2", first.Segments)
}
// start_ms: null -> 0;end_ms: null -> 0(延续到片尾,由客户端按时长补齐)。
if first.Segments[0].Kind != "intro" || first.Segments[0].StartMs != 0 || first.Segments[0].EndMs != 38_000 {
t.Fatalf("intro segment = %#v", first.Segments[0])
}
if first.Segments[1].Kind != "credits" || first.Segments[1].StartMs != 6_480_000 || first.Segments[1].EndMs != 0 {
t.Fatalf("credits segment = %#v", first.Segments[1])
}
// 第二次播放必须走本地缓存,不再打外网。
if second := fetch(); len(second.Segments) != 2 {
t.Fatalf("second fetch segments = %#v", second.Segments)
}
if got := atomic.LoadInt32(&calls); got != 1 {
t.Fatalf("provider calls = %d, want 1", got)
}
}
func TestPlaybackSegmentsAutoSkipIsFalseWithoutProfile(t *testing.T) {
router, svc, secret := newPlaybackScopeTestRouter(t)
svc.Segments = service.NewMediaSegmentService(zap.NewNop(), svc.Repo)
req := httptest.NewRequest(http.MethodGet, "http://nas.local/api/playback/media-1/segments", nil)
req.Header.Set("Authorization", "Bearer "+signedTestToken(t, secret))
w := httptest.NewRecorder()
router.ServeHTTP(w, req)
if w.Code != http.StatusOK {
t.Fatalf("status = %d body=%s", w.Code, w.Body.String())
}
var payload segmentPayload
if err := json.Unmarshal(w.Body.Bytes(), &payload); err != nil {
t.Fatalf("decode: %v", err)
}
if payload.AutoSkip {
t.Fatal("auto_skip must default to false")
}
// 即使一条片段都没有,也必须返回空数组而不是 null,前端才能无条件遍历。
if payload.Segments == nil {
t.Fatal("segments must serialise as an empty array, not null")
}
}
func TestPlaybackSegmentsForUnknownMediaReturnsNotFound(t *testing.T) {
router, svc, secret := newPlaybackScopeTestRouter(t)
svc.Segments = service.NewMediaSegmentService(zap.NewNop(), svc.Repo)
req := httptest.NewRequest(http.MethodGet, "http://nas.local/api/playback/does-not-exist/segments", nil)
req.Header.Set("Authorization", "Bearer "+signedTestToken(t, secret))
w := httptest.NewRecorder()
router.ServeHTTP(w, req)
if w.Code != http.StatusNotFound {
t.Fatalf("status = %d body=%s, want 404", w.Code, w.Body.String())
}
}
+5
View File
@@ -116,8 +116,13 @@ func registerAdminUserRoutes(admin *gin.RouterGroup, svc *service.Container) {
admin.PATCH("/users/:id/role", adminUpdateRoleHandler(svc))
admin.PATCH("/users/:id/libraries", updateUserLibrariesHandler(svc))
admin.DELETE("/users/:id", deleteUserHandler(svc))
// 设备代管:管理员可查看并踢掉任意用户的设备。
admin.GET("/users/:id/devices", adminUserDevicesHandler(svc))
admin.POST("/users/:id/devices/kick-all", adminKickAllUserDevicesHandler(svc))
admin.POST("/users/:id/devices/:deviceID/kick", adminKickUserDeviceHandler(svc))
admin.GET("/settings", listSettingsHandler(svc))
admin.PUT("/settings", updateSettingHandler(svc))
admin.POST("/telegram/test", testTelegramHandler(svc))
admin.POST("/adult/test-scraper", testAdultScraperHandler(svc))
admin.GET("/logs", recentLogsHandler(svc))
}
@@ -19,6 +19,16 @@ func registerAuthedUserAndLicenseRoutes(authed *gin.RouterGroup, svc *service.Co
authed.GET("/me/temporary-password", temporaryPasswordHandler(svc))
authed.POST("/me/temporary-password", temporaryPasswordHandler(svc))
// 设备管理:路由挂在 /me 下,用户 ID 一律取自会话,天然只能管自己的设备。
authed.GET("/me/devices", myDevicesHandler(svc))
authed.POST("/me/devices/kick-all", myKickAllDevicesHandler(svc))
authed.POST("/me/devices/:deviceID/kick", myKickDeviceHandler(svc))
// Telegram 通知绑定:一次性码 + Bot /bind <code>。
authed.GET("/me/telegram", getTelegramStatusHandler(svc))
authed.POST("/me/telegram/bind-code", startTelegramBindHandler(svc))
authed.DELETE("/me/telegram", unbindTelegramHandler(svc))
authed.GET("/auth/permissions", getMyPermissionsHandler(svc))
}
@@ -38,6 +48,8 @@ func registerAuthedLibraryRoutes(authed *gin.RouterGroup, svc *service.Container
authed.POST("/libraries/:id/scrape", middleware.AdminRequired(), scrapeLibraryHandler(svc))
authed.GET("/libraries/:id/media", listMediaHandler(svc))
authed.GET("/libraries/:id/facets", libraryFacetsHandler(svc))
authed.GET("/libraries/:id/random", libraryRandomHandler(svc))
authed.GET("/libraries/:id/series", listLibrarySeriesHandler(svc))
authed.GET("/libraries/:id/series/episodes", listLibrarySeriesEpisodesHandler(svc))
authed.GET("/libraries/:id/seasons", listSeasonsHandler(svc))
@@ -15,7 +15,7 @@ func registerAuthedUISurfaceRoutes(authed *gin.RouterGroup, svc *service.Contain
authed.PUT("/danmaku/settings", updateDanmakuSettingsHandler(svc))
authed.GET("/watch-history", historyListHandler(svc))
authed.GET("/watch-history/stats", historyStatsHandler(svc))
authed.GET("/watch-history/stats", requirePermission(svc, "can_view_history"), historyStatsHandler(svc))
authed.GET("/watch-history/continue", historyContinueHandler(svc))
authed.DELETE("/watch-history", historyDeleteHandler(svc))
authed.DELETE("/watch-history/:id", historyDeleteOneHandler(svc))
@@ -73,6 +73,7 @@ func registerAuthedFavoriteAndMediaActionRoutes(authed *gin.RouterGroup, svc *se
func registerAuthedPlaybackExtraRoutes(authed *gin.RouterGroup, svc *service.Container) {
authed.GET("/playback/:id/info", playbackInfoHandler(svc))
authed.GET("/playback/:id/resume", playbackResumeHandler(svc))
authed.GET("/playback/:id/segments", playbackSegmentsHandler(svc))
authed.POST("/playback/:id/progress", playbackProgressHandler(svc))
authed.GET("/playback/:id/external-players", externalPlayersHandler(svc))
authed.GET("/playback/:id/external-url", externalURLHandler(svc))
@@ -36,6 +36,7 @@ func TestAuthenticatedRouteSurfacesAreRegistered(t *testing.T) {
"GET /api/storage",
"GET /api/watch-history",
"GET /api/playback/:id/info",
"GET /api/playback/:id/segments",
} {
if !routes[want] {
t.Fatalf("%s route is not registered", want)
+3 -1
View File
@@ -124,7 +124,9 @@ func listLibrarySeriesHandler(svc *service.Container) gin.HandlerFunc {
return
}
}
items, total, err := svc.Media.ListLibrarySeriesCards(c.Request.Context(), libID, mediaVisibilityForRequest(c, svc))
items, total, err := svc.Media.ListLibrarySeriesCardsFiltered(
c.Request.Context(), libID, mediaVisibilityForRequest(c, svc), parseLibraryFilters(c),
)
if err != nil {
writeInternalOrCanceled(c, err)
return
+89
View File
@@ -0,0 +1,89 @@
package handler
import (
"net/http"
"github.com/gin-gonic/gin"
"github.com/truewhile/MeBox/internal/service"
)
// Telegram 绑定与测试接口。
//
// 绑定刻意做成「网页生成一次性码 → 用户在 Bot 里发 /bind <码>」:服务端不需要
// 用户手工填写 chat id,也不需要站点暴露 Bot 命令以外任何能力。
type telegramBindCodePayload struct {
Code string `json:"code"`
ExpiresIn int `json:"expires_in_seconds"`
}
// startTelegramBindHandler 生成一次性绑定码。同一用户重复调用时旧码作废。
func startTelegramBindHandler(svc *service.Container) gin.HandlerFunc {
return func(c *gin.Context) {
if svc.Telegram == nil {
c.JSON(http.StatusServiceUnavailable, gin.H{"error": "telegram service unavailable"})
return
}
userID := sessionUserID(c)
code, err := svc.Telegram.StartBind(c.Request.Context(), userID)
if err != nil {
c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
return
}
c.JSON(http.StatusOK, telegramBindCodePayload{Code: code, ExpiresIn: 300})
}
}
// getTelegramStatusHandler 返回绑定状态与脱敏会话 ID。
func getTelegramStatusHandler(svc *service.Container) gin.HandlerFunc {
return func(c *gin.Context) {
if svc.Telegram == nil {
c.JSON(http.StatusOK, gin.H{"bound": false})
return
}
bound, masked := svc.Telegram.Status(c.Request.Context(), sessionUserID(c))
payload := gin.H{"bound": bound}
if bound {
payload["chat_id_masked"] = masked
}
c.JSON(http.StatusOK, payload)
}
}
// unbindTelegramHandler 解除当前用户的 Telegram 绑定。
func unbindTelegramHandler(svc *service.Container) gin.HandlerFunc {
return func(c *gin.Context) {
if svc.Telegram == nil {
c.Status(http.StatusNoContent)
return
}
if err := svc.Telegram.Unbind(c.Request.Context(), sessionUserID(c)); err != nil {
c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
return
}
c.Status(http.StatusNoContent)
}
}
// testTelegramHandler 向管理员会话发送一条测试消息,用于验证 Token/会话 ID。
func testTelegramHandler(svc *service.Container) gin.HandlerFunc {
return func(c *gin.Context) {
if svc.Telegram == nil {
c.JSON(http.StatusServiceUnavailable, gin.H{"error": "telegram service unavailable"})
return
}
if !svc.Telegram.Configured(c.Request.Context()) {
c.JSON(http.StatusBadRequest, gin.H{
"success": false,
"error": "请先启用 Telegram 通知并填写 Bot Token 与管理员 Chat ID",
})
return
}
if err := svc.Telegram.SendToAdminChecked(c.Request.Context(), "✅ MeBox 测试消息:通知通道工作正常。"); err != nil {
c.JSON(http.StatusOK, gin.H{"success": false, "error": err.Error()})
return
}
c.JSON(http.StatusOK, gin.H{"success": true})
}
}
+194 -6
View File
@@ -11,8 +11,11 @@
package handler
import (
"context"
"net/http"
"sort"
"strconv"
"strings"
"time"
"github.com/gin-gonic/gin"
@@ -48,11 +51,16 @@ func historyListHandler(svc *service.Container) gin.HandlerFunc {
}
// historyStatsHandler returns aggregate watch time + completion counts
// for the caller. Used by the WatchHistoryPage hero card.
// for the caller. Used by the WatchHistoryPage hero card and the dedicated
// personal statistics page.
//
// 统计口径全部来自 PlaybackHistory 本身,不新增统计表:position_ms 是「已看
// 时长」的近似值,足以支撑趋势图;精确到秒的播放时长另有会话统计负责。
func historyStatsHandler(svc *service.Container) gin.HandlerFunc {
return func(c *gin.Context) {
uid, _ := c.Get(middleware.CtxUserID)
userID := toString(uid)
ctx := c.Request.Context()
var total int64
_ = svc.Repo.DB.Model(&model.PlaybackHistory{}).
@@ -77,16 +85,196 @@ func historyStatsHandler(svc *service.Container) gin.HandlerFunc {
last = &lastT
}
visibility := mediaVisibilityForRequest(c, svc)
daily, byType, recent := historyStatsBreakdowns(ctx, svc, userID, visibility)
inProgress := total - completed
if inProgress < 0 {
inProgress = 0
}
c.JSON(http.StatusOK, gin.H{
"total": total,
"completed": completed,
"watched_ms": watchedMs,
"watched_hours": float64(watchedMs) / 1000.0 / 3600.0,
"last_watched": last,
"total": total,
"completed": completed,
"in_progress": inProgress,
"watched_ms": watchedMs,
"watched_hours": float64(watchedMs) / 1000.0 / 3600.0,
"last_watched": last,
"daily": daily,
"by_library_type": byType,
"recent": recent,
})
}
}
// historyStatsDailyDays 是趋势图回看的天数。
const historyStatsDailyDays = 30
// historyStatsRecentLimit 是「最近看过」返回的条数。
const historyStatsRecentLimit = 8
type historyDailyStat struct {
Day string `json:"day"`
WatchMs int64 `json:"watch_ms"`
Plays int64 `json:"plays"`
}
type historyTypeStat struct {
Type string `json:"type"`
WatchMs int64 `json:"watch_ms"`
Count int64 `json:"count"`
}
// historyStatsBreakdowns 产出每日趋势、按媒体库类型分布与最近记录。
//
// 分桶在 Go 里做而不是用 SQL 的日期函数:SQLite 的 strftime 与 PostgreSQL 的
// to_char 语法不同,写两份 SQL 会在方言差异上长期出错,而历史行数受用户规模
// 约束(每人一行一部媒体),一次全量读取是可以接受的。
//
// visibility 控制哪些媒体对调用者可见(播放档案、成人锁等)。
func historyStatsBreakdowns(ctx context.Context, svc *service.Container, userID string, visibility service.MediaVisibility) ([]historyDailyStat, []historyTypeStat, []map[string]any) {
daily := make([]historyDailyStat, 0, historyStatsDailyDays)
byType := make([]historyTypeStat, 0)
recent := make([]map[string]any, 0, historyStatsRecentLimit)
var rows []model.PlaybackHistory
if err := svc.Repo.DB.WithContext(ctx).
Where("user_id = ?", userID).
Order("watched_at desc").
Find(&rows).Error; err != nil || len(rows) == 0 {
return daily, byType, recent
}
// 每日趋势:只回看最近 N 天,且按「本地日」分桶,避免跨时区偏移。
now := time.Now()
cutoff := now.AddDate(0, 0, -(historyStatsDailyDays - 1))
startOfDay := func(t time.Time) time.Time {
local := t.In(time.Local)
return time.Date(local.Year(), local.Month(), local.Day(), 0, 0, 0, 0, time.Local)
}
buckets := make(map[string]*historyDailyStat, historyStatsDailyDays)
for i := 0; i < historyStatsDailyDays; i++ {
day := startOfDay(cutoff).AddDate(0, 0, i).Format("2006-01-02")
buckets[day] = &historyDailyStat{Day: day}
}
for _, r := range rows {
watched := r.WatchedAt.In(time.Local)
if watched.Before(startOfDay(cutoff)) {
continue
}
if bucket, ok := buckets[watched.Format("2006-01-02")]; ok {
bucket.WatchMs += r.PositionMs
bucket.Plays++
}
}
for i := 0; i < historyStatsDailyDays; i++ {
day := startOfDay(cutoff).AddDate(0, 0, i).Format("2006-01-02")
if bucket, ok := buckets[day]; ok && bucket.Plays > 0 {
daily = append(daily, *bucket)
}
}
mediaIDs := make([]string, 0, len(rows))
for _, r := range rows {
mediaIDs = append(mediaIDs, r.MediaID)
}
var medias []model.Media
_ = svc.Repo.DB.WithContext(ctx).Where("id IN ?", mediaIDs).Find(&medias).Error
mediaByID := make(map[string]*model.Media, len(medias))
for i := range medias {
mediaByID[medias[i].ID] = &medias[i]
}
libraryTypes := make(map[string]string)
var libraries []model.Library
if svc.Repo.Library != nil {
if libs, err := svc.Repo.Library.List(ctx); err == nil {
libraries = libs
}
}
for _, lib := range libraries {
libraryTypes[lib.ID] = lib.Type
}
typeAcc := make(map[string]*historyTypeStat)
order := make([]string, 0, 4)
for _, r := range rows {
media := mediaByID[r.MediaID]
var key string
if media == nil {
// 媒体记录已删除(含 Emby 远程缓存失效):计入 "other" 桶而非丢弃,
// 这样类型分布总数才能与播放历史总数吻合。
key = "other"
} else {
// 如果调用者的可见性策略排除了该媒体,则跳过统计(visibility leak fix)。
if !visibility.Allows(media) {
continue
}
key = strings.TrimSpace(libraryTypes[media.LibraryID])
if key == "" {
key = "other"
}
}
acc, ok := typeAcc[key]
if !ok {
acc = &historyTypeStat{Type: key}
typeAcc[key] = acc
order = append(order, key)
}
acc.WatchMs += r.PositionMs
acc.Count++
}
// 顺序按观看时长降序,让「我主要在看什么」一眼可见。
for _, key := range order {
byType = append(byType, *typeAcc[key])
}
sort.SliceStable(byType, func(i, j int) bool {
if byType[i].WatchMs != byType[j].WatchMs {
return byType[i].WatchMs > byType[j].WatchMs
}
return byType[i].Type < byType[j].Type
})
for _, r := range rows {
if len(recent) >= historyStatsRecentLimit {
break
}
entry := map[string]any{"history": r}
if media := mediaByID[r.MediaID]; media != nil {
// 可见性检查:隐藏库或受档案限制的媒体不进入最近记录(visibility leak fix)。
if !visibility.Allows(media) {
continue
}
entry["media"] = media
} else if svc.EmbyRemote != nil && service.IsEmbyRemoteID(r.MediaID) {
// 尝试从 Emby 远端补全媒体详情,与 historyContinueHandler 保持相同策略。
mountID, remoteID, _ := service.DecodeEmbyRemoteID(r.MediaID)
mount, acct, resolveErr := svc.EmbyRemote.ResolveMount(ctx, mountID)
if resolveErr == nil && mount != nil && acct != nil {
remoteMedia, detailErr := svc.EmbyRemote.RemoteMediaDetail(ctx, mount, acct, remoteID)
if detailErr == nil && remoteMedia != nil {
if !visibility.Allows(remoteMedia) {
continue
}
entry["media"] = *remoteMedia
} else {
// 无法获取 Emby 媒体详情,跳过此条记录。
continue
}
} else {
// 挂载不可用,跳过。
continue
}
} else {
// 媒体记录不存在且无法 Emby 补全,跳过。
continue
}
recent = append(recent, entry)
}
return daily, byType, recent
}
// historyContinueHandler returns "Continue Watching" rows: incomplete
// items, most recent first.
func historyContinueHandler(svc *service.Container) gin.HandlerFunc {
@@ -0,0 +1,349 @@
package handler
import (
"context"
"encoding/json"
"net/http"
"net/http/httptest"
"testing"
"time"
"github.com/gin-gonic/gin"
"github.com/glebarez/sqlite"
"go.uber.org/zap"
"gorm.io/gorm"
"github.com/truewhile/MeBox/internal/middleware"
"github.com/truewhile/MeBox/internal/model"
"github.com/truewhile/MeBox/internal/repository"
"github.com/truewhile/MeBox/internal/service"
)
func newHistoryStatsEnv(t *testing.T) (*gin.Engine, *service.Container, string) {
t.Helper()
gin.SetMode(gin.TestMode)
db, err := gorm.Open(sqlite.Open(":memory:"), &gorm.Config{})
if err != nil {
t.Fatalf("open db: %v", err)
}
if err := db.AutoMigrate(&model.User{}, &model.Library{}, &model.Media{}, &model.PlaybackHistory{}, &model.UserPermission{}); err != nil {
t.Fatalf("migrate: %v", err)
}
repos := repository.New(db)
svc := &service.Container{Repo: repos, Log: zap.NewNop()}
svc.Permissions = service.NewPermissionService(zap.NewNop(), repos)
const userID = "user-1"
if err := repos.User.Create(context.Background(), &model.User{
Base: model.Base{ID: userID}, Username: "tester", PasswordHash: "x", Role: "user", IsActive: true,
}); err != nil {
t.Fatal(err)
}
router := gin.New()
authed := router.Group("/api", func(c *gin.Context) {
c.Set(middleware.CtxUserID, userID)
c.Next()
})
authed.GET("/watch-history/stats", historyStatsHandler(svc))
return router, svc, userID
}
type historyStatsPayload struct {
Total int64 `json:"total"`
Completed int64 `json:"completed"`
InProgress int64 `json:"in_progress"`
WatchedMs int64 `json:"watched_ms"`
WatchedHours float64 `json:"watched_hours"`
Daily []struct {
Day string `json:"day"`
WatchMs int64 `json:"watch_ms"`
Plays int64 `json:"plays"`
} `json:"daily"`
ByLibraryType []struct {
Type string `json:"type"`
WatchMs int64 `json:"watch_ms"`
Count int64 `json:"count"`
} `json:"by_library_type"`
Recent []struct {
Media *model.Media `json:"media"`
} `json:"recent"`
}
func fetchHistoryStats(t *testing.T, router *gin.Engine) historyStatsPayload {
t.Helper()
req := httptest.NewRequest(http.MethodGet, "/api/watch-history/stats", nil)
w := httptest.NewRecorder()
router.ServeHTTP(w, req)
if w.Code != http.StatusOK {
t.Fatalf("status = %d body=%s", w.Code, w.Body.String())
}
var payload historyStatsPayload
if err := json.Unmarshal(w.Body.Bytes(), &payload); err != nil {
t.Fatalf("decode %s: %v", w.Body.String(), err)
}
return payload
}
// 新字段必须提供每日聚合、库类型分布与在看数量,供个人统计页绘图。
func TestHistoryStatsIncludesDailyAndTypes(t *testing.T) {
router, svc, userID := newHistoryStatsEnv(t)
ctx := context.Background()
movieLib := &model.Library{Name: "电影", Path: "/media/movies", Type: "movie", Enabled: true}
if err := svc.Repo.Library.Create(ctx, movieLib); err != nil {
t.Fatal(err)
}
tvLib := &model.Library{Name: "剧集", Path: "/media/tv", Type: "tv", Enabled: true}
if err := svc.Repo.Library.Create(ctx, tvLib); err != nil {
t.Fatal(err)
}
yesterday := time.Now().Add(-24 * time.Hour)
today := time.Now().Add(-time.Hour)
rows := []struct {
media *model.Media
watchedAt time.Time
position int64
completed bool
}{
{
media: &model.Media{LibraryID: movieLib.ID, Title: "电影A", Path: "/media/movies/a.mkv"},
watchedAt: yesterday, position: 60000, completed: true,
},
{
media: &model.Media{LibraryID: tvLib.ID, Title: "剧B", Path: "/media/tv/b.mkv"},
watchedAt: today, position: 30000, completed: false,
},
}
for _, row := range rows {
if err := svc.Repo.DB.Create(row.media).Error; err != nil {
t.Fatal(err)
}
h := &model.PlaybackHistory{
UserID: userID, MediaID: row.media.ID, PositionMs: row.position,
DurationMs: 120000, WatchedAt: row.watchedAt, Completed: row.completed,
}
if err := svc.Repo.DB.Create(h).Error; err != nil {
t.Fatal(err)
}
}
payload := fetchHistoryStats(t, router)
if payload.Total != 2 {
t.Fatalf("total = %d, want 2", payload.Total)
}
if payload.Completed != 1 {
t.Fatalf("completed = %d, want 1", payload.Completed)
}
if payload.InProgress != 1 {
t.Fatalf("in_progress = %d, want 1", payload.InProgress)
}
if payload.WatchedMs != 90000 {
t.Fatalf("watched_ms = %d, want 90000", payload.WatchedMs)
}
if len(payload.Daily) != 2 {
t.Fatalf("daily = %+v, want 2 days", payload.Daily)
}
if len(payload.ByLibraryType) != 2 {
t.Fatalf("by_library_type = %+v, want 2 entries", payload.ByLibraryType)
}
if len(payload.Recent) != 2 {
t.Fatalf("recent = %d entries, want 2", len(payload.Recent))
}
if payload.Recent[0].Media == nil || payload.Recent[0].Media.Title != "剧B" {
t.Fatalf("recent[0] = %+v, want the most recent entry (剧B)", payload.Recent[0])
}
}
// 没有任何播放记录时,新字段要返回空数组而不是 null,前端无需额外判空。
func TestHistoryStatsEmptyProvidesEmptyArrays(t *testing.T) {
router, _, _ := newHistoryStatsEnv(t)
req := httptest.NewRequest(http.MethodGet, "/api/watch-history/stats", nil)
w := httptest.NewRecorder()
router.ServeHTTP(w, req)
body := w.Body.String()
for _, field := range []string{`"daily":[]`, `"by_library_type":[]`, `"recent":[]`} {
if !containsSubstring(body, field) {
t.Fatalf("body = %s, want %s", body, field)
}
}
}
func containsSubstring(haystack, needle string) bool {
for i := 0; i+len(needle) <= len(haystack); i++ {
if haystack[i:i+len(needle)] == needle {
return true
}
}
return false
}
// TestHistoryStatsBreakdownsVisibilityFilter validates that historyStatsBreakdowns
// respects the caller's MediaVisibility: media in a hidden library must be absent
// from both the recent list and the by_library_type buckets.
func TestHistoryStatsBreakdownsVisibilityFilter(t *testing.T) {
_, svc, userID := newHistoryStatsEnv(t)
ctx := context.Background()
allowedLib := &model.Library{Name: "允许库", Path: "/media/allowed", Type: "movie", Enabled: true}
hiddenLib := &model.Library{Name: "隐藏库", Path: "/media/hidden", Type: "tv", Enabled: true}
if err := svc.Repo.Library.Create(ctx, allowedLib); err != nil {
t.Fatal(err)
}
if err := svc.Repo.Library.Create(ctx, hiddenLib); err != nil {
t.Fatal(err)
}
allowedMedia := &model.Media{LibraryID: allowedLib.ID, Title: "允许媒体", Path: "/media/allowed/a.mkv"}
hiddenMedia := &model.Media{LibraryID: hiddenLib.ID, Title: "隐藏媒体", Path: "/media/hidden/b.mkv"}
if err := svc.Repo.DB.Create(allowedMedia).Error; err != nil {
t.Fatal(err)
}
if err := svc.Repo.DB.Create(hiddenMedia).Error; err != nil {
t.Fatal(err)
}
now := time.Now()
for _, mid := range []string{allowedMedia.ID, hiddenMedia.ID} {
h := &model.PlaybackHistory{
UserID: userID, MediaID: mid, PositionMs: 10000,
DurationMs: 100000, WatchedAt: now, Completed: false,
}
if err := svc.Repo.DB.Create(h).Error; err != nil {
t.Fatal(err)
}
}
// visibility that hides hiddenLib
vis := service.MediaVisibility{
HiddenLibraryIDs: []string{hiddenLib.ID},
}
_, byType, recent := historyStatsBreakdowns(ctx, svc, userID, vis)
// recent must contain only the allowed media
for _, entry := range recent {
m, ok := entry["media"]
if !ok {
t.Fatal("recent entry missing media field")
}
switch med := m.(type) {
case *model.Media:
if med.LibraryID == hiddenLib.ID {
t.Fatalf("hidden media appeared in recent: %s", med.Title)
}
case model.Media:
if med.LibraryID == hiddenLib.ID {
t.Fatalf("hidden media appeared in recent: %s", med.Title)
}
}
}
if len(recent) != 1 {
t.Fatalf("recent length = %d, want 1 (hidden entry must be excluded)", len(recent))
}
// by_library_type must not contain the hidden library's type ("tv")
for _, bt := range byType {
if bt.Type == "tv" {
t.Fatalf("hidden library type 'tv' appeared in by_library_type (count=%d)", bt.Count)
}
}
}
// TestHistoryStatsBreakdownsNilMediaCountsAsOther confirms that a history row
// whose media has been deleted (nil lookup) is counted under the "other" type
// bucket rather than silently dropped.
func TestHistoryStatsBreakdownsNilMediaCountsAsOther(t *testing.T) {
_, svc, userID := newHistoryStatsEnv(t)
ctx := context.Background()
// Insert a history row whose media_id does not correspond to any Media row.
ghost := &model.PlaybackHistory{
UserID: userID,
MediaID: "ghost-media-id",
PositionMs: 5000,
DurationMs: 50000,
WatchedAt: time.Now(),
Completed: false,
}
if err := svc.Repo.DB.Create(ghost).Error; err != nil {
t.Fatal(err)
}
vis := service.MediaVisibility{} // unrestricted
_, byType, _ := historyStatsBreakdowns(ctx, svc, userID, vis)
var otherEntry *historyTypeStat
for i := range byType {
if byType[i].Type == "other" {
otherEntry = &byType[i]
break
}
}
if otherEntry == nil {
t.Fatalf("expected 'other' bucket for nil-media history row, got %+v", byType)
}
if otherEntry.Count != 1 {
t.Fatalf("other.Count = %d, want 1", otherEntry.Count)
}
}
// TestHistoryStatsPermissionDeny checks that a user without can_view_history
// receives HTTP 403 from the gated route.
func TestHistoryStatsPermissionDeny(t *testing.T) {
gin.SetMode(gin.TestMode)
db, err := gorm.Open(sqlite.Open(":memory:"), &gorm.Config{})
if err != nil {
t.Fatalf("open db: %v", err)
}
if err := db.AutoMigrate(
&model.User{}, &model.Library{}, &model.Media{},
&model.PlaybackHistory{}, &model.UserPermission{},
); err != nil {
t.Fatalf("migrate: %v", err)
}
repos := repository.New(db)
svc := &service.Container{Repo: repos, Log: zap.NewNop()}
svc.Permissions = service.NewPermissionService(zap.NewNop(), repos)
const userID = "user-noperm"
if err := repos.User.Create(context.Background(), &model.User{
Base: model.Base{ID: userID}, Username: "noperm", PasswordHash: "x", Role: "user", IsActive: true,
}); err != nil {
t.Fatal(err)
}
// Explicitly deny can_view_history for this user.
// First seed defaults (Effective will create the row with defaults), then
// update to deny via Save which uses an explicit map update path in the repo.
if _, err := svc.Permissions.Effective(context.Background(), userID); err != nil {
t.Fatalf("seed permissions: %v", err)
}
denyPerm := &model.UserPermission{UserID: userID, CanViewHistory: false}
if err := svc.Permissions.Save(context.Background(), userID, denyPerm); err != nil {
t.Fatalf("save permission: %v", err)
}
router := gin.New()
authed := router.Group("/api", func(c *gin.Context) {
c.Set(middleware.CtxUserID, userID)
c.Set(middleware.CtxUserRole, "user")
c.Next()
})
authed.GET("/watch-history/stats", requirePermission(svc, "can_view_history"), historyStatsHandler(svc))
req := httptest.NewRequest(http.MethodGet, "/api/watch-history/stats", nil)
w := httptest.NewRecorder()
router.ServeHTTP(w, req)
if w.Code != http.StatusForbidden {
t.Fatalf("status = %d, want 403 for user without can_view_history", w.Code)
}
}
+42
View File
@@ -0,0 +1,42 @@
package model
import "time"
// MediaProbe 是一次 ffprobe 全量探测(容器 / 轨道 / 内嵌章节)的结果缓存。
//
// 它存在的理由:探测一次要 3~4 秒——远端直链更慢,因为要跨洋跑三次 HTTP
// 事务。播放链路绝不能等它,所以第一次播放只起后台任务,结果落库后由后续请求
// 与「跳过片头」的章节数据直接读库。
//
// Payload 刻意只保存裁剪后的字段:ffprobe 原始输出里的 format.filename 是解析
// 后的播放直链(带网盘签名与 pickcode),原样落库等于把可直接下载的链接留在
// 数据库里,所以只保留与技术信息有关的字段。
type MediaProbe struct {
Base
MediaID string `gorm:"uniqueIndex;size:128;not null" json:"media_id"`
// Signature 是「探的是哪个文件」的指纹(哈希):本地文件取路径 + 大小 +
// 修改时间,STRM / 云盘取固化的播放目标。文件换了就说明缓存不再对应当前
// 内容,需要重探。
Signature string `gorm:"size:64" json:"signature,omitempty"`
// Source 记录输入形态:local | strm。
Source string `gorm:"size:16" json:"source,omitempty"`
Container string `gorm:"size:64" json:"container,omitempty"`
DurationSec int `json:"duration_sec"`
BitRate int64 `json:"bit_rate,omitempty"`
Width int `json:"width,omitempty"`
Height int `json:"height,omitempty"`
VideoCodec string `gorm:"size:64" json:"video_codec,omitempty"`
AudioCodec string `gorm:"size:64" json:"audio_codec,omitempty"`
VideoStreams int `json:"video_streams"`
AudioStreams int `json:"audio_streams"`
SubtitleStreams int `json:"subtitle_streams"`
ChapterCount int `json:"chapter_count"`
// Payload 是供详情页展示的裁剪后 JSON(容器 + 每路轨道 + 章节)。
Payload string `gorm:"type:text" json:"payload,omitempty"`
// ProbedAt 是最近一次探测的时刻。LastError 非空表示这次探测失败;失败只更新
// 这两个字段,不会覆盖此前成功的 Payload 与已经落库的章节片段。
ProbedAt time.Time `json:"probed_at"`
LastError string `gorm:"size:512" json:"last_error,omitempty"`
}
+39
View File
@@ -0,0 +1,39 @@
package model
import "time"
// 片段类型与 TheIntroDB 的返回字段一一对应。客户端按 kind 决定按钮文案
// (片头 / 回顾 / 片尾 / 预告),不依赖具体来源。
const (
SegmentKindIntro = "intro"
SegmentKindRecap = "recap"
SegmentKindCredits = "credits"
SegmentKindPreview = "preview"
)
// MediaSegment 是媒体源时间轴上一个可被跳过的区间(片头 / 回顾 / 片尾 / 预告)。
// 提供方(当前为 TheIntroDB)填充,播放器消费后向用户提供「跳过片头」。
type MediaSegment struct {
Base
MediaID string `gorm:"index;size:128;not null;uniqueIndex:uniq_media_segment" json:"media_id"`
SeriesID string `gorm:"index;size:128" json:"series_id,omitempty"`
Kind string `gorm:"size:16;not null;uniqueIndex:uniq_media_segment" json:"kind"`
// StartMs/EndMs 是媒体源时间轴上的毫秒绝对值。EndMs 为 0 表示区间一直延续到
// 片尾(TheIntroDB 对末段返回 end_ms: null),由客户端结合媒体总时长补齐。
StartMs int64 `gorm:"not null;default:0;uniqueIndex:uniq_media_segment" json:"start_ms"`
EndMs int64 `gorm:"not null;default:0" json:"end_ms"`
// Source 记录数据来源,让同一媒体上多来源共存、以及将来的人工覆盖成为可能。
// 它必须参与唯一索引:否则「外部数据」与「人工修正」给出同一区间时会撞索引。
Source string `gorm:"size:32;not null;default:'';uniqueIndex:uniq_media_segment" json:"source,omitempty"`
}
// MediaSegmentFetch 记录「某媒体的片段是否已向某来源查询过」。
// 单独建表是为了能缓存「查不到」这个结果:没有负缓存的话,每次播放一部社区库里
// 还没有数据的影片都会重新打一次外网。
type MediaSegmentFetch struct {
Base
MediaID string `gorm:"index;size:128;not null;uniqueIndex:uniq_media_segment_fetch" json:"media_id"`
Source string `gorm:"size:32;not null;uniqueIndex:uniq_media_segment_fetch" json:"source"`
FetchedAt time.Time `json:"fetched_at"`
Found bool `json:"found"`
}
+3
View File
@@ -38,6 +38,9 @@ func AllModels() []interface{} {
&Series{},
&Media{},
&PlaybackHistory{},
&MediaSegment{},
&MediaSegmentFetch{},
&MediaProbe{},
&Favorite{},
&Playlist{},
&PlaylistItem{},
+3
View File
@@ -55,6 +55,9 @@ type User struct {
// expires. When set and in the past, the account is treated as expired
// (login blocked) until an admin or a redemption code renews it.
ExpiredAt *time.Time `json:"expired_at,omitempty"`
// TelegramChatID 是用户绑定的 Telegram 会话 ID,用于接收账号与设备通知。
// 为空表示未绑定;绑定走个人资料页生成的一次性码 + Bot /bind 命令。
TelegramChatID string `gorm:"size:64" json:"telegram_chat_id,omitempty"`
// ShareWarnings counts anti-account-sharing warnings, mainly device
// fingerprint mismatches. Once it exceeds the configured threshold a
// re-offence disables the account until an admin re-enables it.
+24
View File
@@ -0,0 +1,24 @@
package model
import (
"sync"
"testing"
"gorm.io/gorm/schema"
)
// TelegramChatID 是 Telegram 通知的绑定目标:Size 必须容得下真实 chat id
// (群/频道 id 为负数且位数更长),因此下限设为 64。
func TestUserTelegramChatIDFieldSize(t *testing.T) {
parsed, err := schema.Parse(&User{}, &sync.Map{}, schema.NamingStrategy{})
if err != nil {
t.Fatal(err)
}
field := parsed.LookUpField("TelegramChatID")
if field == nil {
t.Fatal("TelegramChatID field not found")
}
if field.Size < 64 {
t.Fatalf("TelegramChatID size = %d, want at least 64", field.Size)
}
}
+174
View File
@@ -0,0 +1,174 @@
package repository
import (
"context"
"testing"
"github.com/glebarez/sqlite"
"gorm.io/gorm"
"gorm.io/gorm/logger"
"github.com/truewhile/MeBox/internal/model"
)
func newMediaFilterTestDB(t *testing.T) *gorm.DB {
t.Helper()
db, err := gorm.Open(sqlite.Open(":memory:"), &gorm.Config{
Logger: logger.Default.LogMode(logger.Silent),
})
if err != nil {
t.Fatal(err)
}
if err := db.AutoMigrate(&model.Media{}, &model.PlaybackHistory{}); err != nil {
t.Fatal(err)
}
return db
}
func seedFilterMedia(t *testing.T, db *gorm.DB, rows ...*model.Media) {
t.Helper()
for _, row := range rows {
if err := db.WithContext(context.Background()).Create(row).Error; err != nil {
t.Fatal(err)
}
}
}
func listFiltered(t *testing.T, db *gorm.DB, filter MediaQueryFilter) []string {
t.Helper()
var rows []model.Media
q := db.WithContext(context.Background()).Model(&model.Media{})
q = applyMediaQueryFilter(q, filter)
if err := q.Order("title asc").Find(&rows).Error; err != nil {
t.Fatal(err)
}
out := make([]string, 0, len(rows))
for _, row := range rows {
out = append(out, row.Title)
}
return out
}
func hasTitle(items []string, want string) bool {
for _, item := range items {
if item == want {
return true
}
}
return false
}
// 多个类型之间是「或」:勾选 Action 与 Comedy 应同时命中两类。
func TestFilterByGenreOR(t *testing.T) {
db := newMediaFilterTestDB(t)
seedFilterMedia(t, db,
&model.Media{Title: "动作", Genres: "Action", Path: "/a.mkv", LibraryID: "lib-1"},
&model.Media{Title: "喜剧", Genres: "Comedy", Path: "/b.mkv", LibraryID: "lib-1"},
&model.Media{Title: "剧情", Genres: "Drama", Path: "/c.mkv", LibraryID: "lib-1"},
)
got := listFiltered(t, db, MediaQueryFilter{IncludeNSFW: true, Genres: []string{"Action", "Comedy"}})
if !hasTitle(got, "动作") || !hasTitle(got, "喜剧") {
t.Fatalf("result = %v, want both 动作 and 喜剧", got)
}
if hasTitle(got, "剧情") {
t.Fatalf("result = %v, must not contain 剧情", got)
}
}
// 类型匹配必须是整词匹配:搜 "Action" 不能命中 "ActionComedy" 这类拼接值。
func TestFilterByGenreDoesNotMatchSubstring(t *testing.T) {
db := newMediaFilterTestDB(t)
seedFilterMedia(t, db,
&model.Media{Title: "精确", Genres: "Action,Drama", Path: "/a.mkv", LibraryID: "lib-1"},
&model.Media{Title: "拼接", Genres: "ActionComedy", Path: "/b.mkv", LibraryID: "lib-1"},
)
got := listFiltered(t, db, MediaQueryFilter{IncludeNSFW: true, Genres: []string{"Action"}})
if !hasTitle(got, "精确") {
t.Fatalf("result = %v, want 精确", got)
}
if hasTitle(got, "拼接") {
t.Fatalf("result = %v, must not match ActionComedy for Action", got)
}
}
func TestFilterYearAndRating(t *testing.T) {
db := newMediaFilterTestDB(t)
seedFilterMedia(t, db,
&model.Media{Title: "老片", Year: 1995, Rating: 9, Path: "/a.mkv", LibraryID: "lib-1"},
&model.Media{Title: "中年", Year: 2010, Rating: 5, Path: "/b.mkv", LibraryID: "lib-1"},
&model.Media{Title: "新片", Year: 2023, Rating: 8, Path: "/c.mkv", LibraryID: "lib-1"},
)
got := listFiltered(t, db, MediaQueryFilter{IncludeNSFW: true, YearMin: 2000, YearMax: 2020})
if len(got) != 1 || got[0] != "中年" {
t.Fatalf("year filter result = %v, want [中年]", got)
}
got = listFiltered(t, db, MediaQueryFilter{IncludeNSFW: true, RatingMin: 8})
if len(got) != 2 {
t.Fatalf("rating filter result = %v, want 2 entries", got)
}
}
// 「未观看」的语义是「没有标记看完的记录」:看了一半的仍应出现。
func TestFilterUnwatchedExcludesCompleted(t *testing.T) {
db := newMediaFilterTestDB(t)
seedFilterMedia(t, db,
&model.Media{Base: model.Base{ID: "m-done"}, Title: "看完", Path: "/a.mkv", LibraryID: "lib-1"},
&model.Media{Base: model.Base{ID: "m-half"}, Title: "看一半", Path: "/b.mkv", LibraryID: "lib-1"},
&model.Media{Base: model.Base{ID: "m-new"}, Title: "没看过", Path: "/c.mkv", LibraryID: "lib-1"},
)
ctx := context.Background()
for _, h := range []*model.PlaybackHistory{
{UserID: "u1", MediaID: "m-done", Completed: true},
{UserID: "u1", MediaID: "m-half", Completed: false},
// 别人的完播记录不应影响本人筛选。
{UserID: "u2", MediaID: "m-new", Completed: true},
} {
if err := db.WithContext(ctx).Create(h).Error; err != nil {
t.Fatal(err)
}
}
got := listFiltered(t, db, MediaQueryFilter{
IncludeNSFW: true, UnwatchedOnly: true, UnwatchedUserID: "u1",
})
if hasTitle(got, "看完") {
t.Fatalf("result = %v, must exclude completed media", got)
}
if !hasTitle(got, "看一半") || !hasTitle(got, "没看过") {
t.Fatalf("result = %v, want both 看一半 and 没看过", got)
}
}
// 多词类型(如 "Science Fiction"):列侧 SQL 会 REPLACE 掉空格,参数侧也必须同步
// 去掉空格,两侧对称才能命中。
func TestFilterByGenreMultiWordStripsSpaces(t *testing.T) {
db := newMediaFilterTestDB(t)
seedFilterMedia(t, db,
&model.Media{Title: "科幻", Genres: "Science Fiction,Drama", Path: "/a.mkv", LibraryID: "lib-1"},
&model.Media{Title: "动作", Genres: "Action", Path: "/b.mkv", LibraryID: "lib-1"},
)
got := listFiltered(t, db, MediaQueryFilter{IncludeNSFW: true, Genres: []string{"Science Fiction"}})
if !hasTitle(got, "科幻") {
t.Fatalf("result = %v, want 科幻 (multi-word genre must match after space stripping)", got)
}
if hasTitle(got, "动作") {
t.Fatalf("result = %v, must not contain 动作", got)
}
}
// UnwatchedOnly 缺省 userID 时必须忽略该条件,而不是返回空结果。
func TestFilterUnwatchedWithoutUserIsIgnored(t *testing.T) {
db := newMediaFilterTestDB(t)
seedFilterMedia(t, db, &model.Media{Title: "片", Path: "/a.mkv", LibraryID: "lib-1"})
got := listFiltered(t, db, MediaQueryFilter{IncludeNSFW: true, UnwatchedOnly: true})
if len(got) != 1 {
t.Fatalf("result = %v, want the row to be returned", got)
}
}
@@ -0,0 +1,61 @@
package repository
import (
"context"
"errors"
"time"
"gorm.io/gorm"
"gorm.io/gorm/clause"
"github.com/truewhile/MeBox/internal/model"
)
// MediaProbeRepository 持久化 ffprobe 全量探测的结果缓存。
type MediaProbeRepository struct{ db *gorm.DB }
// Get 返回某媒体的探测缓存,未探测过时返回 (nil, nil)。
func (r *MediaProbeRepository) Get(ctx context.Context, mediaID string) (*model.MediaProbe, error) {
var row model.MediaProbe
err := r.db.WithContext(ctx).
Where("media_id = ?", mediaID).
First(&row).Error
if errors.Is(err, gorm.ErrRecordNotFound) {
return nil, nil
}
if err != nil {
return nil, err
}
return &row, nil
}
// Upsert 写入一次成功的探测结果(含裁剪后的媒体信息)。
func (r *MediaProbeRepository) Upsert(ctx context.Context, row *model.MediaProbe) error {
onConflict := clause.OnConflict{
Columns: []clause.Column{{Name: "media_id"}},
DoUpdates: clause.AssignmentColumns([]string{
"signature", "source",
"container", "duration_sec", "bit_rate",
"width", "height", "video_codec", "audio_codec",
"video_streams", "audio_streams", "subtitle_streams", "chapter_count",
"payload", "probed_at", "last_error",
"deleted_at",
}),
}
return r.db.WithContext(ctx).Clauses(onConflict).Create(row).Error
}
// MarkFailure 记录一次失败的探测。它只更新「时间 + 错误信息」,刻意不碰
// payload 与其它字段:一次失败的重探不该把上一次成功拿到的媒体信息抹掉。
func (r *MediaProbeRepository) MarkFailure(ctx context.Context, mediaID, message string, probedAt time.Time) error {
row := model.MediaProbe{MediaID: mediaID, ProbedAt: probedAt, LastError: message}
onConflict := clause.OnConflict{
Columns: []clause.Column{{Name: "media_id"}},
DoUpdates: clause.Assignments(map[string]any{
"probed_at": probedAt,
"last_error": message,
"deleted_at": nil,
}),
}
return r.db.WithContext(ctx).Clauses(onConflict).Create(&row).Error
}
@@ -0,0 +1,105 @@
package repository
import (
"testing"
"time"
"github.com/truewhile/MeBox/internal/model"
)
func TestMediaProbeUpsertReplacesAndGetReturnsLatest(t *testing.T) {
repos := newSegmentTestRepos(t)
ctx := t.Context()
first := &model.MediaProbe{
MediaID: "m-1", Signature: "sig-1", Source: "local",
Container: "matroska,webm", DurationSec: 1451, ChapterCount: 2,
Payload: `{"container":"matroska,webm"}`, ProbedAt: time.Now(),
}
if err := repos.MediaProbe.Upsert(ctx, first); err != nil {
t.Fatalf("upsert #1: %v", err)
}
second := &model.MediaProbe{
MediaID: "m-1", Signature: "sig-2", Source: "strm",
Container: "mp4", DurationSec: 900, ChapterCount: 0,
Payload: `{"container":"mp4"}`, ProbedAt: time.Now(),
}
if err := repos.MediaProbe.Upsert(ctx, second); err != nil {
t.Fatalf("upsert #2: %v", err)
}
got, err := repos.MediaProbe.Get(ctx, "m-1")
if err != nil {
t.Fatal(err)
}
if got == nil {
t.Fatal("probe row missing")
}
if got.Container != "mp4" || got.DurationSec != 900 || got.Signature != "sig-2" || got.Payload != `{"container":"mp4"}` {
t.Fatalf("probe = %#v, want the second upsert to win", got)
}
// 重复探测不能累积重复行:media_id 是唯一索引。
var count int64
if err := repos.DB.Model(&model.MediaProbe{}).Where("media_id = ?", "m-1").Count(&count).Error; err != nil {
t.Fatal(err)
}
if count != 1 {
t.Fatalf("rows = %d, want 1", count)
}
}
func TestMediaProbeGetReturnsNilWhenMissing(t *testing.T) {
repos := newSegmentTestRepos(t)
got, err := repos.MediaProbe.Get(t.Context(), "nope")
if err != nil {
t.Fatalf("Get: %v", err)
}
if got != nil {
t.Fatalf("probe = %#v, want nil", got)
}
}
func TestMediaProbeMarkFailureKeepsPreviousPayload(t *testing.T) {
repos := newSegmentTestRepos(t)
ctx := t.Context()
if err := repos.MediaProbe.Upsert(ctx, &model.MediaProbe{
MediaID: "m-1", Container: "matroska,webm", DurationSec: 1451,
ChapterCount: 2, Payload: `{"container":"matroska,webm"}`, ProbedAt: time.Now(),
}); err != nil {
t.Fatal(err)
}
if err := repos.MediaProbe.MarkFailure(ctx, "m-1", "ffprobe full: exit status 1", time.Now()); err != nil {
t.Fatal(err)
}
got, err := repos.MediaProbe.Get(ctx, "m-1")
if err != nil {
t.Fatal(err)
}
if got == nil || got.LastError != "ffprobe full: exit status 1" {
t.Fatalf("probe = %#v, want the recorded failure", got)
}
// 一次失败的重探不该把上一次成功拿到的媒体信息抹掉。
if got.Container != "matroska,webm" || got.DurationSec != 1451 || got.Payload == "" || got.ChapterCount != 2 {
t.Fatalf("a failed re-probe wiped the previous summary: %#v", got)
}
}
func TestMediaProbeMarkFailureInsertsRowWhenAbsent(t *testing.T) {
repos := newSegmentTestRepos(t)
ctx := t.Context()
// 没有历史成功记录时,失败也必须落一行:否则冷却期没有时间戳,
// 每次播放都会重跑一次注定失败的探测。
if err := repos.MediaProbe.MarkFailure(ctx, "m-2", "boom", time.Now()); err != nil {
t.Fatal(err)
}
got, err := repos.MediaProbe.Get(ctx, "m-2")
if err != nil {
t.Fatal(err)
}
if got == nil || got.LastError != "boom" || got.ProbedAt.IsZero() {
t.Fatalf("probe = %#v, want a failure row with a timestamp", got)
}
}
+149
View File
@@ -44,6 +44,21 @@ type MediaQueryFilter struct {
AllowedLibraryIDs []string
HiddenLibraryIDs []string
SeriesID string
// LibraryID 是精确匹配的单个库过滤,用于库内场景(例如媒体库页筛选)。
// 它与 AllowedLibraryIDs 是「与」关系:可见性仍由后者兜底,避免越权。
LibraryID string
// Genres 是类型多选,之间为「或」。按整词匹配(见 genreMatchClause)。
Genres []string
// YearMin / YearMax 为 0 表示该端不限。
YearMin int
YearMax int
// RatingMin 为 0 表示不限。
RatingMin float64
// UnwatchedOnly 排除 UnwatchedUserID 已标记看完的条目。
// 「未观看」定义为「没有 completed=true 的记录」:看到一半的仍会出现,
// 与「继续观看」互补而不是重复。
UnwatchedOnly bool
UnwatchedUserID string
}
func applyMediaQueryFilter(q *gorm.DB, filter MediaQueryFilter) *gorm.DB {
@@ -56,12 +71,113 @@ func applyMediaQueryFilter(q *gorm.DB, filter MediaQueryFilter) *gorm.DB {
if len(filter.AllowedLibraryIDs) > 0 {
q = q.Where("library_id IN ?", filter.AllowedLibraryIDs)
}
if libraryID := strings.TrimSpace(filter.LibraryID); libraryID != "" {
q = q.Where("library_id = ?", libraryID)
}
if seriesID := strings.TrimSpace(filter.SeriesID); seriesID != "" {
q = q.Where("series_id = ?", seriesID)
}
if len(filter.Genres) > 0 {
q = q.Where(genreMatchClause(filter.Genres), genreMatchArgs(filter.Genres)...)
}
if filter.YearMin > 0 {
q = q.Where("year >= ?", filter.YearMin)
}
if filter.YearMax > 0 {
q = q.Where("year <= ?", filter.YearMax)
}
if filter.RatingMin > 0 {
q = q.Where("rating >= ?", filter.RatingMin)
}
if filter.UnwatchedOnly {
userID := strings.TrimSpace(filter.UnwatchedUserID)
// 没有用户上下文时忽略该条件:否则会把整个库筛成空,看起来像「坏了」。
if userID != "" {
q = q.Where(
"id NOT IN (SELECT media_id FROM playback_histories WHERE user_id = ? AND completed = ?)",
userID, true,
)
}
}
return q
}
// genreMatchClause 生成类型整词匹配条件。
//
// genres 列是逗号分隔字符串,直接 LIKE '%Action%' 会把 "ActionComedy" 也命中。
// 这里统一补上首尾逗号(并用空格容错)后再按 "%,Action,%" 匹配,实现整词语义;
// 该写法在 SQLite 与 PostgreSQL 上行为一致,因此不需要方言分支。
//
// 注意写法:参数本身带上首尾逗号,SQL 里只做一次 REPLACE 来保证列值两端也有
// 分隔符,避免 OR 链里重复拼接列表达式。
func genreMatchClause(genres []string) string {
clauses := make([]string, 0, len(genres))
for range genres {
clauses = append(clauses, "',' || REPLACE(REPLACE(TRIM(genres), ' ', ''), ',', ',') || ',' LIKE ?")
}
return "(" + strings.Join(clauses, " OR ") + ")"
}
// genreMatchArgs 生成与 genreMatchClause 对应的参数,形如 "%,Action,%"。
//
// 必须与 genreMatchClause 的列端处理完全对称:
// - TRIM → TrimSpace
// - REPLACE(…, ' ', '') → ReplaceAll(…, " ", "") ← 多词类型(如 "Science Fiction")
// - REPLACE(…, ',', ',') → ReplaceAll(…, ",", ",")
func genreMatchArgs(genres []string) []any {
args := make([]any, 0, len(genres))
for _, genre := range genres {
name := strings.ReplaceAll(strings.TrimSpace(genre), ",", ",")
name = strings.ReplaceAll(name, " ", "") // mirror REPLACE(…,' ','') in genreMatchClause
if name == "" {
name = "\x00" // 空类型不会命中任何行
}
args = append(args, "%,"+name+",%")
}
return args
}
// ListGenreValues 返回符合过滤条件的 media.genres 原始值(逗号分隔字符串)。
//
// 只取单列:类型聚合不需要整行 media,而一台大库的整行扫描会把海报 URL、
// 简介等大字段一起读进内存。切分与去重交给调用方,SQL 层保持方言无关。
func (r *MediaRepository) ListGenreValues(ctx context.Context, filter MediaQueryFilter) ([]string, error) {
var values []string
q := r.db.WithContext(ctx).
Model(&model.Media{}).
Where("genres IS NOT NULL AND genres <> ''")
q = applyMediaQueryFilter(q, filter)
if err := q.Pluck("genres", &values).Error; err != nil {
return nil, err
}
return values, nil
}
// YearRange 返回符合过滤条件的年份区间(两端都为 0 表示没有可用年份)。
// 供媒体库筛选面板生成年份上下限,避免前端硬编码或先取全量再自己算。
func (r *MediaRepository) YearRange(ctx context.Context, filter MediaQueryFilter) (int, int, error) {
var bounds struct {
MinYear *int
MaxYear *int
}
q := r.db.WithContext(ctx).
Model(&model.Media{}).
Where("year > 0").
Select("MIN(year) AS min_year, MAX(year) AS max_year")
q = applyMediaQueryFilter(q, filter)
if err := q.Scan(&bounds).Error; err != nil {
return 0, 0, err
}
min, max := 0, 0
if bounds.MinYear != nil {
min = *bounds.MinYear
}
if bounds.MaxYear != nil {
max = *bounds.MaxYear
}
return min, max, nil
}
func (r *MediaRepository) indexMediaBestEffort(ctx context.Context, media model.Media) {
backend, ok := r.searchBackend.(MediaSearchSyncBackend)
if !ok {
@@ -83,6 +199,39 @@ func (r *MediaRepository) FindByID(ctx context.Context, id string) (*model.Media
return &m, nil
}
// ExistsSiblingWithTMDbID reports whether another row of the same show carries
// the same tm_db_id as m.
//
// 它的用途是把「剧集级 id」和「单集自己的 id」区分开:一部剧的多集共用一个
// 剧集级 id,而单集各自的 id 不会重复。调用方据此决定能否把 Media.TMDbID
// 当作 Series.TMDbID 的替代品(见 MediaSegmentService.queryIDs)。
//
// 同一部剧的判定优先用 series_id;没有 series_id 的行(部分刮削路径不写它)
// 退回到「同一个库 + 同一个标题」。查询失败按「不共用」处理:宁可不查,
// 也不能拿一个可能是单集的 id 去查错片。
func (r *MediaRepository) ExistsSiblingWithTMDbID(ctx context.Context, m *model.Media) bool {
if r == nil || m == nil || m.TMDbID <= 0 || m.ID == "" {
return false
}
query := r.db.WithContext(ctx).Model(&model.Media{}).
Where("tm_db_id = ? AND id <> ?", m.TMDbID, m.ID)
if seriesID := strings.TrimSpace(m.SeriesID); seriesID != "" {
query = query.Where("series_id = ?", seriesID)
} else {
libraryID := strings.TrimSpace(m.LibraryID)
title := strings.TrimSpace(m.Title)
if libraryID == "" || title == "" {
return false
}
query = query.Where("library_id = ? AND title = ?", libraryID, title)
}
var count int64
if err := query.Limit(1).Count(&count).Error; err != nil {
return false
}
return count > 0
}
// ListByLibrary returns paginated media items for a library.
func (r *MediaRepository) ListByLibrary(ctx context.Context, libraryID string, offset, limit int) ([]model.Media, int64, error) {
return r.ListByLibraryFiltered(ctx, libraryID, offset, limit, MediaQueryFilter{IncludeNSFW: true})
@@ -0,0 +1,86 @@
package repository
import (
"context"
"errors"
"gorm.io/gorm"
"gorm.io/gorm/clause"
"github.com/truewhile/MeBox/internal/model"
)
// MediaSegmentRepository persists intro/recap/credits/preview ranges.
type MediaSegmentRepository struct{ db *gorm.DB }
// ListByMedia returns every stored segment for a media item, ordered by start.
func (r *MediaSegmentRepository) ListByMedia(ctx context.Context, mediaID string) ([]model.MediaSegment, error) {
rows := make([]model.MediaSegment, 0, 4)
err := r.db.WithContext(ctx).
Where("media_id = ?", mediaID).
Order("start_ms asc").
Find(&rows).Error
return rows, err
}
// ListByMediaSource returns the segments contributed by one source only, ordered
// by start. Used to read the ffprobe-extracted chapters independently of the
// community-database rows, so the player can pick between them.
func (r *MediaSegmentRepository) ListByMediaSource(ctx context.Context, mediaID, source string) ([]model.MediaSegment, error) {
rows := make([]model.MediaSegment, 0, 4)
err := r.db.WithContext(ctx).
Where("media_id = ? AND source = ?", mediaID, source).
Order("start_ms asc").
Find(&rows).Error
return rows, err
}
// ReplaceForMedia swaps the segments contributed by one source in a single
// transaction, so a provider refresh can never leave a half-updated set.
//
// Rows are hard-deleted rather than soft-deleted: the unique index on
// (media_id, kind, start_ms) would otherwise collide with the tombstoned rows
// on the next insert.
func (r *MediaSegmentRepository) ReplaceForMedia(ctx context.Context, mediaID, source string, rows []model.MediaSegment) error {
return r.db.WithContext(ctx).Transaction(func(tx *gorm.DB) error {
if err := tx.Unscoped().
Where("media_id = ? AND source = ?", mediaID, source).
Delete(&model.MediaSegment{}).Error; err != nil {
return err
}
if len(rows) == 0 {
return nil
}
return tx.Create(&rows).Error
})
}
// GetFetch returns the fetch ledger row for (media, source), or (nil, nil).
func (r *MediaSegmentRepository) GetFetch(ctx context.Context, mediaID, source string) (*model.MediaSegmentFetch, error) {
var row model.MediaSegmentFetch
err := r.db.WithContext(ctx).
Where("media_id = ? AND source = ?", mediaID, source).
First(&row).Error
if errors.Is(err, gorm.ErrRecordNotFound) {
return nil, nil
}
if err != nil {
return nil, err
}
return &row, nil
}
// UpsertFetch records the outcome of a provider lookup. The `deleted_at: nil`
// assignment revives a previously deleted row instead of failing on the unique
// index, mirroring the playback history upsert.
func (r *MediaSegmentRepository) UpsertFetch(ctx context.Context, row *model.MediaSegmentFetch) error {
onConflict := clause.OnConflict{
Columns: []clause.Column{{Name: "media_id"}, {Name: "source"}},
DoUpdates: clause.Assignments(map[string]any{
"fetched_at": row.FetchedAt,
"found": row.Found,
"deleted_at": nil,
}),
}
return r.db.WithContext(ctx).Clauses(onConflict).Create(row).Error
}
@@ -0,0 +1,154 @@
package repository
import (
"testing"
"time"
"github.com/glebarez/sqlite"
"gorm.io/gorm"
"github.com/truewhile/MeBox/internal/database"
"github.com/truewhile/MeBox/internal/model"
)
func newSegmentTestRepos(t *testing.T) *Container {
t.Helper()
db, err := gorm.Open(sqlite.Open(":memory:"), &gorm.Config{})
if err != nil {
t.Fatal(err)
}
if err := database.AutoMigrate(db); err != nil {
t.Fatalf("migrate: %v", err)
}
return New(db)
}
func TestReplaceForMediaIsIdempotentAcrossRefreshes(t *testing.T) {
repos := newSegmentTestRepos(t)
ctx := t.Context()
rows := []model.MediaSegment{
{MediaID: "m-1", Kind: model.SegmentKindIntro, StartMs: 228_664, EndMs: 246_143, Source: "theintrodb"},
{MediaID: "m-1", Kind: model.SegmentKindCredits, StartMs: 3_431_000, EndMs: 0, Source: "theintrodb"},
}
// 重复刷新不能因为 (media_id, kind, start_ms, source) 唯一索引而失败,也不能累积重复行。
for i := 0; i < 2; i++ {
if err := repos.MediaSegment.ReplaceForMedia(ctx, "m-1", "theintrodb", rows); err != nil {
t.Fatalf("replace #%d: %v", i+1, err)
}
}
got, err := repos.MediaSegment.ListByMedia(ctx, "m-1")
if err != nil {
t.Fatal(err)
}
if len(got) != 2 {
t.Fatalf("rows = %d, want 2 after two refreshes of the same source", len(got))
}
// 替换只影响同一来源:另一个来源的数据必须保留。
other := []model.MediaSegment{
{MediaID: "m-1", Kind: model.SegmentKindIntro, StartMs: 10, EndMs: 20, Source: "manual"},
}
if err := repos.MediaSegment.ReplaceForMedia(ctx, "m-1", "manual", other); err != nil {
t.Fatal(err)
}
got, err = repos.MediaSegment.ListByMedia(ctx, "m-1")
if err != nil {
t.Fatal(err)
}
if len(got) != 3 {
t.Fatalf("rows = %d, want 3 (2 theintrodb + 1 manual)", len(got))
}
if got[0].Source != "manual" || got[0].StartMs != 10 {
t.Fatalf("rows should be ordered by start_ms, got first = %#v", got[0])
}
}
func TestReplaceForMediaAllowsSameRangeFromDifferentSources(t *testing.T) {
repos := newSegmentTestRepos(t)
ctx := t.Context()
span := model.MediaSegment{MediaID: "m-1", Kind: model.SegmentKindIntro, StartMs: 1_000, EndMs: 2_000}
provider := span
provider.Source = "theintrodb"
if err := repos.MediaSegment.ReplaceForMedia(ctx, "m-1", "theintrodb", []model.MediaSegment{provider}); err != nil {
t.Fatal(err)
}
// 人工修正给出完全相同的区间:唯一索引含 source,两个来源必须能共存。
manual := span
manual.Source = "manual"
if err := repos.MediaSegment.ReplaceForMedia(ctx, "m-1", "manual", []model.MediaSegment{manual}); err != nil {
t.Fatalf("same range from another source: %v", err)
}
got, err := repos.MediaSegment.ListByMedia(ctx, "m-1")
if err != nil {
t.Fatal(err)
}
if len(got) != 2 {
t.Fatalf("rows = %d, want 2 (one per source)", len(got))
}
}
func TestReplaceForMediaClearsRowsWhenLookupReturnsNothing(t *testing.T) {
repos := newSegmentTestRepos(t)
ctx := t.Context()
rows := []model.MediaSegment{
{MediaID: "m-1", Kind: model.SegmentKindIntro, StartMs: 1_000, EndMs: 2_000, Source: "theintrodb"},
}
if err := repos.MediaSegment.ReplaceForMedia(ctx, "m-1", "theintrodb", rows); err != nil {
t.Fatal(err)
}
// 提供方后来把这段数据删掉了,本地必须跟着清空,否则会一直跳一个不存在的片头。
if err := repos.MediaSegment.ReplaceForMedia(ctx, "m-1", "theintrodb", nil); err != nil {
t.Fatal(err)
}
got, err := repos.MediaSegment.ListByMedia(ctx, "m-1")
if err != nil {
t.Fatal(err)
}
if len(got) != 0 {
t.Fatalf("rows = %d, want 0 after an empty refresh", len(got))
}
}
func TestUpsertFetchKeepsOneRowPerMediaAndSource(t *testing.T) {
repos := newSegmentTestRepos(t)
ctx := t.Context()
now := time.Now()
if err := repos.MediaSegment.UpsertFetch(ctx, &model.MediaSegmentFetch{
MediaID: "m-1", Source: "theintrodb", FetchedAt: now, Found: false,
}); err != nil {
t.Fatalf("first upsert: %v", err)
}
got, err := repos.MediaSegment.GetFetch(ctx, "m-1", "theintrodb")
if err != nil {
t.Fatal(err)
}
if got == nil || got.Found {
t.Fatalf("first lookup should be recorded as a miss, got %#v", got)
}
later := now.Add(time.Hour)
if err := repos.MediaSegment.UpsertFetch(ctx, &model.MediaSegmentFetch{
MediaID: "m-1", Source: "theintrodb", FetchedAt: later, Found: true,
}); err != nil {
t.Fatalf("second upsert: %v", err)
}
var count int64
if err := repos.DB.Model(&model.MediaSegmentFetch{}).
Where("media_id = ? AND source = ?", "m-1", "theintrodb").Count(&count).Error; err != nil {
t.Fatal(err)
}
if count != 1 {
t.Fatalf("fetch ledger rows = %d, want 1", count)
}
got, err = repos.MediaSegment.GetFetch(ctx, "m-1", "theintrodb")
if err != nil {
t.Fatal(err)
}
if got == nil || !got.Found {
t.Fatalf("ledger should be updated in place, got %#v", got)
}
}
+4
View File
@@ -15,6 +15,8 @@ type Container struct {
Media *MediaRepository
Series *SeriesRepository
History *HistoryRepository
MediaSegment *MediaSegmentRepository
MediaProbe *MediaProbeRepository
Favorite *FavoriteRepository
Playlist *PlaylistRepository
Setting *SettingRepository
@@ -45,6 +47,8 @@ func New(db *gorm.DB) *Container {
Media: &MediaRepository{db: db},
Series: &SeriesRepository{db: db},
History: &HistoryRepository{db: db},
MediaSegment: &MediaSegmentRepository{db: db},
MediaProbe: &MediaProbeRepository{db: db},
Favorite: &FavoriteRepository{db: db},
Playlist: &PlaylistRepository{db: db},
Setting: &SettingRepository{db: db},
+305 -67
View File
@@ -4,7 +4,7 @@
package service
import (
"errors"
"encoding/hex"
"os"
"path/filepath"
"sort"
@@ -55,18 +55,287 @@ type PruneImageCacheResult struct {
RemainingBytes int64
}
// imageCacheFileEntry 是池内一个可被淘汰的缓存文件。
type imageCacheFileEntry struct {
path string
pool int
size int64
modTime time.Time
}
// PruneImageCache scans imagesDir for cached image files. If the total disk usage
// exceeds maxSizeBytes, it removes files starting from the oldest (by ModTime)
// until disk usage falls to or below targetSizeBytes (80% of maxSizeBytes).
// ImageCacheScope 是池内的一处文件范围。Recursive=false 时只处理该目录下的
// 直属文件(历史版本的图片缓存是平铺在 images/ 下的,升级后仍要能清理掉)。
type ImageCacheScope struct {
Root string
Recursive bool
// DropUnknownResizeVariants 只用于派生缩略图目录:直接删除文件名不符合当前
// 命名(<源图键>.<宽>x<高>q<质量>.img)的历史缩放缓存。它们在新的查找路径下
// 永远不会被命中,留着只会占用总量配额、把有用缓存挤出去。
DropUnknownResizeVariants bool
}
// ImageCachePool 描述一个图片缓存池:范围 + 自身配额 + 保留时长。
//
// In-flight temporary files (*.tmp) are skipped to avoid corrupting concurrent writes.
// Empty subdirectories left behind are best-effort removed.
// 分池的意义在于两类缓存的“可再生成本”完全不同:原图只是生成缩略图的原料,
// 丢了可以重新回源;派生缩略图是客户端热路径真正读取的成品,重新生成代价高。
// 因此原图配小配额、短保留,总量超限时也优先淘汰原图。
type ImageCachePool struct {
Name string
Scopes []ImageCacheScope
MaxBytes int64 // 0 = 不单独限制
MaxAge time.Duration // 0 = 不按时间淘汰
}
// imageFailMarkerMaxAge 是失败标记文件的保留时长:标记只用于观测/重试,
// 过期即视为噪音清掉(不会因为标记残留而阻止重新抓取)。
const imageFailMarkerMaxAge = 24 * time.Hour
// tempImageCacheFile 报告文件名是否是下载/缩放过程中的临时文件。它们正在被
// 并发写入,清理时必须跳过。
func tempImageCacheFile(name string) bool {
if strings.HasSuffix(name, ".tmp") {
return true
}
return strings.HasPrefix(name, "img-") && strings.Contains(name, ".tmp")
}
// sha256HexLength 是十六进制 sha256 摘要的长度。
const sha256HexLength = 64
// isCurrentResizeVariantName 报告文件名是否符合当前的缩放缓存命名
// (<源图键>.<宽>x<高>q<质量>.img)。
func isCurrentResizeVariantName(name string) bool {
if !strings.HasSuffix(name, ".img") {
return false
}
spec := strings.TrimSuffix(name, ".img")
key, _, found := strings.Cut(spec, ".")
if !found || len(key) != sha256HexLength {
return false
}
if _, err := hex.DecodeString(key); err != nil {
return false
}
_, _, ok := parseResizeVariantSuffix(name, key)
return ok
}
// collectImageCachePoolFiles 收集池内可淘汰的文件(跳过并发写入中的临时文件)。
// 失败标记单独返回,它们不计入容量,只按年龄清理。
func collectImageCachePoolFiles(pool ImageCachePool, poolIndex int, entries *[]imageCacheFileEntry, failMarkers *[]imageCacheFileEntry) {
visit := func(path string, info os.FileInfo, scope ImageCacheScope) {
if info.IsDir() {
return
}
name := info.Name()
if tempImageCacheFile(name) {
return
}
if scope.DropUnknownResizeVariants && strings.HasSuffix(name, ".img") && !isCurrentResizeVariantName(name) {
_ = os.Remove(path) // 旧版命名,永远不会命中,直接清掉
return
}
entry := imageCacheFileEntry{path: path, pool: poolIndex, size: info.Size(), modTime: info.ModTime()}
if strings.HasSuffix(name, ".fail") {
*failMarkers = append(*failMarkers, entry)
return
}
*entries = append(*entries, entry)
}
for _, scope := range pool.Scopes {
if strings.TrimSpace(scope.Root) == "" {
continue
}
if !scope.Recursive {
dir, err := os.Open(scope.Root) // #nosec G304 -- cache root from config.
if err != nil {
continue
}
names, err := dir.Readdir(-1)
_ = dir.Close()
if err != nil {
continue
}
for _, info := range names {
visit(filepath.Join(scope.Root, info.Name()), info, scope)
}
continue
}
_ = filepath.Walk(scope.Root, func(path string, info os.FileInfo, err error) error {
if err != nil || info == nil {
return nil // best-effort: one unreadable dir must not abort cleanup
}
visit(path, info, scope)
return nil
})
}
}
// removeImageCacheEntry 删除一个缓存文件,并顺带清掉它的失败标记。
func removeImageCacheEntry(entry imageCacheFileEntry, result *PruneImageCacheResult) {
if err := os.Remove(entry.path); err != nil {
return
}
result.DeletedFiles++
result.FreedBytes += entry.size
result.RemainingBytes -= entry.size
_ = os.Remove(entry.path + ".fail")
}
// PruneImageCachePools 按池清理图片缓存:
// 1. 删除超过池 MaxAge 的文件(原图按保留时长淘汰);
// 2. 池自身超过 MaxBytes 时按 mtime 淘汰到 80%(留水位,避免连续写入即触发);
// 3. 全部池合计超过 totalBytes 时,仍按“先原图、后派生”的顺序淘汰最旧文件,
// 使总量上限始终是硬保证,同时让客户端热路径的缩略图活得更久。
//
// 传入的池顺序即总量超限时的淘汰优先级(排在前面的先被淘汰)。
func PruneImageCachePools(pools []ImageCachePool, totalBytes int64) (PruneImageCacheResult, error) {
var result PruneImageCacheResult
if len(pools) == 0 {
return result, nil
}
var entries []imageCacheFileEntry
var failMarkers []imageCacheFileEntry
for i, pool := range pools {
collectImageCachePoolFiles(pool, i, &entries, &failMarkers)
}
result.TotalFilesBefore = len(entries)
for _, entry := range entries {
result.TotalBytesBefore += entry.size
}
result.RemainingBytes = result.TotalBytesBefore
// 过期的失败标记直接清掉:它们不计容量,只用于观测与重试。
cutoffMarkers := time.Now().Add(-imageFailMarkerMaxAge)
for _, marker := range failMarkers {
if marker.modTime.Before(cutoffMarkers) {
_ = os.Remove(marker.path)
}
}
now := time.Now()
deleted := make(map[string]bool, len(entries))
deleteEntry := func(entry imageCacheFileEntry) {
if deleted[entry.path] {
return
}
deleted[entry.path] = true
removeImageCacheEntry(entry, &result)
}
// 1. 按池保留时长淘汰(原图池)。
for i := range pools {
if pools[i].MaxAge <= 0 {
continue
}
cutoff := now.Add(-pools[i].MaxAge)
for _, entry := range entries {
if entry.pool == i && entry.modTime.Before(cutoff) {
deleteEntry(entry)
}
}
}
// 2. 池自身配额。
for i := range pools {
maxBytes := pools[i].MaxBytes
if maxBytes <= 0 {
continue
}
var poolBytes int64
for _, entry := range entries {
if entry.pool == i && !deleted[entry.path] {
poolBytes += entry.size
}
}
if poolBytes <= maxBytes {
continue
}
target := maxBytes * 80 / 100
for _, entry := range oldestFirst(entries, i, deleted) {
if poolBytes <= target {
break
}
deleteEntry(entry)
poolBytes -= entry.size
}
}
// 3. 总量硬上限:跨池按淘汰优先级(池顺序)再按 mtime 淘汰。
if totalBytes > 0 && result.RemainingBytes > totalBytes {
target := totalBytes * 80 / 100
for _, entry := range evictionOrder(entries, deleted) {
if result.RemainingBytes <= target {
break
}
deleteEntry(entry)
}
}
removeEmptyImageCacheDirs(pools)
return result, nil
}
// oldestFirst 返回指定池内未被删除的文件,按修改时间从旧到新。
func oldestFirst(entries []imageCacheFileEntry, pool int, deleted map[string]bool) []imageCacheFileEntry {
out := make([]imageCacheFileEntry, 0, len(entries))
for _, entry := range entries {
if entry.pool == pool && !deleted[entry.path] {
out = append(out, entry)
}
}
sort.Slice(out, func(i, j int) bool { return out[i].modTime.Before(out[j].modTime) })
return out
}
// evictionOrder 返回总量超限时的淘汰顺序:先按池优先级(原图池在前),
// 池内再按修改时间从旧到新。
func evictionOrder(entries []imageCacheFileEntry, deleted map[string]bool) []imageCacheFileEntry {
out := make([]imageCacheFileEntry, 0, len(entries))
for _, entry := range entries {
if !deleted[entry.path] {
out = append(out, entry)
}
}
sort.SliceStable(out, func(i, j int) bool {
if out[i].pool != out[j].pool {
return out[i].pool < out[j].pool
}
return out[i].modTime.Before(out[j].modTime)
})
return out
}
// removeEmptyImageCacheDirs 清理淘汰后留下的空子目录(不含池根目录本身)。
func removeEmptyImageCacheDirs(pools []ImageCachePool) {
seen := map[string]bool{}
for _, pool := range pools {
for _, scope := range pool.Scopes {
if !scope.Recursive || seen[scope.Root] {
continue
}
seen[scope.Root] = true
dirs := []string{}
_ = filepath.Walk(scope.Root, func(path string, info os.FileInfo, err error) error {
if err != nil || info == nil {
return nil
}
if info.IsDir() && path != scope.Root {
dirs = append(dirs, path)
}
return nil
})
for i := len(dirs) - 1; i >= 0; i-- {
_ = os.Remove(dirs[i])
}
}
}
}
// PruneImageCache 是单池版本的兼容入口:把整个图片目录当作一个池,超限时按
// mtime 淘汰到 80%。保留它是为了「立刻清理图片缓存」这类只关心总量的调用方。
func PruneImageCache(imagesDir string, maxSizeBytes int64) (PruneImageCacheResult, error) {
var result PruneImageCacheResult
if imagesDir == "" || maxSizeBytes <= 0 {
@@ -75,66 +344,35 @@ func PruneImageCache(imagesDir string, maxSizeBytes int64) (PruneImageCacheResul
if _, err := os.Stat(imagesDir); err != nil {
return result, nil
}
var (
dirs []string
entries []imageCacheFileEntry
)
_ = filepath.Walk(imagesDir, func(path string, info os.FileInfo, err error) error {
if err != nil {
return nil
}
if info.IsDir() {
if path != imagesDir {
dirs = append(dirs, path)
}
return nil
}
// Skip temporary files created during image download.
name := info.Name()
if strings.HasSuffix(name, ".tmp") || strings.HasPrefix(name, "img-") && strings.Contains(name, ".tmp") {
return nil
}
size := info.Size()
result.TotalFilesBefore++
result.TotalBytesBefore += size
entries = append(entries, imageCacheFileEntry{
path: path,
size: size,
modTime: info.ModTime(),
})
return nil
})
result.RemainingBytes = result.TotalBytesBefore
if result.TotalBytesBefore <= maxSizeBytes {
return result, nil
pool := ImageCachePool{
Name: "images",
Scopes: []ImageCacheScope{{Root: imagesDir, Recursive: true}},
MaxBytes: maxSizeBytes,
}
// High/Low watermark: prune down to 80% of max size to leave headroom
// and prevent disk thrashing on consecutive writes.
targetSizeBytes := maxSizeBytes * 80 / 100
sort.Slice(entries, func(i, j int) bool {
return entries[i].modTime.Before(entries[j].modTime)
})
for _, entry := range entries {
if result.RemainingBytes <= targetSizeBytes {
break
}
if err := os.Remove(entry.path); err == nil || errors.Is(err, os.ErrNotExist) {
result.DeletedFiles++
result.FreedBytes += entry.size
result.RemainingBytes -= entry.size
}
}
// Clean up emptied subdirectories from deepest to shallowest.
for i := len(dirs) - 1; i >= 0; i-- {
_ = os.Remove(dirs[i])
}
return result, nil
return PruneImageCachePools([]ImageCachePool{pool}, maxSizeBytes)
}
// ImageCachePools 按配置组装图片缓存的两个清理池。
//
// 第一个池是原图:历史版本平铺在 images/ 下的旧缓存也归入此池,升级后会被
// 逐步淘汰;第二个池是派生成品(本地缩放结果 + 挂载 Emby 按尺寸返回的成品)。
// 池顺序即总量超限时的淘汰优先级。
func ImageCachePools(imagesDir string, originalsMaxBytes int64, originalsMaxAge time.Duration) []ImageCachePool {
originals := ImageCachePool{
Name: "originals",
MaxBytes: originalsMaxBytes,
MaxAge: originalsMaxAge,
Scopes: []ImageCacheScope{
{Root: imagesDir, Recursive: false}, // 旧版平铺布局
{Root: filepath.Join(imagesDir, imageOriginalCacheSubdir), Recursive: true},
},
}
derived := ImageCachePool{
Name: "derived",
Scopes: []ImageCacheScope{
{Root: filepath.Join(imagesDir, imageResizeCacheSubdir), Recursive: true, DropUnknownResizeVariants: true},
{Root: filepath.Join(imagesDir, imageRenditionCacheSubdir), Recursive: true},
},
}
return []ImageCachePool{originals, derived}
}
@@ -0,0 +1,223 @@
package service
import (
"fmt"
"os"
"path/filepath"
"strings"
"testing"
"time"
)
// writePoolFile ?????????????????????????
func writePoolFile(t *testing.T, path string, size int, modTime time.Time) {
t.Helper()
if err := os.MkdirAll(filepath.Dir(path), 0o750); err != nil {
t.Fatalf("mkdir %s: %v", filepath.Dir(path), err)
}
if err := os.WriteFile(path, make([]byte, size), 0o600); err != nil {
t.Fatalf("write %s: %v", path, err)
}
if !modTime.IsZero() {
if err := os.Chtimes(path, modTime, modTime); err != nil {
t.Fatalf("chtimes %s: %v", path, err)
}
}
}
func mustNotExist(t *testing.T, path string) {
t.Helper()
if _, err := os.Stat(path); !os.IsNotExist(err) {
t.Fatalf("expected %s to be deleted, got err=%v", path, err)
}
}
func mustExist(t *testing.T, path string) {
t.Helper()
if _, err := os.Stat(path); err != nil {
t.Fatalf("expected %s to survive, got err=%v", path, err)
}
}
// currentVariantPath ????????????????.<??x<??q<??>.img??
// ??????????????????????????
func currentVariantPath(dir, keyChar string, width, height, quality int) string {
key := strings.Repeat(keyChar, sha256HexLength)
return filepath.Join(dir, fmt.Sprintf("%s.%dx%dq%d.img", key, width, height, quality))
}
// TestPruneImageCachePoolsOriginalTTL ????????????????????
// ?? TTL ??????????????????????
func TestPruneImageCachePoolsOriginalTTL(t *testing.T) {
imagesDir := t.TempDir()
now := time.Now()
stale := filepath.Join(imagesDir, imageOriginalCacheSubdir, "stale-original")
fresh := filepath.Join(imagesDir, imageOriginalCacheSubdir, "fresh-original")
thumb := currentVariantPath(filepath.Join(imagesDir, imageResizeCacheSubdir), "b", 480, 600, 80)
writePoolFile(t, stale, 400, now.Add(-8*24*time.Hour))
writePoolFile(t, fresh, 400, now.Add(-1*time.Hour))
// ??????????TTL ????
writePoolFile(t, thumb, 400, now.Add(-8*24*time.Hour))
pools := ImageCachePools(imagesDir, 0, 7*24*time.Hour)
res, err := PruneImageCachePools(pools, 100*1024*1024)
if err != nil {
t.Fatalf("prune failed: %v", err)
}
if res.DeletedFiles != 1 {
t.Fatalf("deleted files = %d, want 1", res.DeletedFiles)
}
mustNotExist(t, stale)
mustExist(t, fresh)
mustExist(t, thumb)
}
// TestPruneImageCachePoolsEvictsOriginalsBeforeDerived ????????????
// ????????????????????
func TestPruneImageCachePoolsEvictsOriginalsBeforeDerived(t *testing.T) {
imagesDir := t.TempDir()
now := time.Now()
original := filepath.Join(imagesDir, imageOriginalCacheSubdir, "original")
rendition := filepath.Join(imagesDir, imageRenditionCacheSubdir, "rendition")
thumb := currentVariantPath(filepath.Join(imagesDir, imageResizeCacheSubdir), "c", 480, 600, 80)
// ?????????????????
writePoolFile(t, original, 1024*1024, now.Add(-72*time.Hour))
writePoolFile(t, rendition, 1024*1024, now.Add(-2*time.Hour))
writePoolFile(t, thumb, 1024*1024, now.Add(-1*time.Hour))
pools := ImageCachePools(imagesDir, 0, 0)
// ?? 3MB????2.4MB -> ????? 1.92MB??
res, err := PruneImageCachePools(pools, 2*1024*1024+400*1024)
if err != nil {
t.Fatalf("prune failed: %v", err)
}
if res.DeletedFiles != 2 {
t.Fatalf("deleted files = %d, want 2 (original + oldest derived)", res.DeletedFiles)
}
mustNotExist(t, original)
mustNotExist(t, rendition)
mustExist(t, thumb)
if res.RemainingBytes != 1024*1024 {
t.Fatalf("remaining bytes = %d, want %d", res.RemainingBytes, 1024*1024)
}
}
// TestPruneImageCachePoolsOriginalQuotaKeepsDerived ????????????
// ??????????????
func TestPruneImageCachePoolsOriginalQuotaKeepsDerived(t *testing.T) {
imagesDir := t.TempDir()
now := time.Now()
oldOriginal := filepath.Join(imagesDir, imageOriginalCacheSubdir, "old")
newOriginal := filepath.Join(imagesDir, imageOriginalCacheSubdir, "new")
thumb := currentVariantPath(filepath.Join(imagesDir, imageResizeCacheSubdir), "c", 480, 600, 80)
writePoolFile(t, oldOriginal, 800, now.Add(-3*time.Hour))
writePoolFile(t, newOriginal, 800, now.Add(-1*time.Hour))
writePoolFile(t, thumb, 800, now.Add(-2*time.Hour))
// ???? 1000 ??????????1600 -> ????800????? 1 ????
pools := ImageCachePools(imagesDir, 1000, 0)
res, err := PruneImageCachePools(pools, 0)
if err != nil {
t.Fatalf("prune failed: %v", err)
}
if res.DeletedFiles != 1 {
t.Fatalf("deleted files = %d, want 1", res.DeletedFiles)
}
mustNotExist(t, oldOriginal)
mustExist(t, newOriginal)
mustExist(t, thumb)
}
// TestPruneImageCachePoolsCleansFailMarkers ????????????????
// ????????????????
func TestPruneImageCachePoolsCleansFailMarkers(t *testing.T) {
imagesDir := t.TempDir()
now := time.Now()
entry := filepath.Join(imagesDir, imageOriginalCacheSubdir, "entry")
entryMarker := entry + ".fail"
orphanMarker := filepath.Join(imagesDir, imageOriginalCacheSubdir, "orphan.fail")
freshMarker := filepath.Join(imagesDir, imageOriginalCacheSubdir, "fresh.fail")
writePoolFile(t, entry, 900, now.Add(-10*time.Hour))
writePoolFile(t, entryMarker, 35, now.Add(-10*time.Hour))
writePoolFile(t, orphanMarker, 35, now.Add(-48*time.Hour))
writePoolFile(t, freshMarker, 35, now.Add(-1*time.Minute))
// ???? 500????900 ?????????????????
pools := ImageCachePools(imagesDir, 500, 0)
res, err := PruneImageCachePools(pools, 0)
if err != nil {
t.Fatalf("prune failed: %v", err)
}
if res.DeletedFiles != 1 {
t.Fatalf("deleted files = %d, want 1", res.DeletedFiles)
}
mustNotExist(t, entry)
mustNotExist(t, entryMarker)
mustNotExist(t, orphanMarker)
mustExist(t, freshMarker)
}
// TestPruneImageCachePoolsSkipsTemporaryFiles ????????????????
// ?????????????????
func TestPruneImageCachePoolsSkipsTemporaryFiles(t *testing.T) {
imagesDir := t.TempDir()
tmp := filepath.Join(imagesDir, imageOriginalCacheSubdir, "img-1234.tmp")
writePoolFile(t, tmp, 4096, time.Now().Add(-48*time.Hour))
pools := ImageCachePools(imagesDir, 1, 0)
if _, err := PruneImageCachePools(pools, 1); err != nil {
t.Fatalf("prune failed: %v", err)
}
mustExist(t, tmp)
}
// TestPruneImageCachePoolsDropsLegacyResizeVariants ????????.img????
// ?????????????????????????????????????
func TestPruneImageCachePoolsDropsLegacyResizeVariants(t *testing.T) {
imagesDir := t.TempDir()
resized := filepath.Join(imagesDir, imageResizeCacheSubdir)
legacy := filepath.Join(resized, "4f2a1b"+strings.Repeat("0", 58)+".img")
current := filepath.Join(resized, strings.Repeat("a", 64)+".480x600q80.img")
other := filepath.Join(resized, "not-a-hash.480x600q80.img")
writePoolFile(t, legacy, 400, time.Now())
writePoolFile(t, current, 400, time.Now())
writePoolFile(t, other, 400, time.Now())
pools := ImageCachePools(imagesDir, 0, 0)
res, err := PruneImageCachePools(pools, 0)
if err != nil {
t.Fatalf("prune failed: %v", err)
}
mustNotExist(t, legacy)
mustNotExist(t, other)
mustExist(t, current)
if res.TotalFilesBefore != 1 {
t.Fatalf("counted files = %d, want only the current-format variant", res.TotalFilesBefore)
}
}
// TestPruneImageCachePoolsCountsLegacyFlatLayout ??????images/ ????
// ?????????????????
func TestPruneImageCachePoolsCountsLegacyFlatLayout(t *testing.T) {
imagesDir := t.TempDir()
legacy := filepath.Join(imagesDir, "legacy-flat-cache")
thumb := currentVariantPath(filepath.Join(imagesDir, imageResizeCacheSubdir), "c", 480, 600, 80)
writePoolFile(t, legacy, 900, time.Now().Add(-30*24*time.Hour))
writePoolFile(t, thumb, 900, time.Now().Add(-30*24*time.Hour))
pools := ImageCachePools(imagesDir, 0, 24*time.Hour)
res, err := PruneImageCachePools(pools, 0)
if err != nil {
t.Fatalf("prune failed: %v", err)
}
if res.DeletedFiles != 1 {
t.Fatalf("deleted files = %d, want 1", res.DeletedFiles)
}
mustNotExist(t, legacy)
mustExist(t, thumb)
}
+2 -2
View File
@@ -148,8 +148,8 @@ func TestSchedulerJobCleanImageCache(t *testing.T) {
scheduler := NewSchedulerService(zap.NewNop(), nil, nil, nil, nil, nil, cacheRoot)
// Set limit to 1MB; our file is 2MB -> should be pruned
scheduler.SetImagesMaxSizeMBProvider(func() int {
return 1
scheduler.SetImageCachePolicyProvider(func() ImageCachePolicy {
return ImageCachePolicy{TotalBytes: 1 * 1024 * 1024}
})
if err := scheduler.jobCleanImageCache(context.Background()); err != nil {
+21 -1
View File
@@ -58,12 +58,32 @@ type Cloud115PlaybackService struct {
repo *repository.Container
strm *StrmService
// transcoder 用于判断本地 HLS 档位此刻是否真的可用;未注入时按"不可用"处理,
// 避免向播放器推荐必然 500 的转码档位。
transcoder *TranscoderService
mu sync.Mutex
pushState map[string]cloud115PushAttempt
proxy *Cloud115HLSProxy
}
// SetTranscoder 注入转码服务,用于标注本地 HLS 档位的可用性。
func (s *Cloud115PlaybackService) SetTranscoder(transcoder *TranscoderService) *Cloud115PlaybackService {
if s != nil {
s.transcoder = transcoder
}
return s
}
// localTranscodeAvailable 报告本地 HLS 此刻是否可用。
func (s *Cloud115PlaybackService) localTranscodeAvailable() bool {
if s == nil || s.transcoder == nil {
return false
}
return s.transcoder.Available()
}
func NewCloud115PlaybackService(cfg *config.Config, log *zap.Logger, repo *repository.Container, strm *StrmService) *Cloud115PlaybackService {
svc := &Cloud115PlaybackService{
cfg: cfg,
@@ -101,7 +121,7 @@ func (s *Cloud115PlaybackService) PlaybackInfo(ctx context.Context, mediaID stri
}
provider := MediaPlaybackProvider(m)
localQualities := LocalQualityOptions(m)
localQualities := LocalQualityOptions(m, s.localTranscodeAvailable())
localDefault := DefaultLocalHLSQualityID(m)
info := &PlaybackInfo{
MediaID: m.ID,
+13 -3
View File
@@ -21,14 +21,24 @@ func (s *DeviceService) KickDevice(ctx context.Context, userID, deviceID string)
return fmt.Errorf("device not found")
}
if fp := strings.TrimSpace(d.Fingerprint); fp != "" {
return s.repo.UserDevice.SetKickedByFingerprint(ctx, userID, fp, true)
err = s.repo.UserDevice.SetKickedByFingerprint(ctx, userID, fp, true)
} else {
err = s.repo.UserDevice.SetKicked(ctx, d.ID, true)
}
return s.repo.UserDevice.SetKicked(ctx, d.ID, true)
if err != nil {
return err
}
s.notify(ctx, userID, fmt.Sprintf("🔌 设备已下线:<b>%s</b>\n该终端需要重新登录后才能继续使用。", deviceLabel(d.DeviceName, d.Client)))
return nil
}
// KickAllDevices marks all devices for a user as kicked.
func (s *DeviceService) KickAllDevices(ctx context.Context, userID string) error {
return s.repo.UserDevice.SetKickedByUser(ctx, userID, true)
if err := s.repo.UserDevice.SetKickedByUser(ctx, userID, true); err != nil {
return err
}
s.notify(ctx, userID, "🔌 你名下的全部设备已下线,需要重新登录后才能继续使用。")
return nil
}
// ListDevices returns the device sessions for a user.
+155
View File
@@ -0,0 +1,155 @@
package service
import (
"context"
"strings"
"testing"
"go.uber.org/zap"
"github.com/truewhile/MeBox/internal/model"
"github.com/truewhile/MeBox/internal/repository"
)
func newDeviceServiceForTest(t *testing.T) (*DeviceService, *repository.Container, string) {
t.Helper()
repos := repository.New(newServiceTestDB(t))
const userID = "user-1"
if err := repos.User.Create(context.Background(), &model.User{
Base: model.Base{ID: userID},
Username: "tester",
PasswordHash: "x",
Role: "user",
IsActive: true,
}); err != nil {
t.Fatal(err)
}
svc := NewDeviceService(zap.NewNop(), repos)
svc.SetSessionTracker(NewSessionTrackerService(zap.NewNop()))
return svc, repos, userID
}
// 新终端首次登录必须通知用户,否则「谁在用我的账号」永远无从察觉。
func TestRecordLoginNotifiesOnNewDevice(t *testing.T) {
svc, _, userID := newDeviceServiceForTest(t)
type call struct{ userID, text string }
var calls []call
svc.SetNotifier(func(_ context.Context, uid, text string) {
calls = append(calls, call{uid, text})
})
svc.RecordLogin(context.Background(), userID, "dev-1", "Phone", "Infuse", "1.2.3.4")
if len(calls) != 1 {
t.Fatalf("notifier calls = %d, want 1", len(calls))
}
if calls[0].userID != userID {
t.Fatalf("notifier user = %q, want %q", calls[0].userID, userID)
}
if !strings.Contains(calls[0].text, "新设备") {
t.Fatalf("notifier text = %q, want it to mention 新设备", calls[0].text)
}
}
// 已知终端重复登录不应刷屏:只在首次建档时通知。
func TestRecordLoginDoesNotNotifyOnKnownDevice(t *testing.T) {
svc, _, userID := newDeviceServiceForTest(t)
var count int
svc.SetNotifier(func(context.Context, string, string) { count++ })
svc.RecordLogin(context.Background(), userID, "dev-1", "Phone", "Infuse", "1.2.3.4")
svc.RecordLogin(context.Background(), userID, "dev-1", "Phone", "Infuse", "1.2.3.4")
if count != 1 {
t.Fatalf("notifier calls = %d, want exactly 1", count)
}
}
// 一键踢下线后必须告知用户,否则只会表现为「播放莫名失败」。
func TestKickDeviceNotifiesUser(t *testing.T) {
svc, _, userID := newDeviceServiceForTest(t)
svc.RecordLogin(context.Background(), userID, "dev-1", "Phone", "Infuse", "1.2.3.4")
var kickText string
svc.SetNotifier(func(_ context.Context, _, text string) { kickText = text })
if err := svc.KickAllDevices(context.Background(), userID); err != nil {
t.Fatal(err)
}
if kickText == "" {
t.Fatal("expected a notification after kicking devices")
}
if !strings.Contains(kickText, "已下线") && !strings.Contains(kickText, "踢") {
t.Fatalf("kick notification text = %q, want it to describe the kick", kickText)
}
}
// 未接线 notifier 时(例如测试环境或 Bot 未配置),所有路径必须保持可用。
func TestDeviceServiceWorksWithoutNotifier(t *testing.T) {
svc, _, userID := newDeviceServiceForTest(t)
svc.RecordLogin(context.Background(), userID, "dev-1", "Phone", "Infuse", "1.2.3.4")
if err := svc.KickAllDevices(context.Background(), userID); err != nil {
t.Fatal(err)
}
}
// 设备指纹警告除通知用户外,管理员也必须同步收到告警。
func TestFingerprintWarnNotifiesAdmin(t *testing.T) {
svc, repos, userID := newDeviceServiceForTest(t)
// 启用防共享策略
if err := repos.Setting.Set(context.Background(), SettingAntiShareEnabled, "true"); err != nil {
t.Fatal(err)
}
type call struct{ text string }
var adminCalls []call
svc.SetAdminNotifier(func(_ context.Context, text string) {
adminCalls = append(adminCalls, call{text})
})
svc.SetNotifier(func(context.Context, string, string) {}) // 用户通知静默接收
// 第一次登录注册设备
svc.RecordLogin(context.Background(), userID, "dev-1", "Phone-A", "Infuse", "1.2.3.4")
// 同设备 ID 换设备名 → 触发指纹变更警告
svc.RecordLogin(context.Background(), userID, "dev-1", "Phone-B", "Infuse", "1.2.3.4")
if len(adminCalls) == 0 {
t.Fatal("admin must be notified on fingerprint warn")
}
}
// 账号因设备策略被禁用时,管理员也必须收到告警。
func TestPolicyDisableNotifiesAdmin(t *testing.T) {
svc, repos, userID := newDeviceServiceForTest(t)
// 启用防共享策略,设置最大并发客户端为 1
for _, kv := range [][2]string{
{SettingAntiShareEnabled, "true"},
{SettingMaxLoggedClients, "1"},
{SettingClientActiveDays, "30"},
} {
if err := repos.Setting.Set(context.Background(), kv[0], kv[1]); err != nil {
t.Fatal(err)
}
}
var adminCalls []string
svc.SetAdminNotifier(func(_ context.Context, text string) {
adminCalls = append(adminCalls, text)
})
svc.SetNotifier(func(context.Context, string, string) {})
// 两台不同设备登录,超出上限 → 触发禁用
svc.RecordLogin(context.Background(), userID, "dev-1", "Phone", "Infuse", "1.2.3.4")
svc.RecordLogin(context.Background(), userID, "dev-2", "TV", "Emby", "1.2.3.5")
if len(adminCalls) == 0 {
t.Fatal("admin must be notified when account is disabled by policy")
}
if !strings.Contains(adminCalls[0], "禁用") {
t.Fatalf("admin notification = %q, want it to mention 禁用", adminCalls[0])
}
}
+26 -2
View File
@@ -5,6 +5,7 @@ import (
"crypto/sha256"
"encoding/hex"
"fmt"
"html"
"strings"
"time"
@@ -34,6 +35,10 @@ type DeviceService struct {
// notifyUser sends a Telegram message to the local user (resolved to their
// Telegram binding). Wired by the bot service; nil disables notifications.
notifyUser func(ctx context.Context, userID, text string)
// notifyAdmin sends a Telegram message to all admin accounts.
// Wired by the bot service; nil disables notifications.
notifyAdmin func(ctx context.Context, text string)
}
// NewDeviceService constructs a DeviceService.
@@ -46,6 +51,11 @@ func (s *DeviceService) SetNotifier(fn func(ctx context.Context, userID, text st
s.notifyUser = fn
}
// SetAdminNotifier wires the admin-broadcast Telegram notification callback.
func (s *DeviceService) SetAdminNotifier(fn func(ctx context.Context, text string)) {
s.notifyAdmin = fn
}
func (s *DeviceService) SetSessionTracker(tracker *SessionTrackerService) {
s.sessions = tracker
}
@@ -102,6 +112,8 @@ func (s *DeviceService) RecordLogin(ctx context.Context, userID, deviceID, devic
FirstSeenAt: now,
LastSeenAt: now,
})
// 新终端首次登录才通知:已知设备重复登录不刷屏。
s.notify(ctx, userID, fmt.Sprintf("🔔 新设备登录:<b>%s</b>\n如果这不是你本人,请到「个人资料 → 我的设备」踢下线并修改密码。", deviceLabel(deviceName, client)))
} else {
if existing.Fingerprint != "" && existing.Fingerprint != fp {
mismatch = true
@@ -236,7 +248,10 @@ func (s *DeviceService) registerFingerprintWarning(ctx context.Context, userID,
"last_share_warn_at": &now,
})
left := cfg.WarnThreshold + 1 - warnings
s.notify(ctx, userID, fmt.Sprintf("⚠️ 账号 <b>%s</b> 触发设备指纹警告:%s\n这是第 <b>%d</b> 次警告,再异常 <b>%d</b> 次将禁用账号。请使用 Bot 的「我的设备」踢下线异常设备。", u.Username, reason, warnings, left))
warnText := fmt.Sprintf("⚠️ 账号 <b>%s</b> 触发设备指纹警告:%s\n这是第 <b>%d</b> 次警告,再异常 <b>%d</b> 次将禁用账号。请到「个人资料 → 我的设备」踢下线异常设备。",
html.EscapeString(u.Username), html.EscapeString(reason), warnings, left)
s.notify(ctx, userID, warnText)
s.notifyAdminMsg(ctx, warnText)
s.log.Info("anti-share: warning issued", zap.String("user", u.Username), zap.Int("warnings", warnings), zap.String("reason", reason))
}
@@ -255,7 +270,10 @@ func (s *DeviceService) disableForPolicy(ctx context.Context, userID, reason str
"last_share_warn_at": &now,
})
_ = s.repo.UserDevice.SetKickedByUser(ctx, userID, true)
s.notify(ctx, userID, fmt.Sprintf("⛔️ 账号 <b>%s</b> 因触发设备规则已被禁用:%s\n请联系管理员解除禁用,或通过「我的设备」踢下线多余设备后再申请恢复。", u.Username, reason))
disableText := fmt.Sprintf("⛔️ 账号 <b>%s</b> 因触发设备规则已被禁用:%s\n请联系管理员解除禁用,或通过「个人资料 → 我的设备」踢下线多余设备后再申请恢复。",
html.EscapeString(u.Username), html.EscapeString(reason))
s.notify(ctx, userID, disableText)
s.notifyAdminMsg(ctx, disableText)
s.log.Warn("device policy: disabled account", zap.String("user", u.Username), zap.String("reason", reason))
}
@@ -276,6 +294,12 @@ func (s *DeviceService) notify(ctx context.Context, userID, text string) {
}
}
func (s *DeviceService) notifyAdminMsg(ctx context.Context, text string) {
if s.notifyAdmin != nil {
s.notifyAdmin(ctx, text)
}
}
func deviceLabel(name, client string) string {
name = strings.TrimSpace(name)
client = strings.TrimSpace(client)
+9 -1
View File
@@ -147,10 +147,18 @@ func (e *EmbyService) ImageInfos(ctx context.Context, id string) []map[string]an
continue
}
seen[raw] = true
// ImageTag 让客户端判断自己缓存的图片是否还有效:远程条目的真实
// ImageTags 会随远端换图变化,拿不到时才退化为条目 ID(恒定值)。
tag := id
if e.remote != nil {
if remoteTag := e.remote.RemoteImageTagOfEncodedID(ctx, id, imageType); remoteTag != "" {
tag = remoteTag
}
}
out = append(out, map[string]any{
"ImageType": imageType,
"ImageIndex": 0,
"ImageTag": id,
"ImageTag": tag,
})
}
return out
+28
View File
@@ -76,6 +76,10 @@ type EmbyService struct {
adult *AdultProvider
personImageMu sync.RWMutex
personImages map[string]string
// discovery 提供 NextUp / Similar / Genres 的候选集。它只选候选,
// DTO 形状仍由本服务统一产出,避免同一部剧在不同接口上长得不一样。
discovery *MediaDiscoveryService
}
// NewEmbyService is the constructor.
@@ -91,6 +95,26 @@ func (e *EmbyService) SetEmbyRemote(remote *EmbyRemoteService) *EmbyService {
return e
}
// SetDiscovery 注入发现类查询服务(NextUp / Similar / Genres)。
func (e *EmbyService) SetDiscovery(discovery *MediaDiscoveryService) *EmbyService {
if e != nil {
e.discovery = discovery
}
return e
}
// discoveryService 返回发现服务;未注入时按需构造,保证 Emby 接口在任何
// 组装顺序下都不会因为缺少注入而返回空结果。
func (e *EmbyService) discoveryService() *MediaDiscoveryService {
if e == nil {
return nil
}
if e.discovery == nil {
e.discovery = NewMediaDiscoveryService(e.log, e.repo)
}
return e.discovery
}
// SetTMDbProvider wires the TMDb client used for detail-time cast/crew lookup.
func (e *EmbyService) SetTMDbProvider(tmdb *TMDbProvider) *EmbyService {
if e != nil {
@@ -141,6 +165,10 @@ type ItemsParams struct {
SortOrder string
Limit int
StartIndex int
// SeasonIndex 对应客户端的 Season / SeasonIndex 查询参数(季序号,0 为特别篇)。
// nil 表示不按季过滤;非 nil 时只返回该季的剧集。客户端普遍用季序号而不是
// 虚拟季 ID 请求剧集,缺了它 /Shows/{id}/Episodes?Season=N 会返回整部剧。
SeasonIndex *int
}
const (
+132
View File
@@ -1,6 +1,8 @@
package service
import (
"context"
"strings"
"testing"
"time"
@@ -65,3 +67,133 @@ func TestEmbyLatestItemsOrderByReleaseDate(t *testing.T) {
t.Fatalf("latest item should expose PremiereDate for Emby clients: %#v", items[0])
}
}
// SimilarItems with a real series_id (not a media table row ID) must return
// results instead of an empty list. Before bug-2 fix, Media.FindByID returned
// nil for any ID that wasn't a primary-key match in the media table (including
// series_id values and virtual msgo-series-* IDs), so SimilarItems always
// returned empty for series detail pages.
func TestEmbyServiceSimilarItemsSeriesID(t *testing.T) {
svc := newTestEmbyService(t)
svc.SetDiscovery(NewMediaDiscoveryService(zap.NewNop(), svc.repo))
lib := model.Library{Name: "TV", Path: "/media/tv", Type: "tv", Enabled: true}
if err := svc.repo.Library.Create(context.Background(), &lib); err != nil {
t.Fatal(err)
}
// Two series with the same genre so they score > 0 for similarity.
ep1 := model.Media{
LibraryID: lib.ID,
SeriesID: "real-series-1",
Title: "剧一",
Genres: "Action",
SeasonNum: 1,
EpisodeNum: 1,
Path: "/media/tv/s1e1.mkv",
}
ep2 := model.Media{
LibraryID: lib.ID,
SeriesID: "real-series-2",
Title: "剧二",
Genres: "Action",
SeasonNum: 1,
EpisodeNum: 1,
Path: "/media/tv/s2e1.mkv",
}
for _, m := range []*model.Media{&ep1, &ep2} {
if err := svc.repo.DB.Create(m).Error; err != nil {
t.Fatal(err)
}
}
// "real-series-1" is the series_id stored in the media row but is NOT a
// primary key in the media table, so Media.FindByID("real-series-1") returns
// nil. SimilarItems must fall back to findSeriesGroup and still return
// results.
result, err := svc.SimilarItems(context.Background(), "real-series-1", "", 12)
if err != nil {
t.Fatalf("SimilarItems with series_id: %v", err)
}
similar, _ := result["Items"].([]map[string]any)
if similar == nil {
t.Fatal("SimilarItems returned nil items for a series_id that resolves via findSeriesGroup")
}
// Should contain 剧二 (the only other episodic content with the same genre).
found := false
for _, item := range similar {
if name, _ := item["Name"].(string); strings.Contains(name, "剧二") || strings.Contains(name, "第 1 集") {
found = true
break
}
}
if !found && len(similar) == 0 {
t.Fatalf("SimilarItems returned no results; want at least 剧二 for series real-series-1")
}
}
// SimilarItems with a virtual series ID (msgo-series-*) must also work.
// Virtual IDs are generated for episodes that have no series_id set.
func TestEmbyServiceSimilarItemsVirtualSeriesID(t *testing.T) {
svc := newTestEmbyService(t)
svc.SetDiscovery(NewMediaDiscoveryService(zap.NewNop(), svc.repo))
lib := model.Library{Name: "TV2", Path: "/media/tv2", Type: "tv", Enabled: true}
if err := svc.repo.Library.Create(context.Background(), &lib); err != nil {
t.Fatal(err)
}
// Episodes WITHOUT SeriesID → series group gets a virtual msgo-series-* ID.
ep1 := model.Media{
LibraryID: lib.ID,
Title: "虚拟剧一",
Genres: "Drama",
SeasonNum: 1,
EpisodeNum: 1,
Path: "/media/tv2/virtual1/S01E01.mkv",
}
ep2 := model.Media{
LibraryID: lib.ID,
Title: "虚拟剧二",
Genres: "Drama",
SeasonNum: 1,
EpisodeNum: 1,
Path: "/media/tv2/virtual2/S01E01.mkv",
}
for _, m := range []*model.Media{&ep1, &ep2} {
if err := svc.repo.DB.Create(m).Error; err != nil {
t.Fatal(err)
}
}
// Fetch series items to get the virtual ID for ep1's series.
seriesItems, err := svc.Items(context.Background(), ItemsParams{
IncludeItemTypes: []string{"Series"},
Recursive: true,
})
if err != nil {
t.Fatal(err)
}
items, _ := seriesItems["Items"].([]map[string]any)
var virtualID string
for _, item := range items {
id, _ := item["Id"].(string)
name, _ := item["Name"].(string)
if strings.Contains(name, "虚拟剧一") && strings.HasPrefix(id, embyVirtualSeriesPrefix) {
virtualID = id
break
}
}
if virtualID == "" {
t.Skip("virtual series ID not generated for episodes without series_id in this build")
}
result, err := svc.SimilarItems(context.Background(), virtualID, "", 12)
if err != nil {
t.Fatalf("SimilarItems with virtual series ID: %v", err)
}
similar, _ := result["Items"].([]map[string]any)
if similar == nil {
t.Fatalf("SimilarItems returned nil items for virtual series ID %q", virtualID)
}
}
+342
View File
@@ -0,0 +1,342 @@
package service
import (
"context"
"crypto/sha1"
"encoding/hex"
"strings"
"time"
"github.com/truewhile/MeBox/internal/model"
)
// Emby 发现类接口:NextUp / Similar / Genres。
//
// 候选集的选取交给 MediaDiscoveryService(纯查询、无 DTO 概念),本文件只做
// 「候选 → Emby DTO」的映射,复用 itemPayload 以保证与 /Items 的形状一致。
const (
embyNextUpDefaultLimit = 20
embySimilarDefaultLimit = 12
embyNextUpMaxLimit = 100
embySimilarMaxLimit = 50
)
// NextUp 返回「每部在看的剧的下一集」,即 Emby 客户端首页「接下来播放」的数据源。
// seriesID 非空时只返回该剧的下一集(剧集详情页「继续播放」);空则返回全站列表。
func (e *EmbyService) NextUp(ctx context.Context, userID, seriesID string, limit int) (map[string]any, error) {
if limit <= 0 {
limit = embyNextUpDefaultLimit
}
if limit > embyNextUpMaxLimit {
limit = embyNextUpMaxLimit
}
if strings.TrimSpace(userID) == "" {
return emptyItemsEnvelope(0), nil
}
seriesID = strings.TrimSpace(seriesID)
discovery := e.discoveryService()
if discovery == nil {
return emptyItemsEnvelope(0), nil
}
if seriesID != "" {
return e.nextUpForSeries(ctx, userID, seriesID, limit)
}
rows, err := discovery.NextUpCandidates(ctx, userID, limit, e.mediaVisibility(ctx, userID))
if err != nil {
return nil, err
}
// Bug 3 fix: use payloadsForMedia which attaches the request-scoped payload
// cache (withPayloadCache + prefetchPayloadCache) to avoid N+1 DB queries.
items, err := e.payloadsForMedia(ctx, rows, userID)
if err != nil {
return nil, err
}
return map[string]any{
"Items": items,
"TotalRecordCount": int64(len(items)),
}, nil
}
// nextUpForSeries 只解析指定剧的下一集。远程挂载剧集按本机播放历史 + 远程
// 分集列表计算,避免把其它本地剧的 NextUp 塞进详情页继续播放按钮。
func (e *EmbyService) nextUpForSeries(ctx context.Context, userID, seriesID string, limit int) (map[string]any, error) {
if IsEmbyRemoteID(seriesID) {
return e.nextUpForRemoteSeries(ctx, userID, seriesID, limit)
}
discovery := e.discoveryService()
if discovery == nil {
return emptyItemsEnvelope(0), nil
}
// 多取候选再按 SeriesId 精确过滤,避免「全站 TopN」把目标剧挤掉。
scanLimit := embyNextUpMaxLimit
if limit > scanLimit {
scanLimit = limit
}
rows, err := discovery.NextUpCandidates(ctx, userID, scanLimit, e.mediaVisibility(ctx, userID))
if err != nil {
return nil, err
}
items, err := e.payloadsForMedia(ctx, rows, userID)
if err != nil {
return nil, err
}
filtered := make([]map[string]any, 0, 1)
for _, item := range items {
itemSeries, _ := item["SeriesId"].(string)
if itemSeries == seriesID {
filtered = append(filtered, item)
if len(filtered) >= limit {
break
}
}
}
return map[string]any{
"Items": filtered,
"TotalRecordCount": int64(len(filtered)),
}, nil
}
// nextUpForRemoteSeries 用 MeBox 本地播放历史在远程剧的分集里找「下一集」。
// 不透传远程账号的 NextUp,避免多用户共用挂载账号时串进度。
func (e *EmbyService) nextUpForRemoteSeries(ctx context.Context, userID, seriesID string, limit int) (map[string]any, error) {
if e == nil || e.remote == nil || strings.TrimSpace(userID) == "" {
return emptyItemsEnvelope(0), nil
}
if limit <= 0 {
limit = 1
}
mountID, remoteSeriesID, ok := DecodeEmbyRemoteID(seriesID)
if !ok {
return emptyItemsEnvelope(0), nil
}
mount, acct, err := e.remote.ResolveMount(ctx, mountID)
if err != nil || mount == nil || acct == nil {
return emptyItemsEnvelope(0), nil
}
if !EmbyMountLibraryAllowed(e.mediaVisibility(ctx, userID), mount) {
return emptyItemsEnvelope(0), nil
}
prefix := EmbyRemoteIDPrefix + mountID + "~"
var hist []model.PlaybackHistory
if err := e.repo.DB.WithContext(ctx).
Where("user_id = ? AND position_ms > 0 AND media_id LIKE ?", userID, prefix+"%").
Order("watched_at desc").
Limit(nextUpHistoryScanLimit).
Find(&hist).Error; err != nil {
return nil, err
}
if len(hist) == 0 {
return emptyItemsEnvelope(0), nil
}
episodes, err := e.remote.RemoteEpisodes(ctx, mount, acct, remoteSeriesID)
if err != nil || len(episodes) == 0 {
return emptyItemsEnvelope(0), nil
}
epByID := make(map[string]*model.Media, len(episodes))
for i := range episodes {
epByID[episodes[i].ID] = &episodes[i]
}
var current *model.Media
currentCompleted := false
for i := range hist {
if m := epByID[hist[i].MediaID]; m != nil {
current = m
currentCompleted = hist[i].Completed
break
}
}
if current == nil {
return emptyItemsEnvelope(0), nil
}
completed := map[string]bool{}
epIDs := make([]string, 0, len(episodes))
for i := range episodes {
epIDs = append(epIDs, episodes[i].ID)
}
var done []model.PlaybackHistory
if err := e.repo.DB.WithContext(ctx).
Where("user_id = ? AND completed = ? AND media_id IN ?", userID, true, epIDs).
Find(&done).Error; err == nil {
for _, h := range done {
completed[h.MediaID] = true
}
}
next, ok := pickNextEpisode(episodes, current, currentCompleted, completed)
if !ok {
return emptyItemsEnvelope(0), nil
}
_, remoteEpID, ok := DecodeEmbyRemoteID(next.ID)
if !ok {
return emptyItemsEnvelope(0), nil
}
item, err := e.remote.RemoteItem(ctx, mount, acct, remoteEpID)
if err != nil || item == nil {
return emptyItemsEnvelope(0), nil
}
if err := e.mergeRemoteUserData(ctx, userID, item); err != nil {
return nil, err
}
items := []map[string]any{item}
if limit < len(items) {
items = items[:limit]
}
return map[string]any{
"Items": items,
"TotalRecordCount": int64(len(items)),
}, nil
}
// SimilarItems 返回与指定条目相似的本地媒体。
//
// 找不到条目(或该条目对当前用户不可见)时返回空列表而不是错误:客户端会在
// 详情页无条件请求它,404/500 会让客户端把条目判定为不完整。
func (e *EmbyService) SimilarItems(ctx context.Context, mediaID, userID string, limit int) (map[string]any, error) {
if limit <= 0 {
limit = embySimilarDefaultLimit
}
if limit > embySimilarMaxLimit {
limit = embySimilarMaxLimit
}
discovery := e.discoveryService()
if discovery == nil || strings.TrimSpace(mediaID) == "" {
return emptyItemsEnvelope(0), nil
}
// 详情页每次打开都会请求相似推荐,而重建要走「取候选池 + 内存打分」
// (实测冷 340ms / 热 70ms)。推荐列表短暂陈旧无害,用短 TTL 缓存,
// 新建库或换用户都会因为键名不同而自然隔离。
cacheKey := e.embySimilarCacheKey(mediaID, userID, limit)
if e.cache != nil {
var cached map[string]any
if e.cache.GetJSON(ctx, cacheKey, &cached) && cached != nil {
if _, ok := cached["Items"]; ok {
return cached, nil
}
}
}
// Bug 2 fix: resolve virtual series IDs (msgo-series-*) and real series
// table IDs to a representative episode so SimilarCandidates (which calls
// Media.FindByID) can seed similarity from concrete media metadata.
resolvedID := mediaID
if strings.HasPrefix(mediaID, embyVirtualSeriesPrefix) {
series, ok, err := e.findSeriesGroup(ctx, mediaID, userID)
if err != nil {
return nil, err
}
if !ok || len(series.Episodes) == 0 {
return emptyItemsEnvelope(0), nil
}
resolvedID = series.Episodes[0].ID
} else if e.repo != nil && e.repo.Media != nil {
// For non-virtual IDs that are series-level (not in media table), also
// resolve via findSeriesGroup so the seed row can be found.
m, err := e.repo.Media.FindByID(ctx, mediaID)
if err != nil {
return nil, err
}
if m == nil {
series, ok, err := e.findSeriesGroup(ctx, mediaID, userID)
if err != nil {
return nil, err
}
if !ok || len(series.Episodes) == 0 {
return emptyItemsEnvelope(0), nil
}
resolvedID = series.Episodes[0].ID
}
}
rows, err := discovery.SimilarCandidates(ctx, resolvedID, limit, e.mediaVisibility(ctx, userID))
if err != nil {
return nil, err
}
// Bug 3 fix: use payloadsForMedia which attaches the request-scoped payload
// cache (withPayloadCache + prefetchPayloadCache) to avoid N+1 DB queries.
items, err := e.payloadsForMedia(ctx, rows, userID)
if err != nil {
return nil, err
}
out := map[string]any{
"Items": items,
"TotalRecordCount": int64(len(items)),
}
if e.cache != nil {
e.cache.SetJSON(ctx, cacheKey, out, embySimilarCacheTTL)
}
return out, nil
}
// embySimilarCacheTTL 是「相似推荐」结果的缓存时长。列表只是推荐,短暂陈旧
// 无害;TTL 取短一些,让新入库的内容尽快出现。
const embySimilarCacheTTL = 2 * time.Minute
// Genres 返回类型清单。parentID 非空时(客户端按媒体库浏览类型)只统计该库。
func (e *EmbyService) Genres(ctx context.Context, userID, parentID string) (map[string]any, error) {
discovery := e.discoveryService()
if discovery == nil {
return emptyItemsEnvelope(0), nil
}
libraryID := ""
if trimmed := strings.TrimSpace(parentID); trimmed != "" {
// 只有本地的真实库 ID 才能用于收窄;虚拟视图 ID(Emby 客户端自己的
// 视图标识)收窄后会得到空结果,因此识别不出来时按全库统计。
if e.libraryExists(ctx, trimmed) {
libraryID = trimmed
}
}
genres, err := discovery.AggregateGenres(ctx, e.mediaVisibility(ctx, userID), libraryID)
if err != nil {
return nil, err
}
items := make([]map[string]any, 0, len(genres))
for _, genre := range genres {
items = append(items, map[string]any{
"Id": embyGenreID(genre.Name),
"Name": genre.Name,
"ItemCount": genre.Count,
"Type": "Genre",
"ServerId": embyServerID,
"IsFolder": false,
"CanDelete": false,
"CanDownload": false,
"ImageTags": map[string]any{},
"BackdropImageTags": []any{},
})
}
return map[string]any{
"Items": items,
"TotalRecordCount": int64(len(items)),
}, nil
}
// libraryExists 判断 ID 是否对应本地媒体库。
func (e *EmbyService) libraryExists(ctx context.Context, id string) bool {
if e == nil || e.repo == nil || e.repo.Library == nil {
return false
}
lib, err := e.repo.Library.FindByID(ctx, id)
if err != nil {
return false
}
return lib != nil
}
// embyGenreID 为类型生成稳定的虚拟 ID。
//
// 客户端会把 Id 当作条目去请求图片/详情,直接用类型名会带上空格与非 ASCII
// 字符,因此用固定前缀 + 名称哈希;同一个名称永远得到同一个 ID。
func embyGenreID(name string) string {
sum := sha1.Sum([]byte(strings.ToLower(strings.TrimSpace(name))))
return "msgo-genre-" + hex.EncodeToString(sum[:])[:16]
}
+19
View File
@@ -47,16 +47,35 @@ func (e *EmbyService) embyItemsCacheKey(kind string, p ItemsParams) string {
p.SortOrder,
strconv.Itoa(p.StartIndex),
strconv.Itoa(p.Limit),
formatSeasonIndexCacheKeyPart(p.SeasonIndex),
}, "|")))
return "media:emby:" + hex.EncodeToString(sum[:])
}
// formatSeasonIndexCacheKeyPart keeps "no season filter" distinct from "season 0"
// so a client's Season=0 (specials) request never reuses an unfiltered response.
func formatSeasonIndexCacheKeyPart(seasonIndex *int) string {
if seasonIndex == nil {
return "season:*"
}
return "season:" + strconv.Itoa(*seasonIndex)
}
func (e *EmbyService) embyLatestCacheKey(userID, parentID string, limit int) string {
// v2: payload tags for virtual artwork changed so clients drop cached placeholders.
sum := sha256.Sum256([]byte(strings.Join([]string{"latest-v2", userID, parentID, strconv.Itoa(limit)}, "|")))
return "media:emby:" + hex.EncodeToString(sum[:])
}
// embySimilarCacheKey 是「相似推荐」结果的缓存键。
//
// userID 必须参与键名:候选集的可见性(AllowedLibraryIDs、NSFW)由用户决定,
// 混用会把别的用户可见的条目推荐给当前用户。limit 同理影响结果条数与排序。
func (e *EmbyService) embySimilarCacheKey(mediaID, userID string, limit int) string {
sum := sha256.Sum256([]byte(strings.Join([]string{"similar-v1", mediaID, userID, strconv.Itoa(limit)}, "|")))
return "media:emby:" + hex.EncodeToString(sum[:])
}
// defaultEmbyLatestCacheTTLSeconds 是 Emby「最新添加」缓存的兜底时长。
const defaultEmbyLatestCacheTTLSeconds = 300
+33 -3
View File
@@ -299,8 +299,14 @@ func embyLatestSeriesRowLimit(limit int) int {
}
// ResumeItems 列出有未完成播放进度的媒体。
func (e *EmbyService) ResumeItems(ctx context.Context, userID string, limit int) (map[string]any, error) {
return e.resumableItems(ctx, ItemsParams{UserID: userID, Limit: limit})
// parentID 非空时收窄到该库 / 该剧(含虚拟 msgo-series-* ID)。
func (e *EmbyService) ResumeItems(ctx context.Context, userID, parentID string, limit, startIndex int) (map[string]any, error) {
return e.resumableItems(ctx, ItemsParams{
UserID: userID,
ParentID: strings.TrimSpace(parentID),
Limit: limit,
StartIndex: startIndex,
})
}
// favoriteItems returns favourited media for Emby clients, including mounted
@@ -434,6 +440,30 @@ func favoriteMatchesParent(ctx context.Context, e *EmbyService, parentID, mediaI
return wantMountID != "" && gotMountID == wantMountID
}
// resumeMatchesParent 判断续播条目是否属于 ParentId / SeriesId 作用域。
// 本地剧集的 series_id 常为空,实际对外 ID 是 msgo-series-* 虚拟 ID,必须用
// seriesIDForMedia 对齐,否则按剧收窄永远匹配不上。
func resumeMatchesParent(ctx context.Context, e *EmbyService, parentID, libraryID, seriesID string, m *model.Media) bool {
if parentID == "" {
return true
}
if libraryID == parentID || seriesID == parentID {
return true
}
if m != nil && e.seriesIDForMedia(ctx, m) == parentID {
return true
}
if m != nil && e.seasonIDForMedia(ctx, m) == parentID {
return true
}
for _, id := range e.mergedLibraryIDs(ctx, parentID) {
if id == libraryID {
return true
}
}
return false
}
// resumableItems 返回未完成播放进度的媒体(包含本地媒体与挂载的远程媒体),支持分页。
func (e *EmbyService) resumableItems(ctx context.Context, p ItemsParams) (map[string]any, error) {
if p.Limit <= 0 || p.Limit > 100 {
@@ -500,7 +530,7 @@ func (e *EmbyService) resumableItems(ctx context.Context, p ItemsParams) (map[st
localTotal, remoteTotal := 0, 0
for _, h := range hist {
if m, ok := byID[h.MediaID]; ok {
if p.ParentID != "" && m.LibraryID != p.ParentID && m.SeriesID != p.ParentID {
if p.ParentID != "" && !resumeMatchesParent(ctx, e, p.ParentID, m.LibraryID, m.SeriesID, m) {
continue
}
localTotal++
+21 -6
View File
@@ -121,16 +121,31 @@ func (e *EmbyService) mediaItems(ctx context.Context, p ItemsParams) (map[string
func (e *EmbyService) episodeItems(ctx context.Context, rows []model.Media, p ItemsParams) (map[string]any, error) {
rows = e.filterMediaRowsForUser(ctx, rows, p.UserID)
if p.SearchTerm != "" {
filtered := rows[:0]
needle := strings.ToLower(p.SearchTerm)
for _, row := range rows {
if strings.Contains(strings.ToLower(row.Title), needle) || strings.Contains(strings.ToLower(row.OriginalName), needle) {
filtered = append(filtered, row)
// rows 可能来自 series 分组的内存 memo(embySeriesGroup.Episodes)。过滤必须
// 分配新切片:就地复用 rows[:0] 会覆写 memo 里的元素,让后续请求看到被前一次
// 过滤污染的剧集列表(例如按季筛选一次之后,特别篇就从缓存分组里消失了)。
if p.SeasonIndex != nil {
filtered := make([]model.Media, 0, len(rows))
for i := range rows {
if embyRowMatchesSeasonIndex(&rows[i], p.SeasonIndex) {
filtered = append(filtered, rows[i])
}
}
rows = filtered
}
if p.SearchTerm != "" {
needle := strings.ToLower(p.SearchTerm)
filtered := make([]model.Media, 0, len(rows))
for i := range rows {
if strings.Contains(strings.ToLower(rows[i].Title), needle) || strings.Contains(strings.ToLower(rows[i].OriginalName), needle) {
filtered = append(filtered, rows[i])
}
}
rows = filtered
}
// sort.SliceStable 同样会就地重排:先拷贝一份,避免把 memo 分组里的剧集顺序
// 按每次请求的分页/筛选结果固定下来。
rows = append([]model.Media(nil), rows...)
sort.SliceStable(rows, func(i, j int) bool {
if rows[i].SeasonNum != rows[j].SeasonNum {
return rows[i].SeasonNum < rows[j].SeasonNum
+217 -16
View File
@@ -79,6 +79,61 @@ type EmbyRemoteService struct {
personMu sync.RWMutex
personImages map[string]embyRemotePersonImageRef
// imageTagMu 保护 imageTags:远程条目图片标签缓存,键为
// imageTagKey(accountID, remoteID, imageType)。它让图片 URL 带上远端
// ImageTags,从而在远端换图后让本地磁盘缓存与客户端缓存一起失效
// (没有它时 URL 恒定,缩略图会永久停留在旧版本)。
imageTagMu sync.RWMutex
imageTags map[string]string
// remoteGate 是发往远程 Emby 的并发闸门。第三方客户端刷新首页时会为每个
// 远程媒体库各请求一次 /Items/Latest,挂着几十个库就是几十路并发(生产环境
// 实测 50 路同时打进来,单个请求被拖到 5s+)。限制在途请求数后单个请求的
// 等待时间反而下降,也不会把 2C 小机和对方服务器一起打满。
//
// nil 表示不限流(测试直接构造结构体时走这条路)。
remoteGate chan struct{}
}
// embyRemoteConcurrencyLimit 是同时发往远程 Emby 的请求数上限。
const embyRemoteConcurrencyLimit = 8
// enterRemoteGate 取得一个远程请求名额,返回释放函数。未配置闸门时返回空操作。
func (r *EmbyRemoteService) enterRemoteGate(ctx context.Context) (func(), error) {
if r == nil || r.remoteGate == nil {
return func() {}, nil
}
select {
case r.remoteGate <- struct{}{}:
return func() { <-r.remoteGate }, nil
case <-ctx.Done():
return nil, ctx.Err()
}
}
// fetchRemoteBody 在并发闸门内发起请求并读完响应体,返回状态码与字节。
func (r *EmbyRemoteService) fetchRemoteBody(ctx context.Context, req *http.Request, path string) (int, []byte, error) {
release, err := r.enterRemoteGate(ctx)
if err != nil {
return 0, nil, err
}
defer release()
resp, err := r.http.Do(req)
if err != nil {
return 0, nil, redactSensitiveError(fmt.Errorf("请求远程 Emby 失败: %w", err))
}
defer resp.Body.Close()
// 读 8MB+1 以区分"刚好 8MB"与"被截断":截断的 JSON 会让
// Unmarshal 报 unexpected end,难以定位;这里显式报错。
data, readErr := io.ReadAll(io.LimitReader(resp.Body, (8<<20)+1))
if readErr != nil {
return resp.StatusCode, nil, readErr
}
if len(data) > 8<<20 {
return resp.StatusCode, data, fmt.Errorf("远程 Emby 响应超过 8MB 上限(路径 %s):请减小分页或 Fields 字段", path)
}
return resp.StatusCode, data, nil
}
type embyRemotePersonImageRef struct {
@@ -86,6 +141,9 @@ type embyRemotePersonImageRef struct {
remoteID string
}
// embyRemoteMaxImageTags 限制图片标签映射的条目数,避免长期运行后无界增长。
const embyRemoteMaxImageTags = 20000
// NewEmbyRemoteService 构造远程 Emby 聚合服务。
func NewEmbyRemoteService(cfg *config.Config, log *zap.Logger, repo *repository.Container, crypto *CryptoService) *EmbyRemoteService {
return &EmbyRemoteService{
@@ -103,6 +161,7 @@ func NewEmbyRemoteService(cfg *config.Config, log *zap.Logger, repo *repository.
stream: &http.Client{
Transport: &embyRemoteTransport{base: http.DefaultTransport},
},
remoteGate: make(chan struct{}, embyRemoteConcurrencyLimit),
}
}
@@ -635,21 +694,11 @@ func (r *EmbyRemoteService) doGetOnLine(ctx context.Context, acct *model.StrmAcc
return err
}
req.Header.Set("X-Emby-Token", cfg.Token)
resp, err := r.http.Do(req)
status, data, err := r.fetchRemoteBody(ctx, req, path)
if err != nil {
return redactSensitiveError(fmt.Errorf("请求远程 Emby 失败: %w", err))
return err
}
// 读 8MB+1 以区分"刚好 8MB"与"被截断":截断的 JSON 会让
// Unmarshal 报 unexpected end,难以定位;这里显式报错。
data, readErr := io.ReadAll(io.LimitReader(resp.Body, (8<<20)+1))
resp.Body.Close()
if readErr != nil {
return readErr
}
if len(data) > 8<<20 {
return fmt.Errorf("远程 Emby 响应超过 8MB 上限(路径 %s):请减小分页或 Fields 字段", path)
}
if resp.StatusCode == http.StatusUnauthorized && attempt == 0 {
if status == http.StatusUnauthorized && attempt == 0 {
// 401:只清当前线路的内存 token 并立即重认证;不在此时删除
// DB 里的 api_key——①外层还会按线路故障转移(其他线路可能
// 存有自己的 token);②纯 api_key 账号删除后无法再认证,一次
@@ -663,8 +712,8 @@ func (r *EmbyRemoteService) doGetOnLine(ctx context.Context, acct *model.StrmAcc
master.RemoteUserID = cfg.RemoteUserID
continue
}
if resp.StatusCode >= 300 {
return redactSensitiveError(fmt.Errorf("远程 Emby 请求失败(%d): %s", resp.StatusCode, strings.TrimSpace(string(data))))
if status >= 300 {
return redactSensitiveError(fmt.Errorf("远程 Emby 请求失败(%d): %s", status, strings.TrimSpace(string(data))))
}
if out == nil {
return nil
@@ -819,6 +868,7 @@ func (r *EmbyRemoteService) RemoteItem(ctx context.Context, mount *model.EmbyMou
var cached map[string]any
if r.cache.GetJSON(ctx, cacheKey, &cached) && len(cached) > 0 {
r.rememberRemotePeople(mount, cached)
r.rememberRemoteImageTags(embyRemoteAccountID(acct), cached)
return cached, nil
}
}
@@ -833,6 +883,7 @@ func (r *EmbyRemoteService) RemoteItem(ctx context.Context, mount *model.EmbyMou
return nil, err
}
r.rememberRemotePeople(mount, out)
r.rememberRemoteImageTags(embyRemoteAccountID(acct), out)
RewriteEmbyRemoteIDs(out, mount.ID)
if cacheKey != "" && len(out) > 0 {
r.cache.SetJSON(ctx, cacheKey, out, r.remoteMediaCacheTTL())
@@ -1153,6 +1204,150 @@ func rewriteSubtitleDeliveryURLs(src map[string]any, playURL string, cfg *EmbyRe
}
}
// embyRemoteImageTagType 归一化图片类型:Emby 的 Art 与 Backdrop 指同一张图,
// 载荷里的 ImageTags 只会有 Primary / Backdrop 两个键。
func embyRemoteImageTagType(imageType string) string {
switch strings.ToLower(strings.TrimSpace(imageType)) {
case "primary", "poster":
return "Primary"
case "backdrop", "art", "background":
return "Backdrop"
default:
return ""
}
}
// remoteItemImageTag 从远程条目载荷读取某一类图片的原始 tag。载荷可能已被
// RewriteEmbyRemoteIDs 伪装过(tag 变成 embyremote~scope~tag),此处会还原。
func remoteItemImageTag(item map[string]any, imageType string) string {
typ := embyRemoteImageTagType(imageType)
if item == nil || typ == "" {
return ""
}
var raw string
switch tags := item["ImageTags"].(type) {
case map[string]any:
raw = anyString(tags[typ])
case map[string]string:
raw = tags[typ]
}
if raw == "" && typ == "Backdrop" {
switch tags := item["BackdropImageTags"].(type) {
case []any:
if len(tags) > 0 {
raw = anyString(tags[0])
}
case []string:
if len(tags) > 0 {
raw = tags[0]
}
}
}
if _, original, ok := DecodeEmbyRemoteID(raw); ok {
return original
}
return strings.TrimSpace(raw)
}
// imageTagKey 是图片标签映射的键;不认识的图片类型返回空串(不记录)。
func imageTagKey(accountID, remoteID, imageType string) string {
typ := embyRemoteImageTagType(imageType)
if typ == "" || strings.TrimSpace(remoteID) == "" || strings.TrimSpace(accountID) == "" {
return ""
}
return accountID + "|" + remoteID + "|" + typ
}
// rememberRemoteImageTagValue 记录单条图片标签(供 SeriesPrimaryImageTag 这类
// 散落在载荷其他字段里的标签使用)。
func (r *EmbyRemoteService) rememberRemoteImageTagValue(accountID, remoteID, imageType, tag string) {
if r == nil || strings.TrimSpace(tag) == "" {
return
}
if _, original, ok := DecodeEmbyRemoteID(tag); ok {
tag = original
}
key := imageTagKey(accountID, remoteID, imageType)
if key == "" {
return
}
r.imageTagMu.Lock()
defer r.imageTagMu.Unlock()
if r.imageTags == nil || len(r.imageTags) > embyRemoteMaxImageTags {
r.imageTags = make(map[string]string, 256)
}
r.imageTags[key] = tag
}
// rememberRemoteImageTags 记录载荷里出现的图片标签。载荷可以已被伪装。
func (r *EmbyRemoteService) rememberRemoteImageTags(accountID string, item map[string]any) {
if r == nil || item == nil || strings.TrimSpace(accountID) == "" {
return
}
remoteID := remoteItemString(item, "Id")
if _, original, ok := DecodeEmbyRemoteID(remoteID); ok {
remoteID = original
}
if strings.TrimSpace(remoteID) == "" {
return
}
for _, imageType := range []string{"Primary", "Backdrop"} {
if tag := remoteItemImageTag(item, imageType); tag != "" {
r.rememberRemoteImageTagValue(accountID, remoteID, imageType, tag)
}
}
}
// remoteImageTag 查询已记录的图片标签;未知时返回空串(调用方退化为原行为)。
func (r *EmbyRemoteService) remoteImageTag(accountID, remoteID, imageType string) string {
if r == nil {
return ""
}
key := imageTagKey(accountID, remoteID, imageType)
if key == "" {
return ""
}
r.imageTagMu.RLock()
defer r.imageTagMu.RUnlock()
return r.imageTags[key]
}
// remoteImageTagQuery 返回追加到远程图片地址后的 tag 查询片段(含 & 前缀)。
// Emby 用 tag 作为图片 ETag/cache key:带上它之后,远端换图会改变 MeBox 的
// 磁盘缓存键,缩略图与客户端缓存都会随之失效,而不是永久停留在旧版本。
func (r *EmbyRemoteService) remoteImageTagQuery(accountID, remoteID, imageType string) string {
tag := r.remoteImageTag(accountID, remoteID, imageType)
if tag == "" {
return ""
}
return "&tag=" + url.QueryEscape(tag)
}
// RemoteImageTagOfEncodedID 按伪装 ID 解析已记录的图片标签,供兼容层
// 回报 ImageTag(客户端据此决定是否复用自己缓存的图片)。
func (r *EmbyRemoteService) RemoteImageTagOfEncodedID(ctx context.Context, encodedID, imageType string) string {
if r == nil {
return ""
}
mountID, remoteID, ok := DecodeEmbyRemoteID(encodedID)
if !ok {
return ""
}
_, acct, _ := r.ResolveMount(ctx, mountID)
if acct == nil {
return ""
}
return r.remoteImageTag(acct.ID, remoteID, imageType)
}
// embyRemoteAccountID 空值安全的账号 ID 读取(构建图片 URL 时可能只有账号对象)。
func embyRemoteAccountID(acct *model.StrmAccount) string {
if acct == nil {
return ""
}
return acct.ID
}
// RemoteImageURL 构造远程图片绝对地址(由既有 ImageProxy 拉取透传)。
func (r *EmbyRemoteService) RemoteImageURL(ctx context.Context, acct *model.StrmAccount, remoteID, imageType string) (string, error) {
cfg, err := r.configOf(acct)
@@ -1160,7 +1355,7 @@ func (r *EmbyRemoteService) RemoteImageURL(ctx context.Context, acct *model.Strm
return "", err
}
return r.embyBase(cfg) + "/Items/" + url.PathEscape(remoteID) + "/Images/" + url.PathEscape(strings.ToLower(imageType)) +
"?api_key=" + url.QueryEscape(cfg.Token), nil
"?api_key=" + url.QueryEscape(cfg.Token) + r.remoteImageTagQuery(embyRemoteAccountID(acct), remoteID, imageType), nil
}
// rememberRemotePeople 记录远程人物名称到远程人物 ID 的映射,供旧式
@@ -1461,6 +1656,12 @@ func (r *EmbyRemoteService) doMutateOnLine(ctx context.Context, cfg *EmbyRemoteC
return err
}
req.Header.Set("X-Emby-Token", cfg.Token)
// 状态同步同样走远程并发闸门:它和首页那批 Latest 请求共用对方服务器。
release, err := r.enterRemoteGate(ctx)
if err != nil {
return err
}
defer release()
resp, err := r.http.Do(req)
if err != nil {
return redactSensitiveError(fmt.Errorf("请求远程 Emby 失败: %w", err))
+112
View File
@@ -0,0 +1,112 @@
package service
import (
"context"
"errors"
"net/http"
"net/http/httptest"
"sync"
"testing"
"time"
"go.uber.org/zap"
"github.com/truewhile/MeBox/internal/config"
)
// 远程 Emby 的并发闸门必须真的把在途请求数压在上限之内:第三方客户端首页会为
// 每个远程媒体库各请求一次 /Items/Latest,几十个库就是几十路并发。
func TestRemoteGateLimitsConcurrentRequests(t *testing.T) {
const gate = 3
const requests = 12
var mu sync.Mutex
inflight, peak := 0, 0
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
mu.Lock()
inflight++
if inflight > peak {
peak = inflight
}
mu.Unlock()
time.Sleep(20 * time.Millisecond)
mu.Lock()
inflight--
mu.Unlock()
_, _ = w.Write([]byte(`{"Items":[]}`))
}))
defer srv.Close()
svc := &EmbyRemoteService{http: srv.Client(), remoteGate: make(chan struct{}, gate)}
var wg sync.WaitGroup
for i := 0; i < requests; i++ {
wg.Add(1)
go func() {
defer wg.Done()
req, err := http.NewRequestWithContext(context.Background(), http.MethodGet, srv.URL+"/Items/Latest", nil)
if err != nil {
return
}
if _, _, err := svc.fetchRemoteBody(context.Background(), req, "/Items/Latest"); err != nil {
t.Errorf("fetchRemoteBody: %v", err)
}
}()
}
wg.Wait()
mu.Lock()
defer mu.Unlock()
if peak == 0 {
t.Fatal("test server never saw a request")
}
if peak > gate {
t.Fatalf("peak concurrency = %d, want <= %d", peak, gate)
}
}
// 闸门排队时要响应请求取消,不能把整个 HTTP 请求挂死。
func TestRemoteGateHonoursContextCancellation(t *testing.T) {
svc := &EmbyRemoteService{remoteGate: make(chan struct{}, 1)}
svc.remoteGate <- struct{}{} // 占满名额
ctx, cancel := context.WithCancel(context.Background())
cancel()
if _, err := svc.enterRemoteGate(ctx); !errors.Is(err, context.Canceled) {
t.Fatalf("err = %v, want context.Canceled", err)
}
// 释放名额后必须能正常拿到。
<-svc.remoteGate
release, err := svc.enterRemoteGate(context.Background())
if err != nil {
t.Fatalf("enterRemoteGate after release: %v", err)
}
release()
if len(svc.remoteGate) != 0 {
t.Fatalf("gate leaked a permit: len = %d", len(svc.remoteGate))
}
}
// 未配置闸门(测试里直接构造结构体)时不应限流,保持旧行为。
func TestRemoteGateAbsentIsUnlimited(t *testing.T) {
svc := &EmbyRemoteService{}
release, err := svc.enterRemoteGate(context.Background())
if err != nil {
t.Fatalf("enterRemoteGate: %v", err)
}
release()
}
// 生产路径构造出来的服务必须带闸门,否则上面的限制形同虚设。
func TestNewEmbyRemoteServiceInitialisesGate(t *testing.T) {
svc := NewEmbyRemoteService(&config.Config{}, zap.NewNop(), nil, nil)
if svc.remoteGate == nil {
t.Fatal("remoteGate must be initialised by the constructor")
}
if cap(svc.remoteGate) != embyRemoteConcurrencyLimit {
t.Fatalf("gate capacity = %d, want %d", cap(svc.remoteGate), embyRemoteConcurrencyLimit)
}
}
@@ -0,0 +1,173 @@
package service
import (
"strings"
"testing"
"go.uber.org/zap"
"github.com/truewhile/MeBox/internal/config"
"github.com/truewhile/MeBox/internal/model"
"github.com/truewhile/MeBox/internal/repository"
)
// newImageTagTestService 构造只用于图片标签映射测试的远程 Emby 服务。
func newImageTagTestService(t *testing.T) (*EmbyRemoteService, *model.EmbyMount, *model.StrmAccount) {
t.Helper()
db := newServiceTestDB(t, &model.StrmAccount{}, &model.EmbyMount{})
repos := repository.New(db)
svc := NewEmbyRemoteService(&config.Config{}, zap.NewNop(), repos, NewCryptoService("", zap.NewNop()))
acct := &model.StrmAccount{
Base: model.Base{ID: "acct-tag"},
Name: "tag-emby",
Provider: model.StrmProviderEmbyRemote,
Enabled: true,
Config: `{"url":"http://emby.test:8096","token":"fake-token"}`,
}
mount := &model.EmbyMount{
Base: model.Base{ID: "mount-tag"},
AccountID: acct.ID,
RemoteViewID: "view-tag",
Enabled: true,
}
if err := repos.StrmAccount.Create(t.Context(), acct); err != nil {
t.Fatalf("create account: %v", err)
}
if err := repos.EmbyMount.Create(t.Context(), mount); err != nil {
t.Fatalf("create mount: %v", err)
}
return svc, mount, acct
}
// testRemoteImageConfig 是图片 URL 构造所需的最小远程配置。
func testRemoteImageConfig() *EmbyRemoteConfig {
return &EmbyRemoteConfig{BaseURL: "http://emby.test:8096", Token: "fake-token"}
}
// TestMapRemoteItemToMediaCarriesImageTags 下发的图片 URL 必须带上远端图片
// 标签,否则远端换图后磁盘/客户端缓存永远不会失效。
func TestMapRemoteItemToMediaCarriesImageTags(t *testing.T) {
svc, mount, acct := newImageTagTestService(t)
media := svc.MapRemoteItemToMedia(t.Context(), mount, acct, testRemoteImageConfig(), map[string]any{
"Id": "movie-1",
"Name": "测试影片",
"Type": "Movie",
"ImageTags": map[string]any{
"Primary": "primary-tag-1",
},
"BackdropImageTags": []any{"backdrop-tag-1"},
})
if !strings.Contains(media.PosterURL, "tag=primary-tag-1") {
t.Fatalf("PosterURL missing remote image tag: %q", media.PosterURL)
}
if !strings.Contains(media.BackdropURL, "tag=backdrop-tag-1") {
t.Fatalf("BackdropURL missing remote image tag: %q", media.BackdropURL)
}
}
// TestMapRemoteItemToMediaCarriesImageTagsAfterRewrite 载荷先经过 ID 伪装
// (tag 变成 embyremote~...~tag)时仍要还原出原始 tag。
func TestMapRemoteItemToMediaCarriesImageTagsAfterRewrite(t *testing.T) {
svc, mount, acct := newImageTagTestService(t)
item := map[string]any{
"Id": "movie-2",
"Name": "伪装过的影片",
"Type": "Movie",
"ImageTags": map[string]any{
"Primary": "primary-tag-2",
},
}
RewriteEmbyRemoteIDs(item, mount.ID)
media := svc.MapRemoteItemToMedia(t.Context(), mount, acct, testRemoteImageConfig(), item)
if !strings.Contains(media.PosterURL, "tag=primary-tag-2") {
t.Fatalf("PosterURL missing decoded remote image tag: %q", media.PosterURL)
}
if strings.Contains(media.PosterURL, EmbyRemoteIDPrefix) {
t.Fatalf("PosterURL leaked disguised tag: %q", media.PosterURL)
}
}
// TestRemoteImageURLCacheKeyFollowsImageTag 远端换图(tag 变化)后,图片 URL
// 必须随之变化,缓存键才会失效。
func TestRemoteImageURLCacheKeyFollowsImageTag(t *testing.T) {
svc, mount, acct := newImageTagTestService(t)
first := svc.MapRemoteItemToMedia(t.Context(), mount, acct, testRemoteImageConfig(), map[string]any{
"Id": "movie-3",
"Name": "换图影片",
"Type": "Movie",
"ImageTags": map[string]any{"Primary": "old-tag"},
})
second := svc.MapRemoteItemToMedia(t.Context(), mount, acct, testRemoteImageConfig(), map[string]any{
"Id": "movie-3",
"Name": "换图影片",
"Type": "Movie",
"ImageTags": map[string]any{"Primary": "new-tag"},
})
if first.PosterURL == second.PosterURL {
t.Fatalf("image URL did not change when the remote tag changed: %q", first.PosterURL)
}
if imageCacheKeyURL(first.PosterURL) == imageCacheKeyURL(second.PosterURL) {
t.Fatal("image cache key did not change when the remote tag changed")
}
}
// TestMapRemoteItemToMediaWithoutImageTagsKeepsURLTagFree 没有标签时保持原样
// (不追加空 tag 参数)。
func TestMapRemoteItemToMediaWithoutImageTagsKeepsURLTagFree(t *testing.T) {
svc, mount, acct := newImageTagTestService(t)
media := svc.MapRemoteItemToMedia(t.Context(), mount, acct, testRemoteImageConfig(), map[string]any{
"Id": "movie-4",
"Name": "无标签影片",
"Type": "Movie",
"ImageTags": map[string]any{"Primary": "primary-tag-4"},
})
if !strings.Contains(media.PosterURL, "tag=primary-tag-4") {
t.Fatalf("PosterURL missing tag: %q", media.PosterURL)
}
if strings.Contains(media.BackdropURL, "tag=") {
t.Fatalf("BackdropURL should not carry a tag when absent: %q", media.BackdropURL)
}
unknown := svc.MapRemoteItemToMedia(t.Context(), mount, acct, testRemoteImageConfig(), map[string]any{
"Id": "movie-5",
"Name": "未知标签影片",
"Type": "Movie",
"ImageTags": map[string]any{
"Primary": "primary-tag-5",
},
})
if strings.Contains(unknown.BackdropURL, "tag=") {
t.Fatalf("unknown image tag should degrade to no tag: %q", unknown.BackdropURL)
}
}
// TestRemoteImageURLIncludesRememberedTag 兼容层(/emby/Items/{id}/Images/...)
// 复用同一份标签映射。
func TestRemoteImageURLIncludesRememberedTag(t *testing.T) {
svc, mount, acct := newImageTagTestService(t)
svc.rememberRemoteImageTags(acct.ID, map[string]any{
"Id": "movie-6",
"ImageTags": map[string]any{"Primary": "compat-tag"},
})
raw, err := svc.RemoteImageURL(t.Context(), acct, "movie-6", "Primary")
if err != nil {
t.Fatalf("RemoteImageURL failed: %v", err)
}
if !strings.Contains(raw, "tag=compat-tag") {
t.Fatalf("remote image URL missing tag: %q", raw)
}
encoded := EncodeEmbyRemoteID(mount.ID, "movie-6")
if got := svc.RemoteImageTagOfEncodedID(t.Context(), encoded, "Primary"); got != "compat-tag" {
t.Fatalf("RemoteImageTagOfEncodedID = %q, want compat-tag", got)
}
}
+240
View File
@@ -0,0 +1,240 @@
package service
import (
"context"
"encoding/json"
"net/http"
"net/http/httptest"
"strconv"
"testing"
"time"
"go.uber.org/zap"
"github.com/truewhile/MeBox/internal/config"
"github.com/truewhile/MeBox/internal/model"
"github.com/truewhile/MeBox/internal/repository"
)
// 回归:挂载的远程 Emby 剧集里,只看了几秒就退出的那一集必须仍是 NextUp 的结果。
// 客户端(Yamby 等)剧集详情页的「继续播放」直接取 NextUp 第一条,跳集会播错集。
func TestMountedRemoteNextUpKeepsPartiallyWatchedEpisode(t *testing.T) {
episode := func(id string, index int) map[string]any {
return map[string]any{
"Id": id,
"Name": "第" + strconv.Itoa(index) + "集",
"Type": "Episode",
"SeriesId": "series-100",
"ParentIndexNumber": 1,
"IndexNumber": index,
"RunTimeTicks": 14400640000,
}
}
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "application/json")
switch r.URL.Path {
case "/emby/Users/uid-1/Items/series-100":
_ = json.NewEncoder(w).Encode(map[string]any{"Id": "series-100", "Name": "剧一", "Type": "Series"})
case "/emby/Users/uid-1/Items/ep-2":
_ = json.NewEncoder(w).Encode(episode("ep-2", 2))
case "/emby/Users/uid-1/Items":
q := r.URL.Query()
if q.Get("IncludeItemTypes") != "Episode" || q.Get("ParentId") != "series-100" {
w.WriteHeader(http.StatusBadRequest)
return
}
_ = json.NewEncoder(w).Encode(map[string]any{
"TotalRecordCount": 3,
"Items": []map[string]any{
episode("ep-1", 1),
episode("ep-2", 2),
episode("ep-3", 3),
},
})
default:
w.WriteHeader(http.StatusNotFound)
}
}))
defer server.Close()
db := newServiceTestDB(t, &model.StrmAccount{}, &model.EmbyMount{}, &model.PlaybackHistory{}, &model.User{})
repos := repository.New(db)
cfg := &config.Config{}
remote := NewEmbyRemoteService(cfg, zap.NewNop(), repos, NewCryptoService("", zap.NewNop()))
svc := NewEmbyService(cfg, zap.NewNop(), repos).SetEmbyRemote(remote)
rawConfig, _ := json.Marshal(map[string]string{
"url": server.URL,
"api_key": "test-api-key",
"remote_user_id": "uid-1",
})
acct := &model.StrmAccount{
Base: model.Base{ID: "acct-1"},
Name: "远程 Emby",
Provider: model.StrmProviderEmbyRemote,
Config: string(rawConfig),
Enabled: true,
}
if err := repos.StrmAccount.Create(t.Context(), acct); err != nil {
t.Fatalf("create account: %v", err)
}
mount := &model.EmbyMount{
Base: model.Base{ID: "mount-1"},
AccountID: acct.ID,
RemoteViewID: "view-1",
RemoteViewName: "新番连载",
CollectionType: "tvshows",
Enabled: true,
}
if err := repos.EmbyMount.Create(t.Context(), mount); err != nil {
t.Fatalf("create mount: %v", err)
}
user := &model.User{
Base: model.Base{ID: "user-1"},
Username: "viewer",
PasswordHash: "x",
Role: "user",
Tier: "free",
IsActive: true,
}
if err := repos.User.Create(t.Context(), user); err != nil {
t.Fatalf("create user: %v", err)
}
// 第 2 集只播了 3.5 秒就退出:有进度、未标记看完。
if err := repos.DB.Create(&model.PlaybackHistory{
UserID: user.ID,
MediaID: EncodeEmbyRemoteID(mount.ID, "ep-2"),
PositionMs: 3582,
DurationMs: 1440064,
WatchedAt: time.Now(),
Completed: false,
}).Error; err != nil {
t.Fatalf("create history: %v", err)
}
envelope, err := svc.NextUp(t.Context(), user.ID, EncodeEmbyRemoteID(mount.ID, "series-100"), 1)
if err != nil {
t.Fatalf("NextUp: %v", err)
}
items, _ := envelope["Items"].([]map[string]any)
if len(items) != 1 {
t.Fatalf("items = %d, want 1 (%#v)", len(items), envelope)
}
wantID := EncodeEmbyRemoteID(mount.ID, "ep-2")
if id, _ := items[0]["Id"].(string); id != wantID {
t.Fatalf("Id = %q, want %q (未看完的那一集不能被跳过)", id, wantID)
}
userData, _ := items[0]["UserData"].(map[string]any)
if ticks, _ := userData["PlaybackPositionTicks"].(int64); ticks != 35820000 {
t.Fatalf("PlaybackPositionTicks = %#v, want 35820000 (详情页要能续播到 3.5 秒)", userData["PlaybackPositionTicks"])
}
}
// 远程剧集已看完当前一集时,NextUp 仍要指向下一集。
func TestMountedRemoteNextUpAfterCompletedEpisode(t *testing.T) {
episode := func(id string, index int) map[string]any {
return map[string]any{
"Id": id,
"Name": "第" + strconv.Itoa(index) + "集",
"Type": "Episode",
"SeriesId": "series-100",
"ParentIndexNumber": 1,
"IndexNumber": index,
"RunTimeTicks": 14400640000,
}
}
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "application/json")
switch r.URL.Path {
case "/emby/Users/uid-1/Items/series-100":
_ = json.NewEncoder(w).Encode(map[string]any{"Id": "series-100", "Name": "剧一", "Type": "Series"})
case "/emby/Users/uid-1/Items/ep-3":
_ = json.NewEncoder(w).Encode(episode("ep-3", 3))
case "/emby/Users/uid-1/Items":
_ = json.NewEncoder(w).Encode(map[string]any{
"TotalRecordCount": 3,
"Items": []map[string]any{
episode("ep-1", 1),
episode("ep-2", 2),
episode("ep-3", 3),
},
})
default:
w.WriteHeader(http.StatusNotFound)
}
}))
defer server.Close()
db := newServiceTestDB(t, &model.StrmAccount{}, &model.EmbyMount{}, &model.PlaybackHistory{}, &model.User{})
repos := repository.New(db)
cfg := &config.Config{}
remote := NewEmbyRemoteService(cfg, zap.NewNop(), repos, NewCryptoService("", zap.NewNop()))
svc := NewEmbyService(cfg, zap.NewNop(), repos).SetEmbyRemote(remote)
rawConfig, _ := json.Marshal(map[string]string{
"url": server.URL,
"api_key": "test-api-key",
"remote_user_id": "uid-1",
})
acct := &model.StrmAccount{
Base: model.Base{ID: "acct-1"},
Name: "远程 Emby",
Provider: model.StrmProviderEmbyRemote,
Config: string(rawConfig),
Enabled: true,
}
if err := repos.StrmAccount.Create(t.Context(), acct); err != nil {
t.Fatalf("create account: %v", err)
}
mount := &model.EmbyMount{
Base: model.Base{ID: "mount-1"},
AccountID: acct.ID,
RemoteViewID: "view-1",
RemoteViewName: "新番连载",
CollectionType: "tvshows",
Enabled: true,
}
if err := repos.EmbyMount.Create(t.Context(), mount); err != nil {
t.Fatalf("create mount: %v", err)
}
user := &model.User{
Base: model.Base{ID: "user-1"},
Username: "viewer",
PasswordHash: "x",
Role: "user",
Tier: "free",
IsActive: true,
}
if err := repos.User.Create(t.Context(), user); err != nil {
t.Fatalf("create user: %v", err)
}
// 第 2 集已整集看完。
if err := repos.DB.Create(&model.PlaybackHistory{
UserID: user.ID,
MediaID: EncodeEmbyRemoteID(mount.ID, "ep-2"),
PositionMs: 1440064,
DurationMs: 1440064,
WatchedAt: time.Now(),
Completed: true,
}).Error; err != nil {
t.Fatalf("create history: %v", err)
}
envelope, err := svc.NextUp(context.Background(), user.ID, EncodeEmbyRemoteID(mount.ID, "series-100"), 1)
if err != nil {
t.Fatalf("NextUp: %v", err)
}
items, _ := envelope["Items"].([]map[string]any)
if len(items) != 1 {
t.Fatalf("items = %d, want 1 (%#v)", len(items), envelope)
}
if id, _ := items[0]["Id"].(string); id != EncodeEmbyRemoteID(mount.ID, "ep-3") {
t.Fatalf("Id = %q, want ep-3", id)
}
}
+14 -9
View File
@@ -158,7 +158,7 @@ func (r *EmbyRemoteService) mapRemoteMountToLibrary(mount *model.EmbyMount, acct
}
// 远程媒体库封面只有真实存在图片标签才下发。
if remoteItemHasImageTag(item, "Primary") {
lib.CoverURL = r.remoteItemImageURL(cfg, mount.RemoteViewID, "Primary")
lib.CoverURL = r.remoteItemImageURL(acct, cfg, mount.RemoteViewID, "Primary")
}
return lib
}
@@ -176,6 +176,8 @@ func (r *EmbyRemoteService) MapRemoteItemToMedia(ctx context.Context, mount *mod
if _, rid, ok := DecodeEmbyRemoteID(remoteID); ok {
remoteID = rid
}
// 记录图片标签,使下发的图片 URL 带上 tag:远端换图后缓存随之失效。
r.rememberRemoteImageTags(embyRemoteAccountID(acct), item)
seriesID := remoteItemString(item, "SeriesId")
if _, rid, ok := DecodeEmbyRemoteID(seriesID); ok {
seriesID = rid
@@ -214,10 +216,10 @@ func (r *EmbyRemoteService) MapRemoteItemToMedia(ctx context.Context, mount *mod
}
// 只有远程明确存在图片标签才下发图片 URL。
if remoteItemHasImageTag(item, "Primary") {
media.PosterURL = r.remoteItemImageURL(cfg, remoteID, "Primary")
media.PosterURL = r.remoteItemImageURL(acct, cfg, remoteID, "Primary")
}
if remoteItemHasImageTag(item, "Backdrop") || len(remoteBackdropTags(item)) > 0 {
media.BackdropURL = r.remoteItemImageURL(cfg, remoteID, "Backdrop")
media.BackdropURL = r.remoteItemImageURL(acct, cfg, remoteID, "Backdrop")
}
if ticks := remoteItemInt64(item, "RunTimeTicks"); ticks > 0 {
media.DurationSec = int(ticks / 10_000_000)
@@ -307,9 +309,11 @@ func (r *EmbyRemoteService) MapRemoteItemToMedia(ctx context.Context, mount *mod
}
// 单集通常无独立海报:若远程返回 SeriesPrimaryImageTag(需要
// Fields=SeriesPrimaryImage)且系列有图,则回退到系列海报。
if media.PosterURL == "" && seriesID != "" &&
strings.TrimSpace(remoteItemString(item, "SeriesPrimaryImageTag")) != "" {
media.PosterURL = r.remoteItemImageURL(cfg, seriesID, "Primary")
if media.PosterURL == "" && seriesID != "" {
if seriesTag := strings.TrimSpace(remoteItemString(item, "SeriesPrimaryImageTag")); seriesTag != "" {
r.rememberRemoteImageTagValue(embyRemoteAccountID(acct), seriesID, "Primary", seriesTag)
media.PosterURL = r.remoteItemImageURL(acct, cfg, seriesID, "Primary")
}
}
default: // Movie / Series / Season / Folder
media.SeasonNum = 0
@@ -914,8 +918,9 @@ func remoteItemGenres(item map[string]any) string {
return strings.Join(parts, ",")
}
// remoteItemImageURL 构造远程条目图片绝对地址(带 api_key;前端经 /api/img 代理)。
func (r *EmbyRemoteService) remoteItemImageURL(cfg *EmbyRemoteConfig, remoteID, imageType string) string {
// remoteItemImageURL 构造远程条目图片绝对地址(带 api_key 与图片 tag;前端经
// /api/img 代理)。tag 来自载荷的 ImageTags,用于远端换图后缓存失效。
func (r *EmbyRemoteService) remoteItemImageURL(acct *model.StrmAccount, cfg *EmbyRemoteConfig, remoteID, imageType string) string {
if remoteID == "" {
return ""
}
@@ -924,7 +929,7 @@ func (r *EmbyRemoteService) remoteItemImageURL(cfg *EmbyRemoteConfig, remoteID,
imageType = "primary"
}
return r.embyBase(cfg) + "/Items/" + url.PathEscape(remoteID) + "/Images/" + url.PathEscape(imageType) +
"?api_key=" + url.QueryEscape(cfg.Token)
"?api_key=" + url.QueryEscape(cfg.Token) + r.remoteImageTagQuery(embyRemoteAccountID(acct), remoteID, imageType)
}
// remoteItemHasImageTag 远程 item 是否带某类型图片标签(Emby 的 ImageTags map)。
+231
View File
@@ -0,0 +1,231 @@
package service
import (
"testing"
"github.com/truewhile/MeBox/internal/model"
)
// seasonIndexFixture builds one series covering every season-numbering class a
// client can ask for: two regular seasons, a generic specials bucket (season 0)
// and an OVA folder (negative season).
func seasonIndexFixture(t *testing.T) (*EmbyService, string) {
t.Helper()
svc := newTestEmbyService(t)
lib := model.Library{Name: "剧集", Path: `F:\media\剧集`, Type: "tv", Enabled: true}
if err := svc.repo.Library.Create(t.Context(), &lib); err != nil {
t.Fatalf("create library: %v", err)
}
rows := []model.Media{
{
Base: model.Base{ID: "s1e1"},
LibraryID: lib.ID,
Title: "權力的遊戲",
Path: `F:\media\剧集\權力的遊戲 (2011)\Season 01\權力的遊戲 - S01E01.mkv`,
SeasonNum: 1,
EpisodeNum: 1,
},
{
Base: model.Base{ID: "s1e2"},
LibraryID: lib.ID,
Title: "權力的遊戲",
Path: `F:\media\剧集\權力的遊戲 (2011)\Season 01\權力的遊戲 - S01E02.mkv`,
SeasonNum: 1,
EpisodeNum: 2,
},
{
Base: model.Base{ID: "s2e1"},
LibraryID: lib.ID,
Title: "權力的遊戲",
Path: `F:\media\剧集\權力的遊戲 (2011)\Season 02\權力的遊戲 - S02E01.mkv`,
SeasonNum: 2,
EpisodeNum: 1,
},
{
Base: model.Base{ID: "spec1"},
LibraryID: lib.ID,
Title: "權力的遊戲",
Path: `F:\media\剧集\權力的遊戲 (2011)\Specials\權力的遊戲 - S00E01.mkv`,
SeasonNum: 0,
EpisodeNum: 1,
},
{
Base: model.Base{ID: "ova1"},
LibraryID: lib.ID,
Title: "權力的遊戲",
Path: `F:\media\剧集\權力的遊戲 (2011)\OVA\權力的遊戲 - OVA.mkv`,
SeasonNum: 0,
EpisodeNum: 1,
},
}
for i := range rows {
if err := svc.repo.DB.Create(&rows[i]).Error; err != nil {
t.Fatalf("create media: %v", err)
}
}
items, err := svc.Items(t.Context(), ItemsParams{
ParentID: lib.ID,
IncludeItemTypes: []string{"Series"},
Limit: 10,
})
if err != nil {
t.Fatalf("series items: %v", err)
}
cards := items["Items"].([]map[string]any)
if len(cards) != 1 {
t.Fatalf("want one series card, got %#v", cards)
}
return svc, cards[0]["Id"].(string)
}
func episodeIDs(t *testing.T, out map[string]any) []string {
t.Helper()
items, ok := out["Items"].([]map[string]any)
if !ok {
t.Fatalf("Items has unexpected type: %#v", out["Items"])
}
ids := make([]string, 0, len(items))
for _, item := range items {
ids = append(ids, item["Id"].(string))
}
return ids
}
// itemsTotal reads TotalRecordCount, which is int on the episode path and int64
// on the empty-envelope path.
func itemsTotal(t *testing.T, out map[string]any) int {
t.Helper()
switch v := out["TotalRecordCount"].(type) {
case int:
return v
case int64:
return int(v)
default:
t.Fatalf("TotalRecordCount has unexpected type: %#v", out["TotalRecordCount"])
return 0
}
}
func assertEpisodeIDs(t *testing.T, got, want []string) {
t.Helper()
if len(got) != len(want) {
t.Fatalf("episode ids = %#v, want %#v", got, want)
}
for i := range want {
if got[i] != want[i] {
t.Fatalf("episode ids = %#v, want %#v", got, want)
}
}
}
// TestEmbyEpisodeItemsFilterBySeasonIndex is the regression guard for clients
// that scope episodes by season number (Season=N) instead of the virtual season
// id: without the filter every season was returned for any requested season.
func TestEmbyEpisodeItemsFilterBySeasonIndex(t *testing.T) {
svc, seriesID := seasonIndexFixture(t)
cases := []struct {
name string
season *int
wantIDs []string
wantTotal int
}{
{
name: "unfiltered returns every episode",
season: nil,
// episodeItems sorts by the stored season/episode numbers, so the two
// specials (both stored as season 0) come first in creation order.
wantIDs: []string{"spec1", "ova1", "s1e1", "s1e2", "s2e1"},
wantTotal: 5,
},
{name: "season 1", season: intPtr(1), wantIDs: []string{"s1e1", "s1e2"}, wantTotal: 2},
{name: "season 2", season: intPtr(2), wantIDs: []string{"s2e1"}, wantTotal: 1},
{name: "season 0 is the specials bucket", season: intPtr(0), wantIDs: []string{"spec1"}, wantTotal: 1},
{name: "OVA season", season: intPtr(embySeasonOVA), wantIDs: []string{"ova1"}, wantTotal: 1},
{name: "unknown season is empty", season: intPtr(9), wantIDs: []string{}, wantTotal: 0},
}
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
out, err := svc.Items(t.Context(), ItemsParams{
ParentID: seriesID,
IncludeItemTypes: []string{"Episode"},
Recursive: true,
Limit: 50,
SeasonIndex: tc.season,
})
if err != nil {
t.Fatalf("items: %v", err)
}
assertEpisodeIDs(t, episodeIDs(t, out), tc.wantIDs)
if total := itemsTotal(t, out); total != tc.wantTotal {
t.Fatalf("TotalRecordCount = %d, want %d", total, tc.wantTotal)
}
})
}
}
// TestEmbySeasonIndexFilterKeepsSeasonIdsWorking pins the pre-existing
// SeasonId behaviour: resolving through the virtual season id must still return
// exactly that season.
func TestEmbySeasonIndexFilterKeepsSeasonIdsWorking(t *testing.T) {
svc, seriesID := seasonIndexFixture(t)
items, err := svc.Items(t.Context(), ItemsParams{ParentID: seriesID, Limit: 50})
if err != nil {
t.Fatalf("seasons: %v", err)
}
seasons := items["Items"].([]map[string]any)
var seasonTwoID string
for _, season := range seasons {
if season["IndexNumber"] == 2 {
seasonTwoID = season["Id"].(string)
}
}
if seasonTwoID == "" {
t.Fatalf("season 2 missing from payload: %#v", seasons)
}
out, err := svc.Items(t.Context(), ItemsParams{
ParentID: seasonTwoID,
IncludeItemTypes: []string{"Episode"},
Recursive: true,
Limit: 50,
})
if err != nil {
t.Fatalf("season episodes: %v", err)
}
got := episodeIDs(t, out)
assertEpisodeIDs(t, got, []string{"s2e1"})
}
// TestEmbyItemsCacheKeySeparatesSeasonFilters guards against a cached unfiltered
// response being reused for a season-scoped request (and vice versa).
func TestEmbyItemsCacheKeySeparatesSeasonFilters(t *testing.T) {
svc := newTestEmbyService(t)
base := ItemsParams{ParentID: "series-1", IncludeItemTypes: []string{"Episode"}, Limit: 50}
unfiltered := svc.embyItemsCacheKey("items", base)
seasonZero := svc.embyItemsCacheKey("items", withSeasonIndex(base, 0))
seasonTwo := svc.embyItemsCacheKey("items", withSeasonIndex(base, 2))
if unfiltered == seasonZero {
t.Fatal("unfiltered and Season=0 keys must differ")
}
if unfiltered == seasonTwo {
t.Fatal("unfiltered and Season=2 keys must differ")
}
if seasonZero == seasonTwo {
t.Fatal("Season=0 and Season=2 keys must differ")
}
if again := svc.embyItemsCacheKey("items", withSeasonIndex(base, 2)); again != seasonTwo {
t.Fatal("cache key must be stable for the same season filter")
}
}
func withSeasonIndex(p ItemsParams, season int) ItemsParams {
p.SeasonIndex = intPtr(season)
return p
}
func intPtr(v int) *int { return &v }
+10
View File
@@ -154,6 +154,16 @@ func embySeasonNumForMedia(m *model.Media) int {
return m.SeasonNum
}
// embyRowMatchesSeasonIndex 判断某条剧集是否属于客户端请求的季序号。
// seasonIndex 为 nil 时不参与过滤。判定复用 embySeasonNumForMedia,保证与
// /Shows/{id}/Seasons 暴露的 IndexNumber 完全一致(含特别篇的负数分类)。
func embyRowMatchesSeasonIndex(m *model.Media, seasonIndex *int) bool {
if seasonIndex == nil {
return true
}
return embySeasonNumForMedia(m) == *seasonIndex
}
func embySeasonCandidates(seasonNum int) []int {
if seasonNum > 0 {
return []int{seasonNum}
+118
View File
@@ -0,0 +1,118 @@
package service
import (
"context"
"testing"
"go.uber.org/zap"
"github.com/truewhile/MeBox/internal/config"
"github.com/truewhile/MeBox/internal/model"
)
// totalRecordCount 兼容两种来源:直算出来的是 int64,经过进程内缓存 JSON
// 往返后是 float64。两者序列化成 Emby 响应时完全一致。
func totalRecordCount(t *testing.T, out map[string]any) int {
t.Helper()
switch v := out["TotalRecordCount"].(type) {
case int64:
return int(v)
case int:
return v
case float64:
return int(v)
default:
t.Fatalf("unexpected TotalRecordCount type %T (%v)", out["TotalRecordCount"], out["TotalRecordCount"])
return 0
}
}
// 相似推荐的结果要缓存:详情页每次打开都会请求它,重建要走「取候选池 + 内存打分」
// (实测冷 340ms / 热 70ms)。
func TestSimilarItemsServesCachedPayload(t *testing.T) {
svc := newTestEmbyService(t)
repos := svc.repo
svc.SetRuntimeCache(NewRuntimeCacheService(&config.Config{}, zap.NewNop()))
libID := seedDiscoveryLibrary(t, repos, "movie")
source := seedSimilarMedia(t, repos, libID, "源片", "Action", 2010, 7)
seedSimilarMedia(t, repos, libID, "候选甲", "Action", 2010, 7)
seedSimilarMedia(t, repos, libID, "候选乙", "Comedy", 2011, 6)
ctx := context.Background()
first, err := svc.SimilarItems(ctx, source.ID, "user-1", 10)
if err != nil {
t.Fatalf("first SimilarItems: %v", err)
}
want := totalRecordCount(t, first)
if want == 0 {
t.Fatalf("first call returned no candidates, test data is wrong: %+v", first)
}
// 把候选全部删掉:第二次如果还返回原结果,只可能是命中缓存。
if err := repos.DB.Where("id <> ?", source.ID).Delete(&model.Media{}).Error; err != nil {
t.Fatal(err)
}
second, err := svc.SimilarItems(ctx, source.ID, "user-1", 10)
if err != nil {
t.Fatalf("second SimilarItems: %v", err)
}
if got := totalRecordCount(t, second); got != want {
t.Fatalf("cached call returned %d items, want %d (cache miss?)", got, want)
}
// 另一个用户(不同的可见性)不能复用别人的缓存:这里应当重新查询并得到 0。
other, err := svc.SimilarItems(ctx, source.ID, "user-2", 10)
if err != nil {
t.Fatalf("other user SimilarItems: %v", err)
}
if got := totalRecordCount(t, other); got != 0 {
t.Fatalf("other user got %d items, want 0 (per-user cache key)", got)
}
}
// limit 不同必须分开缓存,否则一次小 limit 请求会污染后续更大的请求。
func TestSimilarItemsCacheSeparatesLimit(t *testing.T) {
svc := newTestEmbyService(t)
repos := svc.repo
svc.SetRuntimeCache(NewRuntimeCacheService(&config.Config{}, zap.NewNop()))
libID := seedDiscoveryLibrary(t, repos, "movie")
source := seedSimilarMedia(t, repos, libID, "源片", "Action", 2010, 7)
for _, title := range []string{"甲", "乙", "丙", "丁"} {
seedSimilarMedia(t, repos, libID, "候选"+title, "Action", 2010, 7)
}
ctx := context.Background()
small, err := svc.SimilarItems(ctx, source.ID, "user-1", 2)
if err != nil {
t.Fatal(err)
}
if got := totalRecordCount(t, small); got != 2 {
t.Fatalf("limit=2 returned %d items, want 2", got)
}
large, err := svc.SimilarItems(ctx, source.ID, "user-1", 4)
if err != nil {
t.Fatal(err)
}
if got := totalRecordCount(t, large); got != 4 {
t.Fatalf("limit=4 returned %d items, want 4 (limit must be part of the cache key)", got)
}
}
// 没有注入缓存时(测试/精简部署)也必须正常工作。
func TestSimilarItemsWithoutCacheStillWorks(t *testing.T) {
svc := newTestEmbyService(t)
libID := seedDiscoveryLibrary(t, svc.repo, "movie")
source := seedSimilarMedia(t, svc.repo, libID, "源片", "Action", 2010, 7)
seedSimilarMedia(t, svc.repo, libID, "候选甲", "Action", 2010, 7)
out, err := svc.SimilarItems(context.Background(), source.ID, "user-1", 10)
if err != nil {
t.Fatalf("SimilarItems: %v", err)
}
if got := totalRecordCount(t, out); got == 0 {
t.Fatalf("expected candidates without a cache, got %+v", out)
}
}
+34
View File
@@ -27,8 +27,19 @@ type FFprobeService struct {
log *zap.Logger
mu sync.RWMutex
limiter chan struct{}
// availMu guards the short-lived availability cache used by Available().
availMu sync.Mutex
availCheckedAt time.Time
availValue bool
}
// ffprobeAvailabilityTTL bounds how long an Available() result is reused.
// Resolving a binary stats up to a couple dozen candidate paths, and the scanner
// consults availability per root while deciding whether to queue backfill
// probes. A short TTL keeps a freshly installed ffmpeg visible within seconds.
const ffprobeAvailabilityTTL = 30 * time.Second
// NewFFprobeService is the constructor.
func NewFFprobeService(cfg *config.Config, log *zap.Logger) *FFprobeService {
maxConcurrent := normalizeFFprobeMaxConcurrent(cfg.App.FFprobeMaxConcurrent)
@@ -54,6 +65,29 @@ func (f *FFprobeService) SetMaxConcurrent(n int) {
f.limiter = make(chan struct{}, normalizeFFprobeMaxConcurrent(n))
}
// Available reports whether a probe can actually run right now: either an
// ffprobe binary or the ffmpeg fallback must be resolvable. The scan path uses
// this to decide whether re-queueing probes for media that still lack technical
// metadata is worth doing — without a binary every probe would just fail.
func (f *FFprobeService) Available() bool {
if f == nil || f.cfg == nil {
return false
}
f.availMu.Lock()
defer f.availMu.Unlock()
if !f.availCheckedAt.IsZero() && time.Since(f.availCheckedAt) < ffprobeAvailabilityTTL {
return f.availValue
}
available := true
if _, err := resolveLocalExecutable(f.cfg.App.FFprobePath, "ffprobe"); err != nil {
_, ffmpegErr := resolveLocalExecutable(f.cfg.App.FFmpegPath, "ffmpeg")
available = ffmpegErr == nil
}
f.availValue = available
f.availCheckedAt = time.Now()
return available
}
// ProbeResult is the subset of ffprobe output consumed by the scanner.
type ProbeResult struct {
DurationSec int
+283
View File
@@ -0,0 +1,283 @@
package service
import (
"context"
"encoding/json"
"errors"
"fmt"
"os/exec"
"strconv"
"strings"
"time"
)
// ffprobeFullTimeout 是一次全量探测(含章节)的超时。远端直链实测 3~4 秒,
// 留足余量的同时不能让一个坏源把工作协程永久占住。
const ffprobeFullTimeout = 60 * time.Second
// ProbeInput 是喂给 ffprobe 的输入:本地文件给路径,STRM / 云盘给已解析的最终
// 直链加绑定请求头。解析由调用方负责(复用播放链路的换链逻辑),否则会踩到
// 115 CDN 的防盗链 403。
type ProbeInput struct {
Source string
Headers map[string]string
}
// ProbeStream 是一路轨道的关键字段,供详情页展示。
type ProbeStream struct {
Index int `json:"index"`
Type string `json:"type"`
Codec string `json:"codec,omitempty"`
Profile string `json:"profile,omitempty"`
Language string `json:"language,omitempty"`
Title string `json:"title,omitempty"`
Width int `json:"width,omitempty"`
Height int `json:"height,omitempty"`
PixFmt string `json:"pix_fmt,omitempty"`
FrameRate string `json:"frame_rate,omitempty"`
Channels int `json:"channels,omitempty"`
ChannelLayout string `json:"channel_layout,omitempty"`
SampleRate int `json:"sample_rate,omitempty"`
BitRate int64 `json:"bit_rate,omitempty"`
Default bool `json:"default,omitempty"`
Forced bool `json:"forced,omitempty"`
}
// ProbeChapter 是一个内嵌章节区间。
type ProbeChapter struct {
Index int `json:"index"`
StartMs int64 `json:"start_ms"`
EndMs int64 `json:"end_ms"`
Title string `json:"title,omitempty"`
}
// FullProbeResult 是一次全量探测的裁剪结果。
type FullProbeResult struct {
Container string
DurationSec int
BitRate int64
Streams []ProbeStream
Chapters []ProbeChapter
}
// mediaProbePayload 是落库的媒体信息结构。它只包含白名单字段——刻意不接受
// ffprobe 的原始 JSON,因为其中的 format.filename 是播放直链(含签名与
// pickcode),原样保存会外泄。
type mediaProbePayload struct {
Container string `json:"container,omitempty"`
DurationSec int `json:"duration_sec"`
BitRate int64 `json:"bit_rate,omitempty"`
Streams []ProbeStream `json:"streams"`
Chapters []ProbeChapter `json:"chapters,omitempty"`
}
// StreamsOfType 返回指定类型的轨道,供详情页分组展示。
func (r *FullProbeResult) StreamsOfType(kind string) []ProbeStream {
if r == nil {
return nil
}
out := make([]ProbeStream, 0, len(r.Streams))
for _, s := range r.Streams {
if s.Type == kind {
out = append(out, s)
}
}
return out
}
// PayloadJSON 序列化落库用的媒体信息。
func (r *FullProbeResult) PayloadJSON() (string, error) {
if r == nil {
return "", nil
}
streams := r.Streams
if streams == nil {
streams = []ProbeStream{}
}
body, err := json.Marshal(mediaProbePayload{
Container: r.Container,
DurationSec: r.DurationSec,
BitRate: r.BitRate,
Streams: streams,
Chapters: r.Chapters,
})
if err != nil {
return "", err
}
return string(body), nil
}
// ProbeFull 跑一次全量探测:容器信息 + 全部轨道 + 内嵌章节。
//
// 与 Probe 的区别:Probe 只取扫描需要的几个字段、对着媒体行的本地路径跑;
// ProbeFull 接受调用方解析好的输入(远端直链 + 绑定请求头),并额外抓章节。
func (f *FFprobeService) ProbeFull(ctx context.Context, input ProbeInput) (*FullProbeResult, error) {
if f == nil || f.cfg == nil {
return nil, errors.New("ffprobe service nil")
}
source := strings.TrimSpace(input.Source)
if source == "" {
return nil, errors.New("empty probe source")
}
token, err := f.acquire(ctx)
if err != nil {
return nil, err
}
defer f.release(token)
bin, err := resolveLocalExecutable(f.cfg.App.FFprobePath, "ffprobe")
if err != nil {
return nil, fmt.Errorf("ffprobe unavailable: %w", err)
}
probeCtx, cancel := context.WithTimeout(ctx, ffprobeFullTimeout)
defer cancel()
args := []string{"-v", "error"}
if headerText := ffmpegHeaderText(input.Headers); headerText != "" {
args = append(args, "-headers", headerText)
}
args = append(args,
"-print_format", "json",
"-show_format",
"-show_streams",
"-show_chapters",
source,
)
out, err := exec.CommandContext(probeCtx, bin, args...).Output() // #nosec G204 -- bin is resolved by resolveLocalExecutable before execution.
if err != nil {
return nil, fmt.Errorf("ffprobe full: %w", err)
}
return parseFullProbeJSON(out)
}
// probeNumber 兼容 ffprobe 把数值输出成字符串或裸数字两种形态
// (duration 是字符串,chapter 的 start_time 也可能是数字)。解析不出来就保持
// 零值:这些字段都只是展示用,不该因为一个格式差异让整次探测失败。
type probeNumber float64
func (p *probeNumber) UnmarshalJSON(data []byte) error {
text := strings.TrimSpace(strings.Trim(string(data), `"`))
if text == "" || text == "null" {
return nil
}
value, err := strconv.ParseFloat(text, 64)
if err != nil {
return nil
}
*p = probeNumber(value)
return nil
}
func (p probeNumber) float() float64 { return float64(p) }
func (p probeNumber) int() int { return int(float64(p)) }
func (p probeNumber) int64() int64 { return int64(float64(p)) }
// rawFullProbe 镜像 ffprobe -show_format -show_streams -show_chapters 的输出。
// 只声明用得到的字段;format.filename 刻意不声明,避免它进入任何落库路径。
type rawFullProbe struct {
Format struct {
FormatName string `json:"format_name"`
Duration probeNumber `json:"duration"`
BitRate probeNumber `json:"bit_rate"`
} `json:"format"`
Streams []struct {
Index int `json:"index"`
CodecType string `json:"codec_type"`
CodecName string `json:"codec_name"`
Profile string `json:"profile"`
Width int `json:"width"`
Height int `json:"height"`
PixFmt string `json:"pix_fmt"`
AvgFrameRate string `json:"avg_frame_rate"`
Channels int `json:"channels"`
ChannelLayout string `json:"channel_layout"`
SampleRate probeNumber `json:"sample_rate"`
BitRate probeNumber `json:"bit_rate"`
Tags struct {
Language string `json:"language"`
Title string `json:"title"`
} `json:"tags"`
Disposition struct {
Default int `json:"default"`
Forced int `json:"forced"`
} `json:"disposition"`
} `json:"streams"`
Chapters []struct {
StartTime probeNumber `json:"start_time"`
EndTime probeNumber `json:"end_time"`
Tags struct {
Title string `json:"title"`
} `json:"tags"`
} `json:"chapters"`
}
func parseFullProbeJSON(data []byte) (*FullProbeResult, error) {
var raw rawFullProbe
if err := json.Unmarshal(data, &raw); err != nil {
return nil, fmt.Errorf("parse ffprobe json: %w", err)
}
result := &FullProbeResult{
Container: strings.TrimSpace(raw.Format.FormatName),
DurationSec: raw.Format.Duration.int(),
BitRate: raw.Format.BitRate.int64(),
Streams: make([]ProbeStream, 0, len(raw.Streams)),
Chapters: make([]ProbeChapter, 0, len(raw.Chapters)),
}
for _, s := range raw.Streams {
stream := ProbeStream{
Index: s.Index,
Type: s.CodecType,
Codec: s.CodecName,
Profile: s.Profile,
Language: strings.TrimSpace(s.Tags.Language),
Title: strings.TrimSpace(s.Tags.Title),
Width: s.Width,
Height: s.Height,
PixFmt: s.PixFmt,
FrameRate: normalizeFrameRate(s.AvgFrameRate),
Channels: s.Channels,
ChannelLayout: s.ChannelLayout,
SampleRate: s.SampleRate.int(),
BitRate: s.BitRate.int64(),
Default: s.Disposition.Default != 0,
Forced: s.Disposition.Forced != 0,
}
result.Streams = append(result.Streams, stream)
}
for index, chapter := range raw.Chapters {
result.Chapters = append(result.Chapters, ProbeChapter{
Index: index,
StartMs: secondsToMillis(chapter.StartTime.float()),
EndMs: secondsToMillis(chapter.EndTime.float()),
Title: strings.TrimSpace(chapter.Tags.Title),
})
}
return result, nil
}
// secondsToMillis 把 ffprobe 的秒(浮点)转成毫秒整数。
func secondsToMillis(seconds float64) int64 {
if seconds <= 0 {
return 0
}
return int64(seconds*1000 + 0.5)
}
// normalizeFrameRate 把 "24000/1001" 这类分数帧率换算成可读形式;"0/0"
// (未知)返回空串。
func normalizeFrameRate(raw string) string {
raw = strings.TrimSpace(raw)
if raw == "" {
return ""
}
parts := strings.SplitN(raw, "/", 2)
if len(parts) != 2 {
return raw
}
num, errNum := strconv.ParseFloat(parts[0], 64)
den, errDen := strconv.ParseFloat(parts[1], 64)
if errNum != nil || errDen != nil || den == 0 || num <= 0 {
return ""
}
return strconv.FormatFloat(num/den, 'f', 3, 64)
}
+149
View File
@@ -0,0 +1,149 @@
package service
import (
"strings"
"testing"
)
const fullProbeFixture = `{
"format": {
"format_name": "matroska,webm",
"duration": "1451.024000",
"bit_rate": "8000000",
"filename": "https://cdn.example.com/secret/movie.mkv?d=vip-abc-pickcode&token=xyz"
},
"streams": [
{"index": 0, "codec_type": "video", "codec_name": "hevc", "profile": "Main 10",
"width": 3840, "height": 2160, "pix_fmt": "yuv420p10le", "avg_frame_rate": "24000/1001",
"bit_rate": "7800000", "disposition": {"default": 1}},
{"index": 1, "codec_type": "audio", "codec_name": "eac3", "channels": 6,
"channel_layout": "5.1(side)", "sample_rate": "48000",
"tags": {"language": "eng", "title": "Surround"}, "disposition": {"default": 1}},
{"index": 2, "codec_type": "subtitle", "codec_name": "ass",
"tags": {"language": "chi"}, "disposition": {"forced": 1}}
],
"chapters": [
{"start_time": "0.000000", "end_time": "95.000000", "tags": {"title": "Chapter 01"}},
{"start_time": "228.664000", "end_time": "246.143000", "tags": {"title": "Opening"}}
]
}`
func TestParseFullProbeJSONExtractsStreamsAndChapters(t *testing.T) {
got, err := parseFullProbeJSON([]byte(fullProbeFixture))
if err != nil {
t.Fatalf("parseFullProbeJSON: %v", err)
}
if got.Container != "matroska,webm" || got.DurationSec != 1451 || got.BitRate != 8_000_000 {
t.Fatalf("container/duration/bitrate = %q/%d/%d", got.Container, got.DurationSec, got.BitRate)
}
if len(got.Streams) != 3 {
t.Fatalf("streams = %#v, want 3", got.Streams)
}
video := got.Streams[0]
if video.Type != "video" || video.Codec != "hevc" || video.Width != 3840 || video.Height != 2160 {
t.Fatalf("video stream = %#v", video)
}
if video.FrameRate != "23.976" {
t.Fatalf("frame rate = %q, want 23.976 (converted from 24000/1001)", video.FrameRate)
}
if !video.Default {
t.Fatal("video stream should be flagged default")
}
audio := got.Streams[1]
if audio.Codec != "eac3" || audio.Language != "eng" || audio.Title != "Surround" || audio.Channels != 6 || audio.SampleRate != 48000 {
t.Fatalf("audio stream = %#v", audio)
}
sub := got.Streams[2]
if sub.Type != "subtitle" || sub.Language != "chi" || !sub.Forced {
t.Fatalf("subtitle stream = %#v", sub)
}
if len(got.Chapters) != 2 {
t.Fatalf("chapters = %#v, want 2", got.Chapters)
}
if got.Chapters[1].StartMs != 228_664 || got.Chapters[1].EndMs != 246_143 || got.Chapters[1].Title != "Opening" {
t.Fatalf("chapter[1] = %#v", got.Chapters[1])
}
if videoCount := len(got.StreamsOfType("video")); videoCount != 1 {
t.Fatalf("StreamsOfType(video) = %d, want 1", videoCount)
}
if audioCount := len(got.StreamsOfType("audio")); audioCount != 1 {
t.Fatalf("StreamsOfType(audio) = %d, want 1", audioCount)
}
}
// 落库的 payload 绝不能带 ffprobe 的 format.filename:那是解析后的播放直链,
// 里面是网盘签名和 pickcode,存进数据库等于把可直接下载的链接留下来。
func TestFullProbePayloadNeverLeaksSourceURL(t *testing.T) {
got, err := parseFullProbeJSON([]byte(fullProbeFixture))
if err != nil {
t.Fatalf("parseFullProbeJSON: %v", err)
}
payload, err := got.PayloadJSON()
if err != nil {
t.Fatalf("PayloadJSON: %v", err)
}
for _, needle := range []string{"filename", "cdn.example.com", "pickcode", "token=", "http"} {
if strings.Contains(payload, needle) {
t.Fatalf("payload 泄漏了 %q:\n%s", needle, payload)
}
}
// 技术信息本身必须保留。
for _, needle := range []string{"matroska,webm", "hevc", "3840", "Opening"} {
if !strings.Contains(payload, needle) {
t.Fatalf("payload 缺少 %q:\n%s", needle, payload)
}
}
}
// ffprobe 对 duration / start_time 有时输出字符串、有时输出裸数字,两种都要能读。
func TestParseFullProbeJSONAcceptsNumericAndStringTimes(t *testing.T) {
got, err := parseFullProbeJSON([]byte(`{
"format": {"format_name": "mp4", "duration": 125.5},
"streams": [],
"chapters": [{"start_time": 12.5, "end_time": 20}]
}`))
if err != nil {
t.Fatalf("parseFullProbeJSON: %v", err)
}
if got.DurationSec != 125 {
t.Fatalf("duration = %d, want 125", got.DurationSec)
}
if len(got.Chapters) != 1 || got.Chapters[0].StartMs != 12_500 || got.Chapters[0].EndMs != 20_000 {
t.Fatalf("chapters = %#v", got.Chapters)
}
}
func TestParseFullProbeJSONToleratesMissingSections(t *testing.T) {
got, err := parseFullProbeJSON([]byte(`{}`))
if err != nil {
t.Fatalf("parseFullProbeJSON: %v", err)
}
if got.DurationSec != 0 || len(got.Streams) != 0 || len(got.Chapters) != 0 {
t.Fatalf("result = %#v, want empty", got)
}
payload, err := got.PayloadJSON()
if err != nil {
t.Fatalf("PayloadJSON: %v", err)
}
// 空轨道必须序列化成 [],不能是 null——详情页前端按数组消费。
if !strings.Contains(payload, `"streams":[]`) {
t.Fatalf("payload = %s, want an empty streams array", payload)
}
}
func TestNormalizeFrameRate(t *testing.T) {
cases := map[string]string{
"24000/1001": "23.976",
"25/1": "25.000",
"0/0": "",
"": "",
"25": "25",
}
for input, want := range cases {
if got := normalizeFrameRate(input); got != want {
t.Errorf("normalizeFrameRate(%q) = %q, want %q", input, got, want)
}
}
}
+25 -2
View File
@@ -38,6 +38,12 @@ type ImageProxy struct {
mu sync.Mutex
fetchGroup singleflight.Group
// directClient bypasses HTTP_PROXY / OS proxy settings. It is built once and
// shared: rebuilding the transport on every fetch discarded all keep-alive
// connections, so every burst of poster requests paid a fresh TCP (and TLS)
// handshake per image.
directClient *http.Client
// resizeSem bounds concurrent decode/resize jobs. Emby TV clients request
// poster grids in bursts; letting every request decode a source image at
// once causes CPU and memory spikes that make the whole UI feel sluggish.
@@ -65,6 +71,12 @@ const (
imageBrowserCacheControl = "public, max-age=2592000, immutable"
imagePlaceholderCacheControl = "no-store"
imageMaxResizeConcurrency = 4
// imageOriginalCacheSubdir 存放上游原图(生成各种尺寸的原料,可再生)。
imageOriginalCacheSubdir = "originals"
// imageRenditionCacheSubdir 存放挂载 Emby 直接按尺寸产出的成品图:它们
// 已经是客户端要的最终尺寸,和派生缩略图一样属于长期保留的热路径缓存。
imageRenditionCacheSubdir = "renditions"
)
// NewImageProxy is the constructor.
@@ -113,6 +125,7 @@ func NewImageProxy(cfg *config.Config, log *zap.Logger) *ImageProxy {
}
proxy.client = &http.Client{Timeout: 30 * time.Second, Transport: transport}
proxy.directClient = &http.Client{Timeout: 30 * time.Second, Transport: NewInternalTransport()}
return proxy
}
@@ -207,10 +220,20 @@ func imageResizeConcurrency() int {
}
// Prune removes oldest cached images until disk usage is within the configured limit.
// 原图池按独立配额与保留时长优先淘汰,客户端热路径读取的成品图最后淘汰。
func (p *ImageProxy) Prune() (PruneImageCacheResult, error) {
if p.cfg == nil || p.cfg.Cache.ImagesMaxSizeMB <= 0 {
return PruneImageCacheResult{}, nil
}
maxBytes := int64(p.cfg.Cache.ImagesMaxSizeMB) * 1024 * 1024
return PruneImageCache(p.cacheDir, maxBytes)
var originalsMaxBytes int64
if p.cfg.Cache.ImagesOriginalsMaxSizeMB > 0 {
originalsMaxBytes = int64(p.cfg.Cache.ImagesOriginalsMaxSizeMB) * 1024 * 1024
}
var originalsMaxAge time.Duration
if p.cfg.Cache.ImagesOriginalsTTLHours > 0 {
originalsMaxAge = time.Duration(p.cfg.Cache.ImagesOriginalsTTLHours) * time.Hour
}
totalBytes := int64(p.cfg.Cache.ImagesMaxSizeMB) * 1024 * 1024
pools := ImageCachePools(p.cacheDir, originalsMaxBytes, originalsMaxAge)
return PruneImageCachePools(pools, totalBytes)
}
+112 -20
View File
@@ -4,6 +4,8 @@ import (
"bytes"
"crypto/sha256"
"encoding/hex"
"errors"
"fmt"
"io"
"net/http"
"os"
@@ -68,17 +70,7 @@ func serveCachedPlaceholder(w http.ResponseWriter) {
_, _ = w.Write(transparent1x1PNG)
}
func (p *ImageProxy) cloudImageCachePaths(stableKey string) (string, string, string) {
stableKey = strings.TrimSpace(stableKey)
if stableKey == "" {
stableKey = "unknown"
}
sum := sha256.Sum256([]byte("cloud-image:" + stableKey))
key := "cloud-" + hex.EncodeToString(sum[:])
cachePath := filepath.Join(p.cacheDir, key)
return key, cachePath, cachePath + ".fail"
}
// remoteImageCachePaths 返回上游原图池的路径(带 URL 校验)。
func (p *ImageProxy) remoteImageCachePaths(raw string) (string, string, string, error) {
if _, err := p.validateURL(raw); err != nil {
return "", "", "", err
@@ -87,13 +79,120 @@ func (p *ImageProxy) remoteImageCachePaths(raw string) (string, string, string,
return key, cachePath, failPath, nil
}
// remoteImageCachePathsForValidated 返回上游原图池的缓存路径。
func (p *ImageProxy) remoteImageCachePathsForValidated(raw string) (string, string, string) {
sum := sha256.Sum256([]byte(raw))
return p.remoteImageCachePathsInPool(raw, imageOriginalCacheSubdir)
}
// remoteImageCachePathsInPool 生成某个池内的缓存路径。池决定清理策略:
// 原图池小配额 + 短保留,成品池(挂载 Emby 按尺寸产出的图)长期保留。
func (p *ImageProxy) remoteImageCachePathsInPool(raw, pool string) (string, string, string) {
sum := sha256.Sum256([]byte(imageCacheKeyURL(raw)))
key := hex.EncodeToString(sum[:])
cachePath := filepath.Join(p.cacheDir, key)
cachePath := filepath.Join(p.cacheDir, pool, key)
return key, cachePath, cachePath + ".fail"
}
// remoteImageCachePathsEveryPool 返回同一个地址在所有池中的缓存路径。调用方
// 只知道原始 URL,无法判断它是原图还是挂载 Emby 按尺寸返回的成品,因此清理
// 类操作(refresh/retry)需要两个池都试一遍。
func (p *ImageProxy) remoteImageCachePathsEveryPool(raw string) [][3]string {
pools := []string{imageOriginalCacheSubdir, imageRenditionCacheSubdir}
out := make([][3]string, 0, len(pools))
for _, pool := range pools {
key, cachePath, failPath := p.remoteImageCachePathsInPool(raw, pool)
out = append(out, [3]string{key, cachePath, failPath})
}
return out
}
// imageProxyMaxDownloadBytes 是单张图片的下载上限,防上游异常返回超大响应
// 把磁盘和内存打满。
const imageProxyMaxDownloadBytes = 32 << 20
var (
// errImageCacheUnavailable 表示缓存目录不可写、连临时文件都建不出来。
// 它发生在读取响应体之前,因此调用方还能退回内存缓冲,保证图片不因
// 运维异常(磁盘只读/满)全部变成占位图。
errImageCacheUnavailable = errors.New("image cache is not writable")
// errImageCacheCommitFailed 表示响应体已被消费但无法提交到缓存(写入
// 中断、rename 失败等),此时无法重放响应体,只能按拉取失败处理。
errImageCacheCommitFailed = errors.New("image cache commit failed")
)
// cachedImageFileValid 只读取文件头判断缓存文件是否是可用图片。透明占位图
// 与空文件都视为不可用(历史实现曾把上游失败时的占位图写进缓存)。
func cachedImageFileValid(path string) error {
file, err := os.Open(path) // #nosec G304 -- cache paths are SHA-derived under cacheDir.
if err != nil {
return err
}
defer file.Close()
stat, err := file.Stat()
if err != nil || stat.IsDir() || stat.Size() <= 0 {
return errImageProxyNonImageContent
}
headerSize := 512
if stat.Size() < int64(headerSize) {
headerSize = int(stat.Size())
}
header := make([]byte, headerSize)
n, readErr := io.ReadFull(file, header)
if readErr != nil && !errors.Is(readErr, io.ErrUnexpectedEOF) {
return readErr
}
header = header[:n]
if !isImageContentType(detectContentType(header)) {
return errImageProxyNonImageContent
}
// 透明占位图恰好 67 字节;只看头部就够(detectContentType 也只读前 512 字节)。
if n == len(transparent1x1PNG) && bytes.Equal(header, transparent1x1PNG) {
return errImageProxyNonImageContent
}
return nil
}
// streamImageToCache 把上游响应体流式写入临时文件,校验确为图片后原子替换到
// cachePath。原图常有数兆字节,旧实现每次都要先整张读进内存再写盘,在小内存
// 主机上几个并发海报请求就能把内存顶满。
func (p *ImageProxy) streamImageToCache(cachePath, failPath string, body io.Reader) error {
if err := os.MkdirAll(filepath.Dir(cachePath), 0o750); err != nil {
p.warn("imageproxy: cache dir failed", err)
return errImageCacheUnavailable
}
tmp, err := os.CreateTemp(p.cacheDir, "img-*.tmp")
if err != nil {
p.warn("imageproxy: cache temp file failed", err)
return errImageCacheUnavailable
}
tmpName := tmp.Name()
discard := func() { _ = os.Remove(tmpName) }
written, copyErr := io.Copy(tmp, io.LimitReader(body, imageProxyMaxDownloadBytes))
closeErr := tmp.Close()
if copyErr != nil || closeErr != nil {
discard()
if copyErr != nil {
return copyErr
}
return fmt.Errorf("%w: %v", errImageCacheCommitFailed, closeErr)
}
if written == 0 {
discard()
return errors.New("upstream image body is empty")
}
if err := cachedImageFileValid(tmpName); err != nil {
discard()
return err
}
if err := os.Rename(tmpName, cachePath); err != nil {
discard()
return fmt.Errorf("%w: %v", errImageCacheCommitFailed, err)
}
_ = os.Remove(failPath)
return nil
}
func serveCachedImageFile(w http.ResponseWriter, r *http.Request, key, cachePath string) bool {
return serveImageFile(w, r, key, cachePath, imageBrowserCacheControl)
}
@@ -131,13 +230,6 @@ func imageFileETag(key string, stat os.FileInfo) string {
return `"img-` + hex.EncodeToString(sum[:8]) + "-" + strconv.FormatInt(stat.Size(), 16) + "-" + strconv.FormatInt(stat.ModTime().Unix(), 16) + `"`
}
func freshNegativeImageCache(failPath string) bool {
if _, err := os.Stat(failPath); err == nil {
_ = os.Remove(failPath)
}
return false
}
func (p *ImageProxy) markImageFetchFailed(failPath string) {
if err := os.MkdirAll(filepath.Dir(failPath), 0o750); err != nil {
return
+99 -93
View File
@@ -4,53 +4,80 @@ import (
"bytes"
"context"
"errors"
"io"
"net/http"
"os"
"path/filepath"
"strings"
"time"
"go.uber.org/zap"
)
var errImageProxyRequestSetup = errors.New("image proxy request setup failed")
var errImageProxyNonImageContent = errors.New("upstream returned non-image content")
// prefetchCardResizeOptions 对应前端 ARTWORK.posterCard(见 web/src/api/client.ts):
// 卡片是海报墙最常请求的档位,刮削阶段预生成它能让首个列表请求直接命中缓存。
// 若前端调整该预设,这里只是白生成一份用不到的档位(约几十 KB),不影响正确性。
var prefetchCardResizeOptions = imageResizeOptions{MaxWidth: 480, MaxHeight: 600, Quality: 80}
func (p *ImageProxy) PrefetchRemote(ctx context.Context, raw string) error {
_, _, err := p.Fetch(ctx, raw)
return err
}
// PrefetchCardVariant 预取原图后再离线生成卡片档位的缩略图。刮削是后台任务,
// 在这里做掉解码可以把海报墙首屏的 CPU 抖动移到请求路径之外。
//
// 预生成失败不影响预取结果:预取的成功含义是「图片可达」(刮削据此决定是否
// 替换旧图),而缩略图只是优化,客户端首次请求时会自己生成。
func (p *ImageProxy) PrefetchCardVariant(ctx context.Context, raw string) error {
if err := p.PrefetchRemote(ctx, raw); err != nil {
return err
}
if !isHTTPish(raw) {
return nil
}
_, cachePath, _ := p.remoteImageCachePathsForValidated(raw)
if err := p.ensureResizeCache(ctx, cachePath, prefetchCardResizeOptions); err != nil {
p.warn("imageproxy: prefetch card variant failed", err)
}
return nil
}
func (p *ImageProxy) RemoveCached(raw string) error {
if !isHTTPish(raw) {
return nil
}
_, cachePath, failPath, err := p.remoteImageCachePaths(raw)
if err != nil {
if _, err := p.validateURL(raw); err != nil {
return nil
}
if err := os.Remove(cachePath); err != nil && !errors.Is(err, os.ErrNotExist) {
return err
var firstErr error
for _, paths := range p.remoteImageCachePathsEveryPool(raw) {
cachePath, failPath := paths[1], paths[2]
if err := os.Remove(cachePath); err != nil && !errors.Is(err, os.ErrNotExist) {
firstErr = err
}
if err := os.Remove(failPath); err != nil && !errors.Is(err, os.ErrNotExist) {
firstErr = err
}
}
if err := os.Remove(failPath); err != nil && !errors.Is(err, os.ErrNotExist) {
return err
}
return nil
return firstErr
}
func (p *ImageProxy) RemoveFailed(raw string) error {
if !isHTTPish(raw) {
return nil
}
_, _, failPath, err := p.remoteImageCachePaths(raw)
if err != nil {
if _, err := p.validateURL(raw); err != nil {
return nil
}
if err := os.Remove(failPath); err != nil && !errors.Is(err, os.ErrNotExist) {
return err
var firstErr error
for _, paths := range p.remoteImageCachePathsEveryPool(raw) {
failPath := paths[2]
if err := os.Remove(failPath); err != nil && !errors.Is(err, os.ErrNotExist) {
firstErr = err
}
}
return nil
return firstErr
}
// Serve writes the requested image to w. Caller is expected to validate
@@ -87,7 +114,17 @@ func (p *ImageProxy) serveRemoteImage(ctx context.Context, w http.ResponseWriter
return err
}
host := strings.ToLower(u.Host)
key, cachePath, failPath := p.remoteImageCachePathsForValidated(raw)
// 已配置的远程 Emby 挂载:把尺寸直接转发给远端生成缩略图,缓存键也用
// 带尺寸的地址,这样不同尺寸各自缓存互不覆盖。
fetchURL := p.upstreamImageFetchURL(raw, opts)
// 尺寸被转发给挂载的远端时,上游返回的就是客户端要的最终尺寸成品,归入
// 成品池长期保留;其他上游返回的是原图,只是生成各种尺寸的原料,归入
// 原图池(小配额 + 短保留)。
pool := imageOriginalCacheSubdir
if fetchURL != raw {
pool = imageRenditionCacheSubdir
}
key, cachePath, failPath := p.remoteImageCachePathsInPool(fetchURL, pool)
forceRefresh := r.URL.Query().Get("refresh") != ""
p.removeUnusableImageCache(cachePath, failPath)
if !forceRefresh && p.serveCachedImage(w, r, key, cachePath, opts) {
@@ -95,7 +132,7 @@ func (p *ImageProxy) serveRemoteImage(ctx context.Context, w http.ResponseWriter
}
// No negative caching: a previously failed fetch is retried on every
// subsequent request, so the image recovers as soon as upstream does.
data, ctype, contentLength, err := p.fetchAndCacheRemoteImageShared(ctx, raw, host, cachePath, failPath)
result, err := p.fetchAndCacheRemoteImageShared(ctx, fetchURL, host, cachePath, failPath)
if err != nil {
if forceRefresh && p.serveCachedImage(w, r, key, cachePath, opts) {
return nil
@@ -111,17 +148,16 @@ func (p *ImageProxy) serveRemoteImage(ctx context.Context, w http.ResponseWriter
if opts.active() && p.serveResizedFromFile(w, r, cachePath, opts) {
return nil
}
w.Header().Set("Content-Type", ctype)
if contentLength != "" {
w.Header().Set("Content-Length", contentLength)
// 缓存目录不可写时的内存兜底:图片只在本次响应里直出,不落盘。
if len(result.data) > 0 {
w.Header().Set("Content-Type", result.contentType)
w.Header().Set("Cache-Control", imageBrowserCacheControl)
http.ServeContent(w, r, key, time.Now(), bytes.NewReader(result.data))
return nil
}
modTime := time.Now()
if stat, err := os.Stat(cachePath); err == nil && stat.Size() > 0 {
modTime = stat.ModTime()
w.Header().Set("ETag", imageFileETag(key, stat))
if !p.serveCachedImage(w, r, key, cachePath, opts) {
serveCachedPlaceholder(w)
}
w.Header().Set("Cache-Control", imageBrowserCacheControl)
http.ServeContent(w, r, key, modTime, bytes.NewReader(data))
return nil
}
@@ -137,64 +173,32 @@ func (p *ImageProxy) serveCachedImage(w http.ResponseWriter, r *http.Request, ke
func (p *ImageProxy) removeUnusableImageCache(cachePath, failPath string) {
// 只读取文件头判断缓存是否可用。旧实现每次命中远程图片缓存都会把整个
// 原图读进内存再丢弃,电视端批量加载海报时会产生大量无意义的磁盘 I/O。
file, err := os.Open(cachePath) // #nosec G304 -- cachePath is SHA-derived under cacheDir.
if err != nil {
if _, err := os.Stat(cachePath); err != nil {
return
}
stat, err := file.Stat()
if err != nil || stat.IsDir() || stat.Size() <= 0 {
_ = file.Close()
if err := cachedImageFileValid(cachePath); err != nil {
_ = os.Remove(cachePath)
_ = os.Remove(failPath)
return
}
headerSize := 512
if stat.Size() < int64(headerSize) {
headerSize = int(stat.Size())
}
header := make([]byte, headerSize)
n, readErr := io.ReadFull(file, header)
_ = file.Close()
if readErr != nil && readErr != io.ErrUnexpectedEOF {
_ = os.Remove(cachePath)
_ = os.Remove(failPath)
return
}
header = header[:n]
// A transparent placeholder is exactly 67 bytes; checking the header alone
// is enough for the normal image cache entries (they are much larger but
// detectContentType only inspects the same leading 512 bytes anyway).
// Close the handle before deleting: Windows refuses to delete an open file.
if n > 0 && isImageContentType(detectContentType(header)) &&
!(n == len(transparent1x1PNG) && bytes.Equal(header, transparent1x1PNG)) {
return
}
_ = os.Remove(cachePath)
_ = os.Remove(failPath)
}
func (p *ImageProxy) fetchAndCacheRemoteImage(ctx context.Context, raw, host, cachePath, failPath string) ([]byte, string, string, error) {
if err := os.MkdirAll(p.cacheDir, 0o750); err != nil {
p.log.Warn("imageproxy: mkdir failed", zap.String("dir", p.cacheDir), zap.Error(err))
return nil, "", "", errImageProxyRequestSetup
}
func (p *ImageProxy) fetchAndCacheRemoteImage(ctx context.Context, raw, host, cachePath, failPath string) (remoteImageFetchResult, error) {
var lastErr error
for _, candidate := range p.remoteImageFetchClients() {
data, ctype, contentLength, err := p.fetchRemoteImageOnce(ctx, raw, host, candidate)
for _, candidate := range p.remoteImageFetchClients(host) {
result, err := p.fetchRemoteImageOnce(ctx, raw, host, candidate, cachePath, failPath)
if err == nil {
p.writeImageCache(cachePath, failPath, "img-*.tmp", data)
return data, ctype, contentLength, nil
return result, nil
}
if errors.Is(err, errImageProxyRequestSetup) {
return nil, "", "", err
return remoteImageFetchResult{}, err
}
lastErr = err
}
if p.canUseExternalImageFallback() && isDoubanImageHost(host) {
data, ctype, contentLength, err := fetchRemoteImageWithCurl(ctx, raw, host)
data, ctype, _, err := fetchRemoteImageWithCurl(ctx, raw, host)
if err == nil {
p.writeImageCache(cachePath, failPath, "img-*.tmp", data)
return data, ctype, contentLength, nil
return remoteImageFetchResult{data: data, contentType: ctype}, nil
}
logImageFetchError(p.log, "imageproxy: curl fallback failed", host, "curl", err)
lastErr = err
@@ -203,41 +207,27 @@ func (p *ImageProxy) fetchAndCacheRemoteImage(ctx context.Context, raw, host, ca
if lastErr == nil {
lastErr = errors.New("upstream image fetch failed")
}
return nil, "", "", redactSensitiveError(lastErr)
}
type sharedRemoteImageResult struct {
data []byte
contentType string
contentLength string
return remoteImageFetchResult{}, redactSensitiveError(lastErr)
}
// fetchAndCacheRemoteImageShared coalesces concurrent requests for the same
// upstream image. A poster can appear in the hero, a shelf and the detail page
// at the same time; without this guard every resize variant may fetch the same
// original before the first cache write finishes.
func (p *ImageProxy) fetchAndCacheRemoteImageShared(ctx context.Context, raw, host, cachePath, failPath string) ([]byte, string, string, error) {
func (p *ImageProxy) fetchAndCacheRemoteImageShared(ctx context.Context, raw, host, cachePath, failPath string) (remoteImageFetchResult, error) {
value, err, _ := p.fetchGroup.Do(cachePath, func() (any, error) {
loadCtx, cancel := context.WithTimeout(context.WithoutCancel(ctx), 45*time.Second)
defer cancel()
data, contentType, contentLength, err := p.fetchAndCacheRemoteImage(loadCtx, raw, host, cachePath, failPath)
if err != nil {
return nil, err
}
return sharedRemoteImageResult{
data: data,
contentType: contentType,
contentLength: contentLength,
}, nil
return p.fetchAndCacheRemoteImage(loadCtx, raw, host, cachePath, failPath)
})
if err != nil {
return nil, "", "", err
return remoteImageFetchResult{}, err
}
result, ok := value.(sharedRemoteImageResult)
result, ok := value.(remoteImageFetchResult)
if !ok {
return nil, "", "", errors.New("upstream image fetch failed")
return remoteImageFetchResult{}, errors.New("upstream image fetch failed")
}
return result.data, result.contentType, result.contentLength, nil
return result, nil
}
// Fetch pulls a remote image and returns bytes plus Content-Type using cache.
@@ -259,13 +249,29 @@ func (p *ImageProxy) Fetch(ctx context.Context, raw string) ([]byte, string, err
}
// No negative caching: a previously failed fetch is retried on every
// subsequent request, so the image recovers as soon as upstream does.
data, ctype, _, err := p.fetchAndCacheRemoteImage(ctx, raw, host, cachePath, failPath)
return data, ctype, err
result, err := p.fetchAndCacheRemoteImage(ctx, raw, host, cachePath, failPath)
if err != nil {
return nil, "", err
}
// 正常路径只落盘,这里按需读回(调用方需要字节)。
if len(result.data) > 0 {
return result.data, result.contentType, nil
}
data, err := os.ReadFile(cachePath) // #nosec G304 -- cachePath is SHA-derived under cacheDir.
if err != nil || len(data) == 0 {
return nil, "", errors.New("cached image is unreadable")
}
return data, detectContentType(data), nil
}
// writeImageCache atomically writes the fetched original. The global mutex is
// deliberately not held: os.CreateTemp already yields a unique name and
// os.Rename is atomic, so the lock only serialized multi-megabyte disk writes
// and made one poster's write block every other image in flight.
func (p *ImageProxy) writeImageCache(cachePath, failPath, pattern string, data []byte) {
p.mu.Lock()
defer p.mu.Unlock()
if err := os.MkdirAll(filepath.Dir(cachePath), 0o750); err != nil {
return
}
tmp, tmpErr := os.CreateTemp(p.cacheDir, pattern)
if tmpErr != nil {
return
+56 -22
View File
@@ -18,23 +18,32 @@ type remoteImageFetchClient struct {
client *http.Client
}
func (p *ImageProxy) remoteImageFetchClients() []remoteImageFetchClient {
func (p *ImageProxy) remoteImageFetchClients(host string) []remoteImageFetchClient {
client := p.client
if client == nil {
client = NewExternalHTTPClient(30 * time.Second)
}
clients := []remoteImageFetchClient{{name: "default", client: client}}
if _, ok := client.Transport.(*http.Transport); ok {
timeout := client.Timeout
if timeout <= 0 {
timeout = 30 * time.Second
}
clients = append(clients, remoteImageFetchClient{
name: "direct",
client: &http.Client{Timeout: timeout, Transport: NewInternalTransport()},
})
if _, ok := client.Transport.(*http.Transport); !ok {
return []remoteImageFetchClient{{name: "default", client: client}}
}
return clients
timeout := client.Timeout
if timeout <= 0 {
timeout = 30 * time.Second
}
direct := p.directClient
if direct == nil {
direct = &http.Client{Timeout: timeout, Transport: NewInternalTransport()}
}
directCandidate := remoteImageFetchClient{name: "direct", client: direct}
defaultCandidate := remoteImageFetchClient{name: "default", client: client}
// Hosts the user configured themselves — remote Emby mounts and their image
// endpoints — are reached over the LAN or a dedicated line. Routing those
// through the OS/env proxy first costs a failed attempt before every single
// image, so try the direct client first for them.
if p.isAllowedRemoteHost(host) {
return []remoteImageFetchClient{directCandidate, defaultCandidate}
}
return []remoteImageFetchClient{defaultCandidate, directCandidate}
}
func (p *ImageProxy) canUseExternalImageFallback() bool {
@@ -45,38 +54,63 @@ func (p *ImageProxy) canUseExternalImageFallback() bool {
return ok
}
func (p *ImageProxy) fetchRemoteImageOnce(ctx context.Context, raw, host string, candidate remoteImageFetchClient) ([]byte, string, string, error) {
// remoteImageFetchResult 是一次成功拉取的结果。正常路径图片已经流式落盘
// (data 为空,调用方从缓存文件下发/缩放);只有缓存目录不可写、退回内存
// 缓冲时才带 data,保证图片仍能发给客户端。
type remoteImageFetchResult struct {
data []byte
contentType string
}
// fetchRemoteImageOnce 拉取一次上游图片并写入 cachePath。响应体直接流式落盘,
// 不再整张读进内存。
func (p *ImageProxy) fetchRemoteImageOnce(ctx context.Context, raw, host string, candidate remoteImageFetchClient, cachePath, failPath string) (remoteImageFetchResult, error) {
req, err := http.NewRequestWithContext(ctx, http.MethodGet, raw, nil)
if err != nil {
p.log.Warn("imageproxy: build request failed", zap.String("url", redactSensitiveURL(raw)), zap.Error(redactSensitiveError(err)))
return nil, "", "", errImageProxyRequestSetup
return remoteImageFetchResult{}, errImageProxyRequestSetup
}
applyRemoteImageHeaders(req, host, raw)
resp, err := candidate.client.Do(req)
if err != nil {
logImageFetchError(p.log, "imageproxy: upstream fetch failed", host, candidate.name, err)
return nil, "", "", err
return remoteImageFetchResult{}, err
}
defer resp.Body.Close()
if resp.StatusCode >= 400 {
p.log.Warn("imageproxy: upstream returned non-OK", zap.String("host", host), zap.String("client", candidate.name), zap.String("status", resp.Status))
return nil, "", "", errors.New("upstream returned " + resp.Status)
return remoteImageFetchResult{}, errors.New("upstream returned " + resp.Status)
}
data, err := io.ReadAll(io.LimitReader(resp.Body, 32<<20))
if err := p.streamImageToCache(cachePath, failPath, resp.Body); err != nil {
if errors.Is(err, errImageCacheUnavailable) {
// 缓存目录不可写:响应体还没读,退回内存缓冲。
return p.bufferRemoteImage(resp, host, candidate.name, cachePath, failPath)
}
logImageFetchError(p.log, "imageproxy: stream image failed", host, candidate.name, err)
return remoteImageFetchResult{}, err
}
return remoteImageFetchResult{}, nil
}
// bufferRemoteImage 在缓存不可用时把响应体读进内存,校验为图片后尽力写入
// 缓存(失败也不影响本次下发)。
func (p *ImageProxy) bufferRemoteImage(resp *http.Response, host, client, cachePath, failPath string) (remoteImageFetchResult, error) {
data, err := io.ReadAll(io.LimitReader(resp.Body, imageProxyMaxDownloadBytes))
if err != nil || len(data) == 0 {
p.log.Warn("imageproxy: read upstream body failed", zap.String("host", host), zap.String("client", candidate.name), zap.Error(redactSensitiveError(err)))
p.log.Warn("imageproxy: read upstream body failed", zap.String("host", host), zap.String("client", client), zap.Error(redactSensitiveError(err)))
if err == nil {
err = errors.New("upstream image body is empty")
}
return nil, "", "", err
return remoteImageFetchResult{}, err
}
ctype, ok := validImageContentType(data)
if !ok {
p.log.Warn("imageproxy: upstream returned non-image content", zap.String("host", host), zap.String("client", candidate.name), zap.String("content_type", resp.Header.Get("Content-Type")))
return nil, "", "", errImageProxyNonImageContent
p.log.Warn("imageproxy: upstream returned non-image content", zap.String("host", host), zap.String("client", client), zap.String("content_type", resp.Header.Get("Content-Type")))
return remoteImageFetchResult{}, errImageProxyNonImageContent
}
return data, ctype, resp.Header.Get("Content-Length"), nil
p.writeImageCache(cachePath, failPath, "img-*.tmp", data)
return remoteImageFetchResult{data: data, contentType: ctype}, nil
}
func logImageFetchError(log *zap.Logger, message, host, client string, err error) {
+188
View File
@@ -0,0 +1,188 @@
package service
import (
"bytes"
"io"
"net/http"
"net/http/httptest"
"net/url"
"os"
"path/filepath"
"sync/atomic"
"testing"
"go.uber.org/zap"
"github.com/truewhile/MeBox/internal/config"
)
// newStreamImageProxy 构造一个允许访问指定测试上游的图片代理。
func newStreamImageProxy(t *testing.T, upstreamURL string) *ImageProxy {
t.Helper()
parsed, err := url.Parse(upstreamURL)
if err != nil {
t.Fatalf("parse upstream url: %v", err)
}
proxy := NewImageProxy(&config.Config{Cache: config.CacheConfig{CacheDir: filepath.Join(t.TempDir(), "cache")}}, zap.NewNop())
proxy.SetAllowedRemoteHostsProvider(func() []string { return []string{parsed.Host} })
return proxy
}
// bigTestJPEG 在合法 JPEG 后面补一串数据,用来验证大图是流式落盘而不是
// 整张读进内存(剧照/原图常有数兆字节)。
func bigTestJPEG(t *testing.T, extraBytes int) []byte {
t.Helper()
out := make([]byte, 0, len(testJPEG)+extraBytes)
out = append(out, testJPEG...)
out = append(out, bytes.Repeat([]byte{0x5a}, extraBytes)...)
return out
}
// TestImageProxyStreamsRemoteImageIntoCacheFile 远程原图必须直接流式写到
// 缓存文件,后续请求由缓存文件服务(上游只被请求一次)。
func TestImageProxyStreamsRemoteImageIntoCacheFile(t *testing.T) {
payload := bigTestJPEG(t, 3<<20)
var calls int32
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
atomic.AddInt32(&calls, 1)
w.Header().Set("Content-Type", "image/jpeg")
_, _ = w.Write(payload)
}))
defer upstream.Close()
proxy := newStreamImageProxy(t, upstream.URL)
raw := upstream.URL + "/poster.jpg"
rec := httptest.NewRecorder()
if err := proxy.Serve(t.Context(), rec, httptest.NewRequest(http.MethodGet, "/api/img", nil), raw); err != nil {
t.Fatalf("Serve failed: %v", err)
}
if rec.Code != http.StatusOK {
t.Fatalf("status = %d, want 200", rec.Code)
}
if !bytes.Equal(rec.Body.Bytes(), payload) {
t.Fatalf("body length = %d, want %d", rec.Body.Len(), len(payload))
}
_, cachePath, failPath := proxy.remoteImageCachePathsForValidated(raw)
stat, err := os.Stat(cachePath)
if err != nil {
t.Fatalf("expected the image to be streamed to %s: %v", cachePath, err)
}
if stat.Size() != int64(len(payload)) {
t.Fatalf("cached size = %d, want %d", stat.Size(), len(payload))
}
if _, err := os.Stat(failPath); err == nil {
t.Fatalf("unexpected failure marker at %s", failPath)
}
if entries, err := os.ReadDir(filepath.Dir(cachePath)); err == nil {
for _, entry := range entries {
if filepath.Ext(entry.Name()) == ".tmp" {
t.Fatalf("temporary file left behind: %s", entry.Name())
}
}
}
// 第二次请求命中缓存文件,不再回源。
second := httptest.NewRecorder()
if err := proxy.Serve(t.Context(), second, httptest.NewRequest(http.MethodGet, "/api/img", nil), raw); err != nil {
t.Fatalf("second Serve failed: %v", err)
}
if !bytes.Equal(second.Body.Bytes(), payload) {
t.Fatal("cached response body mismatch")
}
if got := atomic.LoadInt32(&calls); got != 1 {
t.Fatalf("upstream calls = %d, want 1 (second request must be served from cache)", got)
}
}
// TestImageProxyRejectsNonImageUpstreamWithoutCaching 流式写入必须在提交前
// 校验内容,否则错误页会被永久缓存成图片。
func TestImageProxyRejectsNonImageUpstreamWithoutCaching(t *testing.T) {
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "text/html")
_, _ = w.Write([]byte("<html><body>not an image</body></html>"))
}))
defer upstream.Close()
proxy := newStreamImageProxy(t, upstream.URL)
raw := upstream.URL + "/poster.jpg"
rec := httptest.NewRecorder()
if err := proxy.Serve(t.Context(), rec, httptest.NewRequest(http.MethodGet, "/api/img", nil), raw); err != nil {
t.Fatalf("Serve failed: %v", err)
}
if rec.Body.Len() != len(transparent1x1PNG) {
t.Fatalf("body length = %d, want placeholder %d", rec.Body.Len(), len(transparent1x1PNG))
}
_, cachePath, failPath := proxy.remoteImageCachePathsForValidated(raw)
if _, err := os.Stat(cachePath); err == nil {
t.Fatal("non-image response must not be cached")
}
if _, err := os.Stat(failPath); err != nil {
t.Fatalf("expected a failure marker next to the cache entry: %v", err)
}
}
// TestImageProxyServesRemoteImageWhenCacheDirUnwritable 缓存目录不可写时
// (磁盘只读/满)必须退回内存缓冲,不能让所有图片变成占位图。
func TestImageProxyServesRemoteImageWhenCacheDirUnwritable(t *testing.T) {
payload := testJPEG
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "image/jpeg")
_, _ = w.Write(payload)
}))
defer upstream.Close()
// 把一个普通文件当作目录的父级,MkdirAll 必然失败。
root := t.TempDir()
blocker := filepath.Join(root, "blocker")
if err := os.WriteFile(blocker, []byte("x"), 0o644); err != nil {
t.Fatalf("write blocker: %v", err)
}
proxy := newStreamImageProxy(t, upstream.URL)
proxy.cacheDir = filepath.Join(blocker, "cache", "images")
raw := upstream.URL + "/poster.jpg"
rec := httptest.NewRecorder()
if err := proxy.Serve(t.Context(), rec, httptest.NewRequest(http.MethodGet, "/api/img", nil), raw); err != nil {
t.Fatalf("Serve failed: %v", err)
}
if rec.Code != http.StatusOK {
t.Fatalf("status = %d, want 200", rec.Code)
}
body, err := io.ReadAll(rec.Body)
if err != nil {
t.Fatalf("read body: %v", err)
}
if !bytes.Equal(body, payload) {
t.Fatalf("body length = %d, want %d", len(body), len(payload))
}
}
// TestImageProxyFetchReturnsCachedBytes Fetch 仍需返回字节(刮削写元数据用),
// 内容来自刚写入的缓存文件。
func TestImageProxyFetchReturnsCachedBytes(t *testing.T) {
payload := bigTestJPEG(t, 256<<10)
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "image/jpeg")
_, _ = w.Write(payload)
}))
defer upstream.Close()
proxy := newStreamImageProxy(t, upstream.URL)
raw := upstream.URL + "/poster.jpg"
data, ctype, err := proxy.Fetch(t.Context(), raw)
if err != nil {
t.Fatalf("Fetch failed: %v", err)
}
if !bytes.Equal(data, payload) {
t.Fatalf("fetched %d bytes, want %d", len(data), len(payload))
}
if ctype != "image/jpeg" {
t.Fatalf("content type = %q, want image/jpeg", ctype)
}
}
+63
View File
@@ -0,0 +1,63 @@
package service
import (
"net/url"
"strconv"
"strings"
)
// imageCacheKeyURL normalizes an upstream image URL before it is hashed into a
// disk cache key. Credential query parameters are dropped: a remote Emby token
// is per-account, so removing it cannot make two different images collide, but
// it stops a token rotation from invalidating every cached poster at once.
func imageCacheKeyURL(raw string) string {
u, err := url.Parse(strings.TrimSpace(raw))
if err != nil || u.Host == "" {
return raw
}
q := u.Query()
dropped := false
for key := range q {
switch strings.ToLower(key) {
case "api_key", "apikey", "x-emby-token", "x-mediabrowser-token":
q.Del(key)
dropped = true
}
}
if !dropped {
return raw
}
u.RawQuery = q.Encode()
return u.String()
}
// upstreamImageFetchURL forwards the client's thumbnail request to a configured
// remote Emby mount. The remote server can produce the thumbnail itself from
// maxWidth/maxHeight/quality, so the proxy transfers a few dozen KB instead of
// the full-size original and skips the local decode+scale entirely (measured at
// ~400ms for a single 2892×4096 poster).
//
// Other upstreams (TMDb, Douban, adult sites, ...) do not honour these
// parameters, so their originals are still fetched and scaled locally.
func (p *ImageProxy) upstreamImageFetchURL(raw string, opts imageResizeOptions) string {
if p == nil || !opts.active() {
return raw
}
u, err := url.Parse(raw)
if err != nil || u.Host == "" {
return raw
}
if !p.isAllowedRemoteHost(u.Hostname()) {
return raw
}
q := u.Query()
if opts.MaxWidth > 0 {
q.Set("maxWidth", strconv.Itoa(opts.MaxWidth))
}
if opts.MaxHeight > 0 {
q.Set("maxHeight", strconv.Itoa(opts.MaxHeight))
}
q.Set("quality", strconv.Itoa(opts.encodingQuality()))
u.RawQuery = q.Encode()
return u.String()
}
@@ -0,0 +1,198 @@
package service
import (
"bytes"
"net/http"
"net/http/httptest"
"net/url"
"path/filepath"
"strconv"
"strings"
"sync"
"testing"
"go.uber.org/zap"
"github.com/truewhile/MeBox/internal/config"
)
func newUpstreamImageProxy(t *testing.T, allowedHosts ...string) *ImageProxy {
t.Helper()
proxy := NewImageProxy(&config.Config{Cache: config.CacheConfig{CacheDir: filepath.Join(t.TempDir(), "cache")}}, zap.NewNop())
if len(allowedHosts) > 0 {
proxy.SetAllowedRemoteHostsProvider(func() []string { return allowedHosts })
}
return proxy
}
func TestUpstreamImageFetchURLForwardsResizeToConfiguredMount(t *testing.T) {
proxy := newUpstreamImageProxy(t, "192.168.1.50:8096")
raw := "http://192.168.1.50:8096/emby/Items/abc/Images/Primary?api_key=secret"
got := proxy.upstreamImageFetchURL(raw, imageResizeOptions{MaxWidth: 480, MaxHeight: 600, Quality: 82})
u, err := url.Parse(got)
if err != nil {
t.Fatal(err)
}
q := u.Query()
if q.Get("maxWidth") != "480" || q.Get("maxHeight") != "600" || q.Get("quality") != "82" {
t.Fatalf("forwarded query = %q, want maxWidth=480 maxHeight=600 quality=82", u.RawQuery)
}
if q.Get("api_key") != "secret" {
t.Fatalf("api_key = %q, want the credential preserved", q.Get("api_key"))
}
if u.Path != "/emby/Items/abc/Images/Primary" {
t.Fatalf("path = %q, want the item image path unchanged", u.Path)
}
// The default quality is applied when the client does not send one.
got = proxy.upstreamImageFetchURL(raw, imageResizeOptions{MaxWidth: 160})
if !strings.Contains(got, "quality="+strconv.Itoa(imageResizeDefaultQuality)) {
t.Fatalf("url = %q, want the default encoding quality forwarded", got)
}
}
func TestUpstreamImageFetchURLLeavesOtherUpstreamsAlone(t *testing.T) {
proxy := newUpstreamImageProxy(t, "192.168.1.50:8096")
opts := imageResizeOptions{MaxWidth: 480, MaxHeight: 600, Quality: 82}
// Not a configured mount: TMDb/Douban do not honour these parameters, so the
// proxy must keep fetching their originals and resize locally.
tmdb := "https://image.tmdb.org/t/p/original/poster.jpg"
if got := proxy.upstreamImageFetchURL(tmdb, opts); got != tmdb {
t.Fatalf("url = %q, want %q unchanged", got, tmdb)
}
// Configured mount but no size requested: keep the full original.
mount := "http://192.168.1.50:8096/emby/Items/abc/Images/Primary?api_key=secret"
if got := proxy.upstreamImageFetchURL(mount, imageResizeOptions{}); got != mount {
t.Fatalf("url = %q, want %q unchanged", got, mount)
}
}
func TestRemoteImageCacheKeyIgnoresCredentialRotation(t *testing.T) {
proxy := newUpstreamImageProxy(t)
first := "http://192.168.1.50:8096/emby/Items/abc/Images/Primary?api_key=old-token"
second := "http://192.168.1.50:8096/emby/Items/abc/Images/Primary?api_key=new-token"
_, firstPath, _ := proxy.remoteImageCachePathsForValidated(first)
_, secondPath, _ := proxy.remoteImageCachePathsForValidated(second)
if firstPath != secondPath {
t.Fatalf("token rotation changed the cache key: %q vs %q", firstPath, secondPath)
}
other := "http://192.168.1.50:8096/emby/Items/zzz/Images/Primary?api_key=new-token"
_, otherPath, _ := proxy.remoteImageCachePathsForValidated(other)
if otherPath == secondPath {
t.Fatal("different items must not share a cache key")
}
// A generic `token` parameter can be part of a signed URL's identity, so it
// must stay in the key. Only credential-ish names are dropped.
signed := "http://cdn.example.com/img/1.jpg?token=aaa"
signedOther := "http://cdn.example.com/img/1.jpg?token=bbb"
_, signedPath, _ := proxy.remoteImageCachePathsForValidated(signed)
_, signedOtherPath, _ := proxy.remoteImageCachePathsForValidated(signedOther)
if signedPath == signedOtherPath {
t.Fatal("generic token query parameters must remain part of the cache key")
}
}
func TestRemoteImageFetchClientsPreferDirectForConfiguredMount(t *testing.T) {
proxy := newUpstreamImageProxy(t, "192.168.1.50:8096")
mountClients := proxy.remoteImageFetchClients("192.168.1.50:8096")
if len(mountClients) != 2 || mountClients[0].name != "direct" || mountClients[1].name != "default" {
t.Fatalf("mount client order = %+v, want direct first", clientNames(mountClients))
}
if mountClients[0].client != proxy.directClient {
t.Fatal("direct fetches must reuse the shared no-proxy client")
}
cdnClients := proxy.remoteImageFetchClients("image.tmdb.org")
if len(cdnClients) != 2 || cdnClients[0].name != "default" || cdnClients[1].name != "direct" {
t.Fatalf("cdn client order = %+v, want default first", clientNames(cdnClients))
}
}
func clientNames(clients []remoteImageFetchClient) []string {
out := make([]string, 0, len(clients))
for _, c := range clients {
out = append(out, c.name)
}
return out
}
// TestServeRemoteImageForwardsResizeAndCachesPerSize is the regression test for
// sluggish artwork on mounted Emby libraries: MeBox used to download the remote
// original and scale it locally for every requested size. The size must now be
// forwarded to the mount, and each size must get its own cache entry.
func TestServeRemoteImageForwardsResizeAndCachesPerSize(t *testing.T) {
var mu sync.Mutex
queries := []url.Values{}
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
mu.Lock()
queries = append(queries, r.URL.Query())
mu.Unlock()
w.Header().Set("Content-Type", "image/jpeg")
_, _ = w.Write(testJPEG)
}))
defer upstream.Close()
u, err := url.Parse(upstream.URL)
if err != nil {
t.Fatal(err)
}
proxy := newUpstreamImageProxy(t, u.Host)
raw := upstream.URL + "/emby/Items/abc/Images/Primary?api_key=secret"
serve := func(t *testing.T, query string) *httptest.ResponseRecorder {
t.Helper()
rec := httptest.NewRecorder()
req := httptest.NewRequest(http.MethodGet, "/api/img?"+query, nil)
if err := proxy.Serve(t.Context(), rec, req, raw); err != nil {
t.Fatal(err)
}
if rec.Code != http.StatusOK {
t.Fatalf("status = %d, want 200", rec.Code)
}
return rec
}
rec := serve(t, "maxWidth=480&maxHeight=600&quality=82")
if got := rec.Body.Bytes(); !bytes.Equal(got, testJPEG) {
t.Fatalf("body = %x, want the upstream image", got)
}
mu.Lock()
first := append([]url.Values(nil), queries...)
mu.Unlock()
if len(first) != 1 {
t.Fatalf("upstream calls = %d, want 1", len(first))
}
if first[0].Get("maxWidth") != "480" || first[0].Get("maxHeight") != "600" || first[0].Get("quality") != "82" {
t.Fatalf("upstream query = %q, want the client's thumbnail request forwarded", first[0].Encode())
}
// Same size again: served from the disk cache, no second upstream call.
serve(t, "maxWidth=480&maxHeight=600&quality=82")
mu.Lock()
if len(queries) != 1 {
mu.Unlock()
t.Fatalf("upstream calls = %d, want 1 after a cache hit", len(queries))
}
mu.Unlock()
// A different size must be its own cache entry, not a re-use of the 480px file.
serve(t, "maxWidth=160&quality=60")
mu.Lock()
defer mu.Unlock()
if len(queries) != 2 {
t.Fatalf("upstream calls = %d, want 2 for two distinct sizes", len(queries))
}
if got := queries[1].Get("maxWidth"); got != "160" {
t.Fatalf("second upstream maxWidth = %q, want 160", got)
}
if got := queries[1].Get("quality"); got != "60" {
t.Fatalf("second upstream quality = %q, want 60", got)
}
}
+175 -14
View File
@@ -34,7 +34,16 @@ const (
// N 像素的图在内存中约需 4N 字节;没有上限时,一张异常的超大图
// 就能在多张并发缩略图请求下打爆小内存主机。超过该上限时直接
// 回退为原图直出,宁可不缩放也不冒 OOM 风险。
imageResizeMaxSourcePixels = 30_000_000
//
// 1200 万像素覆盖常见的高清海报(2892×4096 约 1180 万),单张解码
// 峰值约 48MB RGBA;原先的 3000 万在 2 核 2GB 的机器上意味着单张
// 就可能吃掉 120MB 以上,两个并发槽足以触发 OOM/大量换页。
imageResizeMaxSourcePixels = 12_000_000
// imageResizeCheapScaleRatio 是启用低成本插值的缩小比例阈值:目标尺寸
// 小于源图一半时,CatmullRom 的收益肉眼不可见,但耗时和临时缓冲明显
// 更高(电视端海报墙会同时请求几十张缩略图)。
imageResizeCheapScaleRatio = 0.5
// imageResizeCacheSubdir 存放缩放结果,与远程原图缓存分开放,
// 便于单独清理且不与原始字节流缓存互相覆盖。
@@ -156,7 +165,7 @@ func resizeImageData(data []byte, o imageResizeOptions) (out []byte, ctype strin
return nil, "", false, err
}
dst := image.NewRGBA(image.Rect(0, 0, dstW, dstH))
draw.CatmullRom.Scale(dst, dst.Bounds(), src, src.Bounds(), draw.Src, nil)
resizeScaled(dst, src, cfg.Width, cfg.Height)
// 只有可能带透明的源格式才需要逐像素确认,避免 JPEG 的无谓遍历。
// 写实海报的 PNG 通常比等价 JPEG 大一个数量级,因此在确认不含透明
@@ -176,12 +185,42 @@ func resizeImageData(data []byte, o imageResizeOptions) (out []byte, ctype strin
return buf.Bytes(), "image/jpeg", false, nil
}
// isOpaqueImage 逐像素确认图像不含透明像素。
// useCheapScaleInterpolator 报告这次缩放是否该用低成本插值:目标尺寸在宽高
// 两个方向都缩到源图一半以下时,CatmullRom 的额外采样换来的观感差异不可见。
func useCheapScaleInterpolator(dstW, dstH, srcW, srcH int) bool {
if srcW <= 0 || srcH <= 0 || dstW <= 0 || dstH <= 0 {
return false
}
return float64(dstW)/float64(srcW) <= imageResizeCheapScaleRatio &&
float64(dstH)/float64(srcH) <= imageResizeCheapScaleRatio
}
// resizeScaled 把 src 缩放到 dst。大幅缩小时改用低成本插值:CatmullRom
// 与 ApproxBiLinear 在大比例缩小下观感差异看不出来,但前者要遍历更多
// 邻域样本,在 2 核机器上会明显拖慢海报墙的并发缩略图请求。
func resizeScaled(dst *image.RGBA, src image.Image, srcW, srcH int) {
if dst == nil {
return
}
bounds := dst.Bounds()
interp := draw.Interpolator(draw.CatmullRom)
if useCheapScaleInterpolator(bounds.Dx(), bounds.Dy(), srcW, srcH) {
interp = draw.ApproxBiLinear
}
interp.Scale(dst, bounds, src, src.Bounds(), draw.Src, nil)
}
// isOpaqueImage 逐像素确认图像不含透明像素。dst 已知是 *image.RGBA,用
// RGBAAt 直取字段可以避免 At() 的接口分派与颜色模型换算(PNG 海报每次
// 生成缩略图都要走一遍全图扫描)。
func isOpaqueImage(img *image.RGBA) bool {
if img == nil {
return false
}
bounds := img.Bounds()
for y := bounds.Min.Y; y < bounds.Max.Y; y++ {
for x := bounds.Min.X; x < bounds.Max.X; x++ {
if _, _, _, a := img.At(x, y).RGBA(); a != 0xffff {
if img.RGBAAt(x, y).A != 0xff {
return false
}
}
@@ -189,19 +228,91 @@ func isOpaqueImage(img *image.RGBA) bool {
return true
}
// resizeCacheKey 生成缩放结果的缓存键,覆盖源文件身份(路径 + 大小 +
// 修改时间)与全部影响输出的参数,源文件被替换后不会命中陈旧缩略图。
func (o imageResizeOptions) resizeCacheKey(sourceID string, stat os.FileInfo) string {
// resizeSourceKey 生成源图身份键:只覆盖源文件身份(路径 + 大小 + mtime),不含
// 目标尺寸。同一源图的所有尺寸档位共用这个前缀,才能互相列举与派生(小图直接
// 从已缓存的大图缩小,而不是重新解码原图)。
func (o imageResizeOptions) resizeSourceKey(sourceID string, stat os.FileInfo) string {
h := sha256.New()
_, _ = fmt.Fprintf(h, "v1|%s|%dx%d|q%d", sourceID, o.MaxWidth, o.MaxHeight, o.encodingQuality())
_, _ = fmt.Fprintf(h, "v2|%s", sourceID)
if stat != nil {
_, _ = fmt.Fprintf(h, "|%d|%d", stat.Size(), stat.ModTime().UnixNano())
}
return hex.EncodeToString(h.Sum(nil))
}
func (p *ImageProxy) resizeCachePath(key string) string {
return filepath.Join(p.cacheDir, imageResizeCacheSubdir, key+".img")
// resizeCacheKey 是「源图身份 + 档位」的稳定标识,用于 ETag 等需要区分档位的
// 场合(磁盘路径只用源图身份 + 文件名后缀)。
func (o imageResizeOptions) resizeCacheKey(sourceID string, stat os.FileInfo) string {
return o.resizeSourceKey(sourceID, stat) + "." + o.resizeVariantSuffix()
}
func (p *ImageProxy) resizeCachePath(sourceKey string, o imageResizeOptions) string {
return filepath.Join(p.cacheDir, imageResizeCacheSubdir, sourceKey+"."+o.resizeVariantSuffix()+".img")
}
// resizeVariantSuffix 把目标尺寸与质量写进缩放结果的文件名。这样同一源图的
// 各档尺寸可以被列举出来:请求小图时若已有更大的档位缓存,直接从它缩小即可,
// 不必再解码多兆字节的原图(解码 480×600 约 1MB RGBA,解码原图可达数十 MB)。
func (o imageResizeOptions) resizeVariantSuffix() string {
return strconv.Itoa(o.MaxWidth) + "x" + strconv.Itoa(o.MaxHeight) + "q" + strconv.Itoa(o.encodingQuality())
}
// parseResizeVariantSuffix 解析 "<sourceKey>.<w>x<h>q<q>.img" 文件名中的尺寸。
func parseResizeVariantSuffix(name, sourceKey string) (width, height int, ok bool) {
prefix := sourceKey + "."
if !strings.HasPrefix(name, prefix) || !strings.HasSuffix(name, ".img") {
return 0, 0, false
}
spec := strings.TrimSuffix(strings.TrimPrefix(name, prefix), ".img")
dimensions, quality, found := strings.Cut(spec, "q")
if !found {
return 0, 0, false
}
w, h, found := strings.Cut(dimensions, "x")
if !found {
return 0, 0, false
}
width, err := strconv.Atoi(w)
if err != nil || width < 0 {
return 0, 0, false
}
height, err = strconv.Atoi(h)
if err != nil || height < 0 {
return 0, 0, false
}
if _, err := strconv.Atoi(quality); err != nil {
return 0, 0, false
}
return width, height, true
}
// largerCachedVariant 找出同一源图已缓存的、能覆盖目标尺寸的最小档位(宽高
// 都不小于目标)。返回空串表示没有可用的档位,调用方回退到解码原图。
func (p *ImageProxy) largerCachedVariant(key string, o imageResizeOptions) string {
pattern := filepath.Join(p.cacheDir, imageResizeCacheSubdir, key+".*.img")
matches, err := filepath.Glob(pattern)
if err != nil {
return ""
}
best := ""
bestPixels := 0
for _, path := range matches {
width, height, ok := parseResizeVariantSuffix(filepath.Base(path), key)
if !ok {
continue
}
if width == o.MaxWidth && height == o.MaxHeight {
continue // 精确档位,本该在上面就命中
}
if width < o.MaxWidth || height < o.MaxHeight {
continue
}
pixels := width * height
if best == "" || pixels < bestPixels {
best, bestPixels = path, pixels
}
}
return best
}
// acquireResizeSlot bounds CPU-heavy decode/resize work. Returning false means
@@ -265,7 +376,7 @@ func (p *ImageProxy) serveResizedFromFile(w http.ResponseWriter, r *http.Request
// 缓存命中必须发生在读原图和解码之前。否则电视端每次刷新海报墙都会
// 把已经是缩略图缓存的原图重新解码、缩放一遍,造成明显的 CPU 抖动。
key := o.resizeCacheKey(srcPath, stat)
cachePath := p.resizeCachePath(key)
cachePath := p.resizeCachePath(o.resizeSourceKey(srcPath, stat), o)
if serveCachedImageFile(w, r, key, cachePath) {
return true
}
@@ -286,7 +397,15 @@ func (p *ImageProxy) serveResizedFromFile(w http.ResponseWriter, r *http.Request
return true
}
data, err := os.ReadFile(srcPath) // #nosec G304 -- srcPath comes from an allowed local path or a SHA-derived cache path.
// 优先从同一源图已缓存的大尺寸档位缩小:小图(如 160px 模糊占位图)
// 往往能直接由已缓存的卡片图派生,代价从“解码多兆字节原图”降为
// “解码几百 KB 的档位文件”。
sourcePath := srcPath
if derived := p.largerCachedVariant(o.resizeSourceKey(srcPath, stat), o); derived != "" {
sourcePath = derived
}
data, err := os.ReadFile(sourcePath) // #nosec G304 -- srcPath comes from an allowed local path or a SHA-derived cache path.
if err != nil {
return false
}
@@ -306,6 +425,48 @@ func (p *ImageProxy) serveResizedFromFile(w http.ResponseWriter, r *http.Request
return true
}
// ensureResizeCache 在请求路径之外预先生成某档缩略图(刮削预取用)。已存在
// 时直接返回,无需调用方再次解码。
func (p *ImageProxy) ensureResizeCache(ctx context.Context, srcPath string, o imageResizeOptions) error {
if p == nil || !o.active() {
return nil
}
stat, err := os.Stat(srcPath)
if err != nil || stat.IsDir() || stat.Size() <= 0 {
return errors.New("image source unavailable")
}
sourceKey := o.resizeSourceKey(srcPath, stat)
cachePath := p.resizeCachePath(sourceKey, o)
if _, err := os.Stat(cachePath); err == nil {
return nil
}
release, ok := p.acquireResizeSlotFor(ctx, stat.Size())
if !ok {
return errors.New("image resize slot unavailable")
}
defer release()
if _, err := os.Stat(cachePath); err == nil {
return nil
}
sourcePath := srcPath
if derived := p.largerCachedVariant(sourceKey, o); derived != "" {
sourcePath = derived
}
data, err := os.ReadFile(sourcePath) // #nosec G304 -- srcPath is an allowed local path or a SHA-derived cache path.
if err != nil {
return err
}
out, _, unchanged, err := resizeImageData(data, o)
if err != nil {
return err
}
if unchanged {
return nil // 源图已在目标尺寸内,客户端会直接使用原文件。
}
p.writeResizeCache(cachePath, out)
return nil
}
// compactImageSkipBytes 是“直接出原图”的体积上限。超过它的原图(多兆字节
// 的剧照、未压缩 sidecar)仍然走缩放,避免把大文件直接塞给电视端。
// ponytail: 200KB 覆盖这台机器上的典型海报(平均约 100KB);更大的图仍尝试缩放。
@@ -344,14 +505,14 @@ func isCompactWebImage(header []byte) bool {
}
// writeResizeCache 原子写入缩放结果;失败只记日志,不影响本次响应。
// 与 writeImageCache 一样不再持有全局锁:临时文件名唯一、rename 原子,
// 持锁只会把缩略图的写盘和原图的写盘串成一条队。
func (p *ImageProxy) writeResizeCache(cachePath string, data []byte) {
dir := filepath.Dir(cachePath)
if err := os.MkdirAll(dir, 0o750); err != nil {
p.warn("imageproxy: resize cache mkdir failed", err)
return
}
p.mu.Lock()
defer p.mu.Unlock()
tmp, err := os.CreateTemp(dir, "resized-*.tmp")
if err != nil {
p.warn("imageproxy: resize cache temp failed", err)
@@ -0,0 +1,113 @@
package service
import (
"bytes"
"errors"
"image"
"image/color"
"image/jpeg"
"testing"
)
// encodeTestJPEG 生成一张便于压缩的测试用 JPEG(比 PNG 更适合构造大尺寸样本)。
func encodeTestJPEG(t *testing.T, w, h int) []byte {
t.Helper()
img := image.NewRGBA(image.Rect(0, 0, w, h))
for y := 0; y < h; y++ {
for x := 0; x < w; x++ {
img.Set(x, y, color.RGBA{R: uint8(x % 32 * 8), G: uint8(y % 32 * 8), B: 150, A: 255})
}
}
var buf bytes.Buffer
if err := jpeg.Encode(&buf, img, &jpeg.Options{Quality: 70}); err != nil {
t.Fatalf("encode test jpeg: %v", err)
}
return buf.Bytes()
}
// TestResizeImageDataRejectsOverPixelBudget 锁定解码像素预算:超过上限的
// 原图必须放弃缩放(回退原图直出),而不是在小内存主机上尝试解码。
func TestResizeImageDataRejectsOverPixelBudget(t *testing.T) {
// 12_000_000 像素预算之上:3000×5000 = 1500 万。
data := encodeTestJPEG(t, 3000, 5000)
if _, _, _, err := resizeImageData(data, imageResizeOptions{MaxWidth: 400}); !errors.Is(err, errImageResizeTooLarge) {
t.Fatalf("expected errImageResizeTooLarge, got %v", err)
}
}
// TestResizeImageDataAcceptsRealisticPoster 常见高清海报(2892×4096,约
// 1180 万像素)必须仍在预算之内,否则真实海报会退化成直出多兆字节原图。
func TestResizeImageDataAcceptsRealisticPoster(t *testing.T) {
data := encodeTestJPEG(t, 2892, 4096)
out, ctype, unchanged, err := resizeImageData(data, imageResizeOptions{MaxWidth: 480, MaxHeight: 600})
if err != nil {
t.Fatalf("resizeImageData failed: %v", err)
}
if unchanged {
t.Fatal("expected a resized result, got the original bytes")
}
if ctype != "image/jpeg" {
t.Fatalf("content type = %q, want image/jpeg", ctype)
}
cfg, _, err := image.DecodeConfig(bytes.NewReader(out))
if err != nil {
t.Fatalf("decode resized output: %v", err)
}
if cfg.Width != 424 || cfg.Height != 600 {
t.Fatalf("resized to %dx%d, want 424x600", cfg.Width, cfg.Height)
}
}
// TestUseCheapScaleInterpolator 大比例缩小走低成本插值,轻微缩小仍保持高质量。
func TestUseCheapScaleInterpolator(t *testing.T) {
cases := []struct {
name string
dstW, dstH, srcW, srcH int
want bool
}{
{"poster to card", 480, 600, 2892, 4096, true},
{"hero to strip", 480, 320, 1920, 1080, true},
{"exactly half is cheap", 960, 540, 1920, 1080, true},
{"slight shrink", 900, 540, 1000, 600, false},
{"upscale", 1200, 800, 600, 400, false},
{"zero source", 100, 100, 0, 0, false},
}
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
if got := useCheapScaleInterpolator(tc.dstW, tc.dstH, tc.srcW, tc.srcH); got != tc.want {
t.Fatalf("useCheapScaleInterpolator(%d,%d,%d,%d) = %v, want %v",
tc.dstW, tc.dstH, tc.srcW, tc.srcH, got, tc.want)
}
})
}
}
// TestIsOpaqueImageDetectsAlpha 透明度检测:全不透明才允许转 JPEG。
func TestIsOpaqueImageDetectsAlpha(t *testing.T) {
opaque := image.NewRGBA(image.Rect(0, 0, 4, 4))
for y := 0; y < 4; y++ {
for x := 0; x < 4; x++ {
opaque.Set(x, y, color.RGBA{R: 10, G: 20, B: 30, A: 255})
}
}
if !isOpaqueImage(opaque) {
t.Fatal("expected fully opaque image to be reported opaque")
}
withAlpha := image.NewRGBA(image.Rect(0, 0, 4, 4))
for y := 0; y < 4; y++ {
for x := 0; x < 4; x++ {
withAlpha.Set(x, y, color.RGBA{R: 10, G: 20, B: 30, A: 255})
}
}
withAlpha.Set(2, 2, color.RGBA{R: 10, G: 20, B: 30, A: 128})
if isOpaqueImage(withAlpha) {
t.Fatal("expected image with a translucent pixel to be reported non-opaque")
}
if isOpaqueImage(nil) {
t.Fatal("expected nil image to be reported non-opaque")
}
}
@@ -0,0 +1,184 @@
package service
import (
"bytes"
"image"
"net/http"
"net/http/httptest"
"os"
"path/filepath"
"testing"
"time"
"go.uber.org/zap"
)
func TestParseResizeVariantSuffixRoundTrip(t *testing.T) {
opts := imageResizeOptions{MaxWidth: 480, MaxHeight: 600, Quality: 80}
name := "abc123." + opts.resizeVariantSuffix() + ".img"
width, height, ok := parseResizeVariantSuffix(name, "abc123")
if !ok {
t.Fatalf("expected %q to parse", name)
}
if width != 480 || height != 600 {
t.Fatalf("parsed %dx%d, want 480x600", width, height)
}
for _, bad := range []string{"abc123.img", "abc124.480x600q80.img", "abc123.480x600.img", "abc123.axbq80.img"} {
if _, _, ok := parseResizeVariantSuffix(bad, "abc123"); ok {
t.Fatalf("expected %q to be rejected", bad)
}
}
}
func TestLargerCachedVariantPicksSmallestCoveringVariant(t *testing.T) {
proxy := &ImageProxy{cacheDir: filepath.Join(t.TempDir(), "cache"), log: zap.NewNop()}
dir := filepath.Join(proxy.cacheDir, imageResizeCacheSubdir)
if err := os.MkdirAll(dir, 0o750); err != nil {
t.Fatal(err)
}
key := "deadbeef"
writeVariant := func(o imageResizeOptions) string {
path := proxy.resizeCachePath(key, o)
if err := os.WriteFile(path, []byte("x"), 0o600); err != nil {
t.Fatal(err)
}
return path
}
// 更小的档位不能用于派生(会放大),更大的档位里要挑最小的那个。
writeVariant(imageResizeOptions{MaxWidth: 96, Quality: 60})
large := writeVariant(imageResizeOptions{MaxWidth: 1920, MaxHeight: 1080, Quality: 80})
card := writeVariant(imageResizeOptions{MaxWidth: 480, MaxHeight: 600, Quality: 80})
got := proxy.largerCachedVariant(key, imageResizeOptions{MaxWidth: 160, Quality: 60})
if got != card {
t.Fatalf("largerCachedVariant = %q, want the card variant %q", got, card)
}
// 目标尺寸已与大档位相同(甚至更大)时没有可用来源。
if got := proxy.largerCachedVariant(key, imageResizeOptions{MaxWidth: 1920, MaxHeight: 1080, Quality: 80}); got != "" {
t.Fatalf("expected no derivable source when the target equals the only covering variant, got %q", got)
}
if got := proxy.largerCachedVariant(key, imageResizeOptions{MaxWidth: 2400, Quality: 80}); got != "" {
t.Fatalf("expected no derivable source for oversize targets, got %q", got)
}
if large == "" {
t.Fatal("large variant should have been written")
}
}
// TestServeResizedDerivesSmallVariantFromCachedCard 小尺寸档位必须能从已缓存
// 的大尺寸档位派生,而不是每次都重新解码原图。
//
// 验证方式:生成卡片档位后,把原图内容替换成同长度、同 mtime 的非图片数据
// (缓存键不变,但原图已无法解码)。若小图请求仍能返回正确的缩略图,就说明它
// 是从缓存档位派生的;否则只能退回原图直出(此处会失败,因为原图已不是图片)。
func TestServeResizedDerivesSmallVariantFromCachedCard(t *testing.T) {
dir := t.TempDir()
source := filepath.Join(dir, "poster.png")
original := encodeTestPNG(t, 1200, 1800, 255)
if err := os.WriteFile(source, original, 0o644); err != nil {
t.Fatal(err)
}
// 固定 mtime 并读回平台量化后的值,保证替换内容后缓存键不变。
fixed := time.Now().Add(-time.Hour).Truncate(time.Second)
if err := os.Chtimes(source, fixed, fixed); err != nil {
t.Fatal(err)
}
srcStat, err := os.Stat(source)
if err != nil {
t.Fatal(err)
}
proxy := &ImageProxy{cacheDir: filepath.Join(dir, "cache"), log: zap.NewNop()}
card := imageResizeOptions{MaxWidth: 480, MaxHeight: 600, Quality: 80}
cardRec := httptest.NewRecorder()
if !proxy.serveResizedFromFile(cardRec, httptest.NewRequest("GET", "/x?maxWidth=480", nil), source, card) {
t.Fatal("expected the card variant request to be handled")
}
cardCfg, _, err := image.DecodeConfig(bytes.NewReader(cardRec.Body.Bytes()))
if err != nil {
t.Fatalf("decode card variant: %v", err)
}
if cardCfg.Width != 400 || cardCfg.Height != 600 {
t.Fatalf("card variant = %dx%d, want 400x600", cardCfg.Width, cardCfg.Height)
}
// 把原图换成同样长度的非图片数据,并恢复完全相同的 mtime,保持缓存键不变。
garbage := bytes.Repeat([]byte{0x11}, len(original))
if err := os.WriteFile(source, garbage, 0o644); err != nil {
t.Fatal(err)
}
if err := os.Chtimes(source, srcStat.ModTime(), srcStat.ModTime()); err != nil {
t.Fatal(err)
}
tiny := imageResizeOptions{MaxWidth: 160, Quality: 60}
tinyRec := httptest.NewRecorder()
if !proxy.serveResizedFromFile(tinyRec, httptest.NewRequest("GET", "/x?maxWidth=160", nil), source, tiny) {
t.Fatal("expected the tiny variant request to be handled")
}
tinyCfg, _, err := image.DecodeConfig(bytes.NewReader(tinyRec.Body.Bytes()))
if err != nil {
t.Fatalf("decode tiny variant: %v (the request fell back to the placeholder instead of deriving from the cached card)", err)
}
if tinyCfg.Width != 160 || tinyCfg.Height != 240 {
t.Fatalf("tiny variant = %dx%d, want 160x240", tinyCfg.Width, tinyCfg.Height)
}
}
// TestPrefetchCardVariantWarmsResizeCache 刮削预取要顺带生成卡片档位,
// 首个海报墙请求即可命中缩放缓存。
func TestPrefetchCardVariantWarmsResizeCache(t *testing.T) {
payload := encodeTestPNG(t, 1200, 1800, 255)
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "image/png")
_, _ = w.Write(payload)
}))
defer upstream.Close()
proxy := newStreamImageProxy(t, upstream.URL)
raw := upstream.URL + "/poster.png"
if err := proxy.PrefetchCardVariant(t.Context(), raw); err != nil {
t.Fatalf("PrefetchCardVariant failed: %v", err)
}
_, cachePath, _ := proxy.remoteImageCachePathsForValidated(raw)
stat, err := os.Stat(cachePath)
if err != nil {
t.Fatalf("expected the original to be cached: %v", err)
}
variantPath := proxy.resizeCachePath(prefetchCardResizeOptions.resizeSourceKey(cachePath, stat), prefetchCardResizeOptions)
if _, err := os.Stat(variantPath); err != nil {
t.Fatalf("expected the card variant to be pre-generated at %s: %v", variantPath, err)
}
// 预取失败时仍要返回错误(刮削据此保留旧图)。
bad := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusBadGateway)
}))
defer bad.Close()
failing := newStreamImageProxy(t, bad.URL)
if err := failing.PrefetchCardVariant(t.Context(), bad.URL+"/poster.png"); err == nil {
t.Fatal("expected an error for an unreachable candidate image")
}
}
// TestPrefetchCardVariantSurvivesUnresizableImage 上游返回的图无法缩放时,
// 预取仍视为成功(图片可达即可),不能因此让刮削回退到旧图。
func TestPrefetchCardVariantSurvivesUnresizableImage(t *testing.T) {
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "image/jpeg")
_, _ = w.Write(testJPEG)
}))
defer upstream.Close()
proxy := newStreamImageProxy(t, upstream.URL)
if err := proxy.PrefetchCardVariant(t.Context(), upstream.URL+"/cover.jpg"); err != nil {
t.Fatalf("PrefetchCardVariant failed: %v", err)
}
}
+291
View File
@@ -0,0 +1,291 @@
// Package service — TheIntroDB client.
//
// TheIntroDB (https://theintrodb.org) is a community database of "skip"
// timestamps: intro, recap, end credits and previews. Reads are public and
// need no API key, which is what makes it usable as an automatic filler for
// the player's 跳过片头/片尾 feature.
package service
import (
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"strconv"
"strings"
"time"
"go.uber.org/zap"
)
const (
// IntroDBBaseURL is the public read endpoint. Overridable on the service
// for tests and for pointing at a mirror.
IntroDBBaseURL = "https://api.theintrodb.org/v3"
// IntroDBSource tags rows that came from this provider.
IntroDBSource = "theintrodb"
introDBTimeout = 8 * time.Second
introDBMaxBodySize = 1 << 20
// introDBMaxAttempts 是一次 Fetch 允许的请求次数(原请求 + 1 次重试)。
// 实测:短时间连发 45 个请求有 15 个被返回 429,加 1.2 秒间隔重试后
// 其中 10 个成功,所以限流是真实存在的、值得一次重试。
introDBMaxAttempts = 2
// introDBRetryDelay 是服务端没给 Retry-After 时的默认重试间隔。
introDBRetryDelay = time.Second
// introDBMaxRetryDelay 限制服务端要求的等待时间:一次播放不值得为它
// 挂住几十秒,等待超过这个值就按这个值等(然后可能再次被限流)。
introDBMaxRetryDelay = 3 * time.Second
)
// IntroDBSpan is one resolved skip range, still in provider terms.
// EndMs == 0 means "runs to the end of the media" (TheIntroDB returns
// end_ms: null for end credits); the caller resolves it against the duration.
type IntroDBSpan struct {
Kind string
StartMs int64
EndMs int64
}
// IntroDBService queries TheIntroDB for one media item.
type IntroDBService struct {
log *zap.Logger
client *http.Client
baseURL string
retryDelay time.Duration
}
// NewIntroDBService is the constructor. The client honours environment and OS
// proxy settings so it behaves like the other third-party API clients.
func NewIntroDBService(log *zap.Logger) *IntroDBService {
return &IntroDBService{
log: log,
client: NewExternalHTTPClient(introDBTimeout),
baseURL: IntroDBBaseURL,
retryDelay: introDBRetryDelay,
}
}
// SetBaseURL overrides the API root (tests, mirrors).
func (s *IntroDBService) SetBaseURL(base string) *IntroDBService {
if s != nil && strings.TrimSpace(base) != "" {
s.baseURL = strings.TrimRight(strings.TrimSpace(base), "/")
}
return s
}
// SetRetryDelay overrides the wait between attempts. Tests set it to 0 so a
// retry does not really sleep.
func (s *IntroDBService) SetRetryDelay(delay time.Duration) *IntroDBService {
if s != nil {
s.retryDelay = delay
}
return s
}
// introDBRange mirrors one entry of a segment array. start_ms/end_ms are
// pointers because the API distinguishes null (= open-ended) from 0.
type introDBRange struct {
StartMs *int64 `json:"start_ms"`
EndMs *int64 `json:"end_ms"`
}
type introDBResponse struct {
TMDbID int `json:"tmdb_id"`
Type string `json:"type"`
Intro []introDBRange `json:"intro"`
Recap []introDBRange `json:"recap"`
Credits []introDBRange `json:"credits"`
Preview []introDBRange `json:"preview"`
}
// Fetch returns the skip ranges TheIntroDB knows about. A 404 means the
// database simply has nothing for this title, which is not an error: the
// caller records it as a negative cache entry.
//
// season/episode are required for TV; pass 0/0 for movies.
//
// 429/503 会重试一次(社区库在短时间连发下确实会限流)。重试前会先确认调用方
// 的 deadline 还够用;预算不够就直接返回错误,让调用方保留自己的缓存,
// 把「拿不到片段」维持在「少一个跳过按钮」的量级。
func (s *IntroDBService) Fetch(ctx context.Context, tmdbID, season, episode int) ([]IntroDBSpan, error) {
if s == nil || s.client == nil {
return nil, errors.New("introdb service nil")
}
if tmdbID <= 0 {
return nil, nil
}
endpoint := s.mediaURL(tmdbID, season, episode)
for attempt := 1; ; attempt++ {
result := s.fetchOnce(ctx, endpoint)
if result.err == nil {
return result.spans, nil
}
if !result.retryable || attempt >= introDBMaxAttempts {
return nil, result.err
}
if !waitForIntroDBRetry(ctx, s.retryWait(result.retryAfter)) {
return nil, result.err
}
}
}
// introDBFetchAttempt 是一次请求的结果:数据或错误,外加「值不值得重试」。
type introDBFetchAttempt struct {
spans []IntroDBSpan
err error
retryable bool
retryAfter time.Duration
}
func (s *IntroDBService) fetchOnce(ctx context.Context, endpoint string) introDBFetchAttempt {
req, err := http.NewRequestWithContext(ctx, http.MethodGet, endpoint, nil)
if err != nil {
return introDBFetchAttempt{err: err}
}
req.Header.Set("Accept", "application/json")
resp, err := s.client.Do(req)
if err != nil {
return introDBFetchAttempt{err: err}
}
defer func() { _ = resp.Body.Close() }()
switch {
case resp.StatusCode == http.StatusNotFound:
// 「查到但社区库里没有」不是错误,调用方据此写负缓存。
return introDBFetchAttempt{}
case resp.StatusCode < 200 || resp.StatusCode >= 300:
return introDBFetchAttempt{
err: fmt.Errorf("introdb: unexpected status %d", resp.StatusCode),
retryable: introDBRetryableStatus(resp.StatusCode),
retryAfter: parseIntroDBRetryAfter(resp.Header.Get("Retry-After")),
}
}
body, err := io.ReadAll(io.LimitReader(resp.Body, introDBMaxBodySize))
if err != nil {
return introDBFetchAttempt{err: err}
}
spans, err := parseIntroDBResponse(body)
if err != nil {
return introDBFetchAttempt{err: err}
}
return introDBFetchAttempt{spans: spans}
}
// introDBRetryableStatus 只认明确的「稍后再来」状态。500 之类的服务端故障
// 重试也不会变好,却会白占调用方的等待预算。
func introDBRetryableStatus(status int) bool {
switch status {
case http.StatusTooManyRequests, http.StatusServiceUnavailable:
return true
default:
return false
}
}
// parseIntroDBRetryAfter 解析 Retry-After 的秒数形式;HTTP-date 形式在限流
// 场景很少见,解析不出来就退回默认间隔。
func parseIntroDBRetryAfter(value string) time.Duration {
seconds, err := strconv.Atoi(strings.TrimSpace(value))
if err != nil || seconds <= 0 {
return 0
}
return time.Duration(seconds) * time.Second
}
func (s *IntroDBService) retryWait(retryAfter time.Duration) time.Duration {
wait := retryAfter
if wait <= 0 {
wait = s.retryDelay
}
if wait > introDBMaxRetryDelay {
wait = introDBMaxRetryDelay
}
return wait
}
// waitForIntroDBRetry 睡到重试时刻,或调用方的 ctx 先结束。返回 false 表示
// 预算已经用完,调用方不该再等。
func waitForIntroDBRetry(ctx context.Context, wait time.Duration) bool {
if ctx.Err() != nil {
return false
}
if wait <= 0 {
return true
}
timer := time.NewTimer(wait)
defer timer.Stop()
select {
case <-timer.C:
return true
case <-ctx.Done():
return false
}
}
func (s *IntroDBService) mediaURL(tmdbID, season, episode int) string {
var b strings.Builder
b.WriteString(s.baseURL)
b.WriteString("/media?tmdb_id=")
b.WriteString(strconv.Itoa(tmdbID))
// TheIntroDB 对剧集必须带 season+episode,只给 tmdb_id 会返回 404。
if season > 0 && episode > 0 {
b.WriteString("&season=")
b.WriteString(strconv.Itoa(season))
b.WriteString("&episode=")
b.WriteString(strconv.Itoa(episode))
}
return b.String()
}
// parseIntroDBResponse flattens the per-type arrays into spans, preserving the
// intro -> recap -> credits -> preview order so the player sees the earliest
// range first.
func parseIntroDBResponse(body []byte) ([]IntroDBSpan, error) {
var raw introDBResponse
if err := json.Unmarshal(body, &raw); err != nil {
return nil, fmt.Errorf("parse introdb json: %w", err)
}
groups := []struct {
kind string
ranges []introDBRange
}{
{"intro", raw.Intro},
{"recap", raw.Recap},
{"credits", raw.Credits},
{"preview", raw.Preview},
}
spans := make([]IntroDBSpan, 0, len(raw.Intro)+len(raw.Credits))
for _, group := range groups {
for _, r := range group.ranges {
var start int64
if r.StartMs != nil {
start = *r.StartMs
}
var end int64
if r.EndMs != nil {
end = *r.EndMs
}
if start < 0 {
start = 0
}
// end == 0 表示「延续到片尾」,是合法值;其余情况 end 必须大于 start,
// 否则这段区间没有任何可跳过的内容,直接丢弃避免在播放器里出现空按钮。
if end != 0 && end <= start {
continue
}
spans = append(spans, IntroDBSpan{Kind: group.kind, StartMs: start, EndMs: end})
}
}
return spans, nil
}
// logIntroDBFailure 只在 debug 级别记录,避免社区库不可达时把日志刷满。
func logIntroDBFailure(log *zap.Logger, tmdbID int, err error) {
if log == nil || err == nil {
return
}
log.Debug("introdb lookup failed", zap.Int("tmdb_id", tmdbID), zap.Error(err))
}
+304
View File
@@ -0,0 +1,304 @@
package service
import (
"context"
"net/http"
"net/http/httptest"
"sync/atomic"
"testing"
"time"
"go.uber.org/zap"
)
// 这两段响应是从 api.theintrodb.org/v3/media 实测抓下来的原文,
// 用来锁住 null 语义:start_ms: null = 从片头开始,end_ms: null = 一直到片尾。
const (
introDBTVPayload = `{"tmdb_id":1396,"type":"tv","season":1,"episode":1,"intro":[{"start_ms":228664,"end_ms":246143}],"credits":[{"start_ms":3431000,"end_ms":null}]}`
introDBMoviePayload = `{"tmdb_id":27205,"type":"movie","intro":[{"start_ms":null,"end_ms":38000}]}`
)
func TestParseIntroDBResponseResolvesNullBounds(t *testing.T) {
spans, err := parseIntroDBResponse([]byte(introDBTVPayload))
if err != nil {
t.Fatalf("parse: %v", err)
}
if len(spans) != 2 {
t.Fatalf("spans = %d, want 2 (%#v)", len(spans), spans)
}
if spans[0].Kind != "intro" || spans[0].StartMs != 228_664 || spans[0].EndMs != 246_143 {
t.Fatalf("intro span = %#v", spans[0])
}
// end_ms: null 表示一直到片尾,落成 0 由客户端结合时长补齐。
if spans[1].Kind != "credits" || spans[1].StartMs != 3_431_000 || spans[1].EndMs != 0 {
t.Fatalf("credits span = %#v", spans[1])
}
movie, err := parseIntroDBResponse([]byte(introDBMoviePayload))
if err != nil {
t.Fatalf("parse movie: %v", err)
}
if len(movie) != 1 {
t.Fatalf("movie spans = %d, want 1", len(movie))
}
// start_ms: null = 从片头开始。
if movie[0].StartMs != 0 || movie[0].EndMs != 38_000 {
t.Fatalf("movie intro span = %#v", movie[0])
}
}
func TestParseIntroDBResponseDropsEmptyRanges(t *testing.T) {
body := `{"tmdb_id":1,"type":"movie",
"intro":[{"start_ms":5000,"end_ms":5000},{"start_ms":9000,"end_ms":8000},{"start_ms":1000,"end_ms":2000}],
"recap":[],"credits":[],"preview":[]}`
spans, err := parseIntroDBResponse([]byte(body))
if err != nil {
t.Fatalf("parse: %v", err)
}
// 只有 end > start 的区间是可跳过的;end == 0(到片尾)是合法值,此处不涉及。
if len(spans) != 1 || spans[0].StartMs != 1_000 || spans[0].EndMs != 2_000 {
t.Fatalf("spans = %#v, want only the 1000-2000 range", spans)
}
}
func TestParseIntroDBResponseOrdersByType(t *testing.T) {
body := `{"tmdb_id":1,"type":"tv","credits":[{"start_ms":900,"end_ms":1000}],
"intro":[{"start_ms":100,"end_ms":200}],"recap":[{"start_ms":50,"end_ms":60}]}`
spans, err := parseIntroDBResponse([]byte(body))
if err != nil {
t.Fatalf("parse: %v", err)
}
want := []string{"intro", "recap", "credits"}
if len(spans) != len(want) {
t.Fatalf("spans = %#v, want %d", spans, len(want))
}
for i, kind := range want {
if spans[i].Kind != kind {
t.Fatalf("span[%d].kind = %q, want %q", i, spans[i].Kind, kind)
}
}
}
func TestIntroDBMediaURLOnlyAddsSeasonEpisodeForTV(t *testing.T) {
svc := NewIntroDBService(zap.NewNop())
if got, want := svc.mediaURL(1396, 1, 1),
"https://api.theintrodb.org/v3/media?tmdb_id=1396&season=1&episode=1"; got != want {
t.Fatalf("tv url = %q, want %q", got, want)
}
// 电影(season/episode 为 0)不能带季集参数,否则会被当成剧集查不到。
if got, want := svc.mediaURL(27205, 0, 0),
"https://api.theintrodb.org/v3/media?tmdb_id=27205"; got != want {
t.Fatalf("movie url = %q, want %q", got, want)
}
}
func TestIntroDBFetchTreatsNotFoundAsNoData(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
w.WriteHeader(http.StatusNotFound)
}))
defer server.Close()
svc := NewIntroDBService(zap.NewNop()).SetBaseURL(server.URL)
spans, err := svc.Fetch(t.Context(), 999_999, 1, 1)
if err != nil {
t.Fatalf("404 must not be an error, got %v", err)
}
if len(spans) != 0 {
t.Fatalf("spans = %#v, want none", spans)
}
}
func TestIntroDBFetchReportsUnexpectedStatus(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
w.WriteHeader(http.StatusInternalServerError)
}))
defer server.Close()
svc := NewIntroDBService(zap.NewNop()).SetBaseURL(server.URL)
if _, err := svc.Fetch(t.Context(), 1, 0, 0); err == nil {
t.Fatal("500 should surface as an error so the caller can keep its cache")
}
}
func TestIntroDBFetchSkipsRequestWithoutTMDbID(t *testing.T) {
calls := 0
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
calls++
_, _ = w.Write([]byte(introDBMoviePayload))
}))
defer server.Close()
svc := NewIntroDBService(zap.NewNop()).SetBaseURL(server.URL)
spans, err := svc.Fetch(t.Context(), 0, 0, 0)
if err != nil {
t.Fatalf("fetch: %v", err)
}
if len(spans) != 0 || calls != 0 {
t.Fatalf("spans = %#v calls = %d, want no request without a tmdb id", spans, calls)
}
}
func TestIntroDBFetchParsesBody(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if got := r.URL.Query().Get("tmdb_id"); got != "1396" {
t.Errorf("tmdb_id = %q, want 1396", got)
}
if got := r.URL.Query().Get("season"); got != "1" {
t.Errorf("season = %q, want 1", got)
}
if got := r.URL.Query().Get("episode"); got != "1" {
t.Errorf("episode = %q, want 1", got)
}
w.Header().Set("Content-Type", "application/json")
_, _ = w.Write([]byte(introDBTVPayload))
}))
defer server.Close()
svc := NewIntroDBService(zap.NewNop()).SetBaseURL(server.URL)
spans, err := svc.Fetch(t.Context(), 1396, 1, 1)
if err != nil {
t.Fatalf("fetch: %v", err)
}
if len(spans) != 2 || spans[0].Kind != "intro" {
t.Fatalf("spans = %#v", spans)
}
}
// 实测:从生产机连发 45 个请求有 15 个被返回 429,加间隔重试后其中 10 个成功。
// 所以限流值得一次重试,否则那部分播放会静默少掉「跳过片头」按钮。
func TestIntroDBFetchRetriesRateLimit(t *testing.T) {
var calls int32
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
if atomic.AddInt32(&calls, 1) == 1 {
w.WriteHeader(http.StatusTooManyRequests)
return
}
w.Header().Set("Content-Type", "application/json")
_, _ = w.Write([]byte(introDBTVPayload))
}))
defer server.Close()
svc := NewIntroDBService(zap.NewNop()).SetBaseURL(server.URL).SetRetryDelay(0)
spans, err := svc.Fetch(t.Context(), 1396, 1, 1)
if err != nil {
t.Fatalf("fetch: %v", err)
}
if len(spans) != 2 {
t.Fatalf("spans = %#v, want the retried response", spans)
}
if got := atomic.LoadInt32(&calls); got != 2 {
t.Fatalf("calls = %d, want 2 (the original plus one retry)", got)
}
}
func TestIntroDBFetchGivesUpAfterRetryBudget(t *testing.T) {
var calls int32
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
atomic.AddInt32(&calls, 1)
w.WriteHeader(http.StatusTooManyRequests)
}))
defer server.Close()
svc := NewIntroDBService(zap.NewNop()).SetBaseURL(server.URL).SetRetryDelay(0)
if _, err := svc.Fetch(t.Context(), 1396, 1, 1); err == nil {
t.Fatal("a persistent 429 must surface as an error so the caller keeps its cache")
}
// 只重试一次:限流通常不是靠密集重试解决的,而调用方的等待预算有限。
if got := atomic.LoadInt32(&calls); got != 2 {
t.Fatalf("calls = %d, want 2 (one retry, then give up)", got)
}
}
func TestIntroDBFetchDoesNotRetryNotFound(t *testing.T) {
var calls int32
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
atomic.AddInt32(&calls, 1)
w.WriteHeader(http.StatusNotFound)
}))
defer server.Close()
svc := NewIntroDBService(zap.NewNop()).SetBaseURL(server.URL).SetRetryDelay(0)
spans, err := svc.Fetch(t.Context(), 424242, 0, 0)
if err != nil || len(spans) != 0 {
t.Fatalf("spans = %#v err = %v, want a cached miss", spans, err)
}
if got := atomic.LoadInt32(&calls); got != 1 {
t.Fatalf("calls = %d, want 1: 404 means \"no data\", it is not worth retrying", got)
}
}
// 调用方预算不够时不能为了重试干等:Emby 只给 5 秒,等下去会把
// 「少一个跳过按钮」升级成「请求超时」。
func TestIntroDBFetchSkipsRetryWhenCallerBudgetIsSpent(t *testing.T) {
var calls int32
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
atomic.AddInt32(&calls, 1)
w.WriteHeader(http.StatusTooManyRequests)
}))
defer server.Close()
svc := NewIntroDBService(zap.NewNop()).SetBaseURL(server.URL).SetRetryDelay(time.Minute)
ctx, cancel := context.WithTimeout(t.Context(), 50*time.Millisecond)
defer cancel()
started := time.Now()
if _, err := svc.Fetch(ctx, 1396, 1, 1); err == nil {
t.Fatal("want an error when the budget is spent")
}
if elapsed := time.Since(started); elapsed > 2*time.Second {
t.Fatalf("Fetch waited %s, want it to give up promptly", elapsed)
}
if got := atomic.LoadInt32(&calls); got != 1 {
t.Fatalf("calls = %d, want 1 without a retry", got)
}
}
func TestIntroDBRetryWaitPrefersRetryAfterHeader(t *testing.T) {
svc := NewIntroDBService(zap.NewNop())
if got := svc.retryWait(2 * time.Second); got != 2*time.Second {
t.Fatalf("retryWait(2s) = %s, want the server's value", got)
}
if got := svc.retryWait(0); got != introDBRetryDelay {
t.Fatalf("retryWait(0) = %s, want the default %s", got, introDBRetryDelay)
}
// 服务端可以要求等很久,但一次播放不值得为它挂住几十秒。
if got := svc.retryWait(10 * time.Minute); got != introDBMaxRetryDelay {
t.Fatalf("retryWait(10m) = %s, want it capped at %s", got, introDBMaxRetryDelay)
}
}
func TestParseIntroDBRetryAfter(t *testing.T) {
cases := []struct {
value string
want time.Duration
}{
{"2", 2 * time.Second},
{" 3 ", 3 * time.Second},
{"", 0},
{"abc", 0},
{"-5", 0},
{"0", 0},
}
for _, tc := range cases {
if got := parseIntroDBRetryAfter(tc.value); got != tc.want {
t.Fatalf("parseIntroDBRetryAfter(%q) = %s, want %s", tc.value, got, tc.want)
}
}
}
func TestIntroDBRetryableStatus(t *testing.T) {
retryable := []int{http.StatusTooManyRequests, http.StatusServiceUnavailable}
for _, status := range retryable {
if !introDBRetryableStatus(status) {
t.Fatalf("status %d should be retryable", status)
}
}
// 404 由 fetchOnce 单独处理;500 之类的服务端故障重试也不会变好,
// 却会白占调用方的等待预算。
notRetryable := []int{http.StatusNotFound, http.StatusInternalServerError, http.StatusBadRequest}
for _, status := range notRetryable {
if introDBRetryableStatus(status) {
t.Fatalf("status %d should not be retryable", status)
}
}
}
+2 -2
View File
@@ -199,7 +199,7 @@ func TestManualSearchFallsBackToMovieFolderForGenericQuery(t *testing.T) {
http.NotFound(w, r)
return
}
if r.URL.Query().Get("query") != "inception" {
if !strings.EqualFold(r.URL.Query().Get("query"), "inception") {
_ = json.NewEncoder(w).Encode(map[string]any{"results": []any{}})
return
}
@@ -248,7 +248,7 @@ func TestManualSearchFallsBackToMovieFolderForGenericQuery(t *testing.T) {
if len(results) != 1 || results[0].TMDbID != 27205 {
t.Fatalf("manual search results=%#v, want folder fallback candidate; queries=%v", results, queries)
}
if len(queries) < 2 || queries[0] != "00000" || queries[len(queries)-1] != "inception" {
if len(queries) < 2 || queries[0] != "00000" || !strings.EqualFold(queries[len(queries)-1], "inception") {
t.Fatalf("manual search queries=%v, want explicit query then folder fallback", queries)
}
}
+17
View File
@@ -32,10 +32,26 @@ func (s *MediaService) mediaListCacheKey(libraryID string, libraryIDs []string,
strings.Join(allowed, ","),
strings.Join(hidden, ","),
filter.SeriesID,
filterFingerprint(filter),
}, "|")))
return "media:list:" + hex.EncodeToString(sum[:])
}
// filterFingerprint 把影响结果的筛选维度序列化成稳定字符串。
//
// 缓存键必须覆盖所有会改变结果的过滤条件:漏一个就会出现「先打开未筛选列表,
// 再筛选时命中旧缓存」这类脏读(返回不带筛选的数据)。新增过滤字段时只改这里。
func filterFingerprint(filter repository.MediaQueryFilter) string {
genres := append([]string(nil), filter.Genres...)
sort.Strings(genres)
return strings.Join([]string{
"genres=" + strings.Join(genres, ","),
fmt.Sprintf("year=%d-%d", filter.YearMin, filter.YearMax),
fmt.Sprintf("rating=%.2f", filter.RatingMin),
fmt.Sprintf("unwatched=%t:%s", filter.UnwatchedOnly, filter.UnwatchedUserID),
}, "&")
}
func (s *MediaService) libraryPreviewCacheKey(libraries []model.Library, cardLimit int, filter repository.MediaQueryFilter, includeCounts bool) string {
libIDs := make([]string, len(libraries))
for i, lib := range libraries {
@@ -138,6 +154,7 @@ func (s *MediaService) groupedItemsCacheKey(libraryID string, libraryIDs []strin
strings.Join(allowed, ","),
strings.Join(hidden, ","),
filter.SeriesID,
filterFingerprint(filter),
})
}
+582
View File
@@ -0,0 +1,582 @@
package service
import (
"context"
"sort"
"strings"
"go.uber.org/zap"
"gorm.io/gorm"
"github.com/truewhile/MeBox/internal/model"
"github.com/truewhile/MeBox/internal/repository"
)
// MediaDiscoveryService 提供「发现类」查询:类型聚合、下一集、相似内容。
//
// 它只负责候选集的选取,不产出 Emby DTO —— DTO 形状必须由 EmbyService 统一
// 提供,否则同一部剧在 /Items 与 /Shows/NextUp 上会长得不一样。同理,这里
// 只接受调用方传入的 MediaVisibility,不自己解析用户权限。
type MediaDiscoveryService struct {
log *zap.Logger
repo *repository.Container
}
// GenreCount 是类型聚合结果。Name 保留首次出现时的写法(大小写与全半角
// 均按原样展示),计数则不区分大小写。
type GenreCount struct {
Name string `json:"name"`
Count int `json:"count"`
}
// NewMediaDiscoveryService 构建发现服务。
func NewMediaDiscoveryService(log *zap.Logger, repo *repository.Container) *MediaDiscoveryService {
return &MediaDiscoveryService{log: log, repo: repo}
}
// mediaFilterFromVisibility 把可见性翻译成仓储过滤条件。所有发现类查询都必须
// 经过这里,避免某一处忘记过滤 NSFW 或受限媒体库。
func mediaFilterFromVisibility(visibility MediaVisibility) repository.MediaQueryFilter {
return repository.MediaQueryFilter{
IncludeNSFW: visibility.IncludeNSFW,
AllowedLibraryIDs: visibility.AllowedLibraryIDs,
HiddenLibraryIDs: visibility.HiddenLibraryIDs,
}
}
// AggregateGenres 统计可见媒体的类型分布。libraryID 非空时只统计该库,
// 供媒体库页的筛选项与 Emby /Genres 共用。
func (s *MediaDiscoveryService) AggregateGenres(ctx context.Context, visibility MediaVisibility, libraryID string) ([]GenreCount, error) {
if s == nil || s.repo == nil || s.repo.Media == nil {
return nil, nil
}
filter := mediaFilterFromVisibility(visibility)
filter.LibraryID = strings.TrimSpace(libraryID)
raw, err := s.repo.Media.ListGenreValues(ctx, filter)
if err != nil {
return nil, err
}
return countGenres(raw), nil
}
// countGenres 切分并计数。大小写不同的同名类型合并计数,展示名取首次出现的
// 写法;结果按 count 降序、同数按名称升序,保证输出稳定可测。
func countGenres(values []string) []GenreCount {
counts := make(map[string]int)
display := make(map[string]string)
for _, value := range values {
for _, name := range SplitGenreList(value) {
key := strings.ToLower(name)
if _, seen := display[key]; !seen {
display[key] = name
}
counts[key]++
}
}
out := make([]GenreCount, 0, len(counts))
for key, count := range counts {
out = append(out, GenreCount{Name: display[key], Count: count})
}
sort.Slice(out, func(i, j int) bool {
if out[i].Count != out[j].Count {
return out[i].Count > out[j].Count
}
return out[i].Name < out[j].Name
})
return out
}
// SplitGenreList 切分逗号分隔的类型字段。
//
// 刮削来源既有英文逗号也有中文全角逗号,且常见首尾空格,因此三种分隔符都要
// 处理,并丢弃空段。
func SplitGenreList(value string) []string {
if strings.TrimSpace(value) == "" {
return nil
}
parts := strings.FieldsFunc(value, func(r rune) bool {
return r == ',' || r == ',' || r == '、' || r == ';' || r == ';'
})
out := make([]string, 0, len(parts))
for _, part := range parts {
if trimmed := strings.TrimSpace(part); trimmed != "" {
out = append(out, trimmed)
}
}
return out
}
// genreSet 把类型字段转成小写集合,用于相似度计算。
func genreSet(value string) map[string]struct{} {
names := SplitGenreList(value)
if len(names) == 0 {
return nil
}
out := make(map[string]struct{}, len(names))
for _, name := range names {
out[strings.ToLower(name)] = struct{}{}
}
return out
}
// genreOverlap 返回两个类型集合的交集大小。
func genreOverlap(a, b map[string]struct{}) int {
if len(a) == 0 || len(b) == 0 {
return 0
}
// 遍历较小的集合,减少比较次数。
if len(b) < len(a) {
a, b = b, a
}
count := 0
for name := range a {
if _, ok := b[name]; ok {
count++
}
}
return count
}
// mediaIsEpisode 判断一行 media 是否属于「剧集」维度。
//
// 与 Emby 的判定保持一致(季号或集号大于 0),但不依赖 library type:同一个
// 库既可能放电影也可能放剧集,用编号判断更贴近实际数据。
func mediaIsEpisode(m *model.Media) bool {
return m != nil && (m.SeasonNum > 0 || m.EpisodeNum > 0)
}
// seriesGroupKey 是「同一部剧」的归并键。SeriesID 优先;缺省时退回
// (库, 标题),这样未刮削的剧集也能归到一组而不是每条历史各算一部剧。
func seriesGroupKey(m *model.Media) string {
if m == nil {
return ""
}
if key := strings.TrimSpace(m.SeriesID); key != "" {
return "sid:" + key
}
if !mediaIsEpisode(m) {
return ""
}
return "lib:" + m.LibraryID + "|title:" + strings.ToLower(strings.TrimSpace(m.Title))
}
// nextUpHistoryScanLimit 是扫描播放历史的上限。历史按最近观看倒序取,
// 因此截断只会丢掉「很久没看且排在很后面」的剧,不会影响首页前排。
const nextUpHistoryScanLimit = 100
// NextUpCandidates 返回「每部在看的剧的下一个待看集」,按最近观看时间排序。
//
// 语义要点:
// - 只处理剧集,电影由 Resume 接口负责,避免两个接口内容重复。
// - 同一部剧最多一条:取最近看过的集合之后、编号最小的那集。
// - 已标记看完的集跳过;追到最后一集则该剧不出现在结果里。
func (s *MediaDiscoveryService) NextUpCandidates(ctx context.Context, userID string, limit int, visibility MediaVisibility) ([]model.Media, error) {
if s == nil || s.repo == nil || s.repo.Media == nil {
return nil, nil
}
if strings.TrimSpace(userID) == "" {
return nil, nil
}
if limit <= 0 {
limit = 20
}
// Bug 1 fix: include completed histories as anchors so a finished episode
// still anchors its series and the next unwatched episode is picked.
var histories []model.PlaybackHistory
if err := s.repo.DB.WithContext(ctx).
Where("user_id = ? AND position_ms > 0", userID).
Order("watched_at desc").
Limit(nextUpHistoryScanLimit).
Find(&histories).Error; err != nil {
return nil, err
}
if len(histories) == 0 {
return nil, nil
}
mediaIDs := make([]string, 0, len(histories))
for _, h := range histories {
mediaIDs = append(mediaIDs, h.MediaID)
}
filter := mediaFilterFromVisibility(visibility)
var watchedRows []model.Media
q := s.repo.DB.WithContext(ctx).Where("id IN ?", mediaIDs)
q = applyDiscoveryVisibility(q, filter)
if err := q.Find(&watchedRows).Error; err != nil {
return nil, err
}
byID := make(map[string]*model.Media, len(watchedRows))
for i := range watchedRows {
byID[watchedRows[i].ID] = &watchedRows[i]
}
// 按最近观看顺序归并到「剧」维度,同时记住该剧最近看的那一集以及它是否看完。
type seriesState struct {
key string
current *model.Media
completed bool
}
states := make([]seriesState, 0, len(histories))
seen := make(map[string]bool, len(histories))
for _, h := range histories {
m := byID[h.MediaID]
if m == nil || !mediaIsEpisode(m) {
continue
}
key := seriesGroupKey(m)
if key == "" || seen[key] {
continue
}
seen[key] = true
states = append(states, seriesState{key: key, current: m, completed: h.Completed})
}
if len(states) == 0 {
return nil, nil
}
// 一次性把涉及的剧集全部取回,避免按剧逐条查询。
//
// Bug 4 fix: group by library_id when fetching by series_id so episodes
// from a different library with the same series_id don't bleed in.
// Bug 5 fix: batch unscraped (library_id, title) lookups per library
// instead of one query per series.
byLibSeries := make(map[string][]string) // libID -> []seriesID
var fallback []seriesState
for _, st := range states {
if id := strings.TrimSpace(st.current.SeriesID); id != "" {
byLibSeries[st.current.LibraryID] = append(byLibSeries[st.current.LibraryID], id)
} else {
fallback = append(fallback, st)
}
}
episodes := make([]model.Media, 0, len(states)*8)
// 按库批量加载刮削剧集,避免跨库混入同名 series_id 的剧集。
for libID, sids := range byLibSeries {
var rows []model.Media
eq := s.repo.DB.WithContext(ctx).Where("series_id IN ? AND library_id = ?", sids, libID)
eq = applyDiscoveryVisibility(eq, filter)
if err := eq.Find(&rows).Error; err != nil {
return nil, err
}
episodes = append(episodes, rows...)
}
// 未刮削剧集按 (库, 标题) 批量兜底查询,每库一条 SQL 避免 N+1。
byLibTitles := make(map[string][]string) // libID -> []title
for _, st := range fallback {
byLibTitles[st.current.LibraryID] = append(byLibTitles[st.current.LibraryID], st.current.Title)
}
for libID, titles := range byLibTitles {
var rows []model.Media
fq := s.repo.DB.WithContext(ctx).Where("library_id = ? AND title IN ?", libID, titles)
fq = applyDiscoveryVisibility(fq, filter)
if err := fq.Find(&rows).Error; err != nil {
return nil, err
}
episodes = append(episodes, rows...)
}
// 按剧归并候选集,便于 O(1) 查找下一集。
bySeries := make(map[string][]model.Media, len(states))
for _, row := range episodes {
key := seriesGroupKey(&row)
if key == "" {
continue
}
bySeries[key] = append(bySeries[key], row)
}
completed := s.completedMediaIDs(ctx, userID, episodes)
out := make([]model.Media, 0, limit)
for _, st := range states {
if len(out) >= limit {
break
}
next, ok := pickNextEpisode(bySeries[st.key], st.current, st.completed, completed)
if !ok {
continue
}
out = append(out, next)
}
return out, nil
}
// applyDiscoveryVisibility 把可见性过滤应用到查询上。
func applyDiscoveryVisibility(q *gorm.DB, filter repository.MediaQueryFilter) *gorm.DB {
if !filter.IncludeNSFW {
q = q.Where("nsfw = ?", false)
}
if len(filter.HiddenLibraryIDs) > 0 {
q = q.Where("library_id NOT IN ?", filter.HiddenLibraryIDs)
}
if len(filter.AllowedLibraryIDs) > 0 {
q = q.Where("library_id IN ?", filter.AllowedLibraryIDs)
}
if libraryID := strings.TrimSpace(filter.LibraryID); libraryID != "" {
q = q.Where("library_id = ?", libraryID)
}
return q
}
// completedMediaIDs 找出这些候选里该用户已标记看完的集。
func (s *MediaDiscoveryService) completedMediaIDs(ctx context.Context, userID string, rows []model.Media) map[string]bool {
out := make(map[string]bool)
if len(rows) == 0 {
return out
}
ids := make([]string, 0, len(rows))
for _, row := range rows {
ids = append(ids, row.ID)
}
var done []model.PlaybackHistory
if err := s.repo.DB.WithContext(ctx).
Where("user_id = ? AND completed = ? AND media_id IN ?", userID, true, ids).
Find(&done).Error; err != nil {
return out
}
for _, h := range done {
out[h.MediaID] = true
}
return out
}
// pickNextEpisode 选出这部剧「接下来该看的那一集」。
//
// anchor 是这部剧最近一次播放的那一集,anchorCompleted 表示那一集是否已看完:
// - 没看完(只播了几秒就退出、或中途暂停)时,接下来该看的仍是这一集本身。
// 否则详情页的「继续播放」会直接跳到下一集,用户刚看的那一集被静默跳过。
// - 已看完时,才在候选集里取严格晚于它的、编号最小的一集;比较顺序为
// (季, 集),因此跨季时自然落到下一季第一集。
func pickNextEpisode(candidates []model.Media, anchor *model.Media, anchorCompleted bool, completed map[string]bool) (model.Media, bool) {
if anchor == nil {
return model.Media{}, false
}
if !anchorCompleted {
return *anchor, true
}
var best model.Media
found := false
for _, candidate := range candidates {
if candidate.ID == anchor.ID || completed[candidate.ID] {
continue
}
if !episodeAfter(candidate, *anchor) {
continue
}
if !found || episodeBefore(candidate, best) {
best = candidate
found = true
}
}
return best, found
}
// episodeAfter 报告 a 是否严格晚于 b。
func episodeAfter(a, b model.Media) bool {
if a.SeasonNum != b.SeasonNum {
return a.SeasonNum > b.SeasonNum
}
return a.EpisodeNum > b.EpisodeNum
}
// episodeBefore 报告 a 是否严格早于 b。
func episodeBefore(a, b model.Media) bool {
if a.SeasonNum != b.SeasonNum {
return a.SeasonNum < b.SeasonNum
}
return a.EpisodeNum < b.EpisodeNum
}
// similarCandidateLimit 是每个来源池(同库 / 同类型其他库)的候选上限。
//
// 相似度需要在内存里按类型/年份/评分算分,因此不能把整库拉出来;按评分倒序
// 取前 N 条是「好的片子更可能被推荐」与「查询有界」之间的折中。
const similarCandidateLimit = 400
// SimilarCandidates 返回与源条目相似的本地媒体。
//
// 打分口径(不依赖任何外部 API,离线可用):
// - 类型重合数 × 10:最强信号,同类内容通常才谈得上相似;
// - 年份接近度:相差 5 年内给分,差得越远越低;
// - 评分接近度:同为高分片算加分,避免「8 分片旁边推 3 分片」。
//
// 同库优先;不足时才从同类型的其它可见库里补齐。同剧其它集与自身一律排除。
func (s *MediaDiscoveryService) SimilarCandidates(ctx context.Context, mediaID string, limit int, visibility MediaVisibility) ([]model.Media, error) {
if s == nil || s.repo == nil || s.repo.Media == nil {
return nil, nil
}
if limit <= 0 {
limit = 12
}
source, err := s.repo.Media.FindByID(ctx, mediaID)
if err != nil {
return nil, err
}
if source == nil || !visibility.Allows(source) {
return nil, nil
}
filter := mediaFilterFromVisibility(visibility)
pool, err := s.similarPool(ctx, filter, source, false)
if err != nil {
return nil, err
}
if len(pool) < limit {
// 同库不够时再扩到同类型库,保持「电影配电影、剧集配剧集」的直觉。
more, err := s.similarPool(ctx, filter, source, true)
if err != nil {
return nil, err
}
pool = append(pool, more...)
}
return rankSimilar(source, pool, limit), nil
}
// similarPool 取一批候选。expand=true 时排除源所在的库(用于补齐阶段),
// 否则只取源所在的库(首选阶段)。
func (s *MediaDiscoveryService) similarPool(ctx context.Context, filter repository.MediaQueryFilter, source *model.Media, expand bool) ([]model.Media, error) {
q := s.repo.DB.WithContext(ctx).Model(&model.Media{})
q = applyDiscoveryVisibility(q, filter)
q = q.Where("id <> ?", source.ID)
libraryIDs := []string{source.LibraryID}
if expand {
ids, err := s.compatibleLibraryIDs(ctx, source)
if err != nil {
return nil, err
}
filtered := make([]string, 0, len(ids))
for _, id := range ids {
if id != source.LibraryID {
filtered = append(filtered, id)
}
}
if len(filtered) == 0 {
return nil, nil
}
libraryIDs = filtered
}
q = q.Where("library_id IN ?", libraryIDs)
// 电影与剧集不互相推荐:用集号判定,和 NextUp 保持同一套口径。
if mediaIsEpisode(source) {
q = q.Where("(season_num > 0 OR episode_num > 0)")
} else {
q = q.Where("season_num = 0 AND episode_num = 0")
}
var rows []model.Media
if err := q.Order("rating desc, updated_at desc").Limit(similarCandidateLimit).Find(&rows).Error; err != nil {
return nil, err
}
return rows, nil
}
// compatibleLibraryIDs 返回与源条目同类型的库 ID(可能包含源库自身)。
// 查不到类型时退回源库,保证补齐阶段不会跨类型乱推。
func (s *MediaDiscoveryService) compatibleLibraryIDs(ctx context.Context, source *model.Media) ([]string, error) {
if s.repo.Library == nil {
return []string{source.LibraryID}, nil
}
libs, err := s.repo.Library.List(ctx)
if err != nil {
return nil, err
}
sourceType := ""
for _, lib := range libs {
if lib.ID == source.LibraryID {
sourceType = strings.ToLower(strings.TrimSpace(lib.Type))
break
}
}
if sourceType == "" {
return []string{source.LibraryID}, nil
}
out := make([]string, 0, len(libs))
for _, lib := range libs {
if strings.ToLower(strings.TrimSpace(lib.Type)) == sourceType {
out = append(out, lib.ID)
}
}
return out, nil
}
// rankSimilar 按相似度排序并截断。
func rankSimilar(source *model.Media, pool []model.Media, limit int) []model.Media {
if len(pool) == 0 {
return nil
}
sourceGenres := genreSet(source.Genres)
sourceKey := seriesGroupKey(source)
type scored struct {
media model.Media
score float64
}
scoredRows := make([]scored, 0, len(pool))
seen := make(map[string]bool, len(pool))
for _, candidate := range pool {
if candidate.ID == source.ID || seen[candidate.ID] {
continue
}
// 同剧其它集不参与:「相似」不是在推荐本剧的下一集。
if key := seriesGroupKey(&candidate); key != "" && key == sourceKey {
continue
}
seen[candidate.ID] = true
scoredRows = append(scoredRows, scored{
media: candidate,
score: similarScore(source, &candidate, sourceGenres),
})
}
sort.SliceStable(scoredRows, func(i, j int) bool {
if scoredRows[i].score != scoredRows[j].score {
return scoredRows[i].score > scoredRows[j].score
}
if scoredRows[i].media.Rating != scoredRows[j].media.Rating {
return scoredRows[i].media.Rating > scoredRows[j].media.Rating
}
return scoredRows[i].media.Title < scoredRows[j].media.Title
})
if len(scoredRows) > limit {
scoredRows = scoredRows[:limit]
}
out := make([]model.Media, 0, len(scoredRows))
for _, row := range scoredRows {
out = append(out, row.media)
}
return out
}
// similarScore 计算单个候选的相似度。
func similarScore(source, candidate *model.Media, sourceGenres map[string]struct{}) float64 {
score := float64(genreOverlap(sourceGenres, genreSet(candidate.Genres))) * 10
if source.Year > 0 && candidate.Year > 0 {
diff := source.Year - candidate.Year
if diff < 0 {
diff = -diff
}
if diff <= 5 {
score += float64(5 - diff)
}
}
if source.Rating > 0 && candidate.Rating > 0 {
diff := float64(source.Rating - candidate.Rating)
if diff < 0 {
diff = -diff
}
// 评分差 2 分以内才给分,最多 3 分。
if diff < 2 {
score += 3 * (2 - diff) / 2
}
}
return score
}
@@ -0,0 +1,287 @@
package service
import (
"context"
"strconv"
"testing"
"time"
"go.uber.org/zap"
"github.com/truewhile/MeBox/internal/model"
"github.com/truewhile/MeBox/internal/repository"
)
// seedEpisode 插入一集,并把播放历史指向 `watched`(nil 表示没有历史)。
//
// position_ms / duration_ms 只是占位值,NextUp 只看历史行的 completed 字段:
// 未看完的那一集本身就是「接下来该看的一集」。
func seedEpisode(
t *testing.T,
repos *repository.Container,
libID, seriesID, title string,
season, episode int,
watchedAt *time.Time,
completed bool,
) *model.Media {
t.Helper()
m := &model.Media{
LibraryID: libID,
SeriesID: seriesID,
Title: title,
SeasonNum: season,
EpisodeNum: episode,
Path: "/media/" + seriesID + "/S" + strconv.Itoa(season) + "E" + strconv.Itoa(episode) + ".mkv",
}
if err := repos.DB.WithContext(context.Background()).Create(m).Error; err != nil {
t.Fatal(err)
}
if watchedAt != nil || completed {
// 标记「已看完」也会产生一条历史行,因此 completed 为真时同样要写历史,
// 否则夹具与真实数据不一致(真实库里已看完一定有行)。
watched := time.Now().Add(-time.Hour)
if watchedAt != nil {
watched = *watchedAt
}
h := &model.PlaybackHistory{
UserID: "user-1",
MediaID: m.ID,
PositionMs: 1000,
DurationMs: 2000,
WatchedAt: watched,
Completed: completed,
}
if err := repos.DB.WithContext(context.Background()).Create(h).Error; err != nil {
t.Fatal(err)
}
}
return m
}
func nextUpIDs(t *testing.T, svc *MediaDiscoveryService, visibility MediaVisibility) []string {
t.Helper()
rows, err := svc.NextUpCandidates(context.Background(), "user-1", 20, visibility)
if err != nil {
t.Fatal(err)
}
out := make([]string, 0, len(rows))
for _, row := range rows {
out = append(out, episodeLabel(row))
}
return out
}
// episodeLabel 把一集渲染成 "S1E2",方便断言。
func episodeLabel(m model.Media) string {
return "S" + strconv.Itoa(m.SeasonNum) + "E" + strconv.Itoa(m.EpisodeNum)
}
func TestNextUpPicksNextEpisode(t *testing.T) {
repos := newDiscoveryTestDB(t)
libID := seedDiscoveryLibrary(t, repos, "tv")
watchedAt := time.Now().Add(-time.Hour)
seedEpisode(t, repos, libID, "series-1", "剧一", 1, 1, &watchedAt, true) // 第 1 集已看完
seedEpisode(t, repos, libID, "series-1", "剧一", 1, 2, nil, false)
seedEpisode(t, repos, libID, "series-1", "剧一", 1, 3, nil, false)
svc := NewMediaDiscoveryService(zap.NewNop(), repos)
got := nextUpIDs(t, svc, MediaVisibility{IncludeNSFW: true})
if len(got) != 1 || got[0] != "S1E2" {
t.Fatalf("next up = %v, want [S1E2]", got)
}
}
// 回归:只播了几秒就退出(未看完)时,「接下来该看的一集」仍是这一集本身。
// 客户端(Yamby 等)剧集详情页的「继续播放」直接取 NextUp 第一条,跳集会播错集。
func TestNextUpKeepsPartiallyWatchedEpisode(t *testing.T) {
repos := newDiscoveryTestDB(t)
libID := seedDiscoveryLibrary(t, repos, "tv")
watchedAt := time.Now().Add(-time.Minute)
seedEpisode(t, repos, libID, "series-1", "剧一", 1, 1, nil, true)
seedEpisode(t, repos, libID, "series-1", "剧一", 1, 2, &watchedAt, false) // 第 2 集只看了几秒
seedEpisode(t, repos, libID, "series-1", "剧一", 1, 3, nil, false)
svc := NewMediaDiscoveryService(zap.NewNop(), repos)
got := nextUpIDs(t, svc, MediaVisibility{IncludeNSFW: true})
if len(got) != 1 || got[0] != "S1E2" {
t.Fatalf("next up = %v, want [S1E2] (未看完的那一集不能跳过)", got)
}
}
// 未看完的是这部剧的最后一集时也要返回它,不能因为「后面没有集了」而返回空。
func TestNextUpKeepsPartiallyWatchedFinalEpisode(t *testing.T) {
repos := newDiscoveryTestDB(t)
libID := seedDiscoveryLibrary(t, repos, "tv")
watchedAt := time.Now().Add(-time.Minute)
seedEpisode(t, repos, libID, "series-1", "剧一", 1, 1, nil, true)
seedEpisode(t, repos, libID, "series-1", "剧一", 1, 2, &watchedAt, false) // 最后一集未看完
svc := NewMediaDiscoveryService(zap.NewNop(), repos)
got := nextUpIDs(t, svc, MediaVisibility{IncludeNSFW: true})
if len(got) != 1 || got[0] != "S1E2" {
t.Fatalf("next up = %v, want [S1E2]", got)
}
}
// 电影不进 NextUp:NextUp 的语义是「下一集」,电影由 Resume 接口负责。
func TestNextUpSkipsMovies(t *testing.T) {
repos := newDiscoveryTestDB(t)
libID := seedDiscoveryLibrary(t, repos, "movie")
watchedAt := time.Now().Add(-time.Hour)
seedEpisode(t, repos, libID, "", "电影", 0, 0, &watchedAt, false)
svc := NewMediaDiscoveryService(zap.NewNop(), repos)
if got := nextUpIDs(t, svc, MediaVisibility{IncludeNSFW: true}); len(got) != 0 {
t.Fatalf("next up = %v, want empty", got)
}
}
// 同一部剧有多条未看完历史时,只能出一条,且指向最靠后的已看集的下一集。
// 同一部剧有多条未看完历史时只能出一条,且指向最近看过的那一集。
//
// 最近那一集(S1E2)本身还没看完,所以它就是「接下来该看的一集」;
// S1E1 只是更早的中间进度,不能据此跳到 S1E3。
func TestNextUpOneEntryPerSeries(t *testing.T) {
repos := newDiscoveryTestDB(t)
libID := seedDiscoveryLibrary(t, repos, "tv")
older := time.Now().Add(-48 * time.Hour)
newer := time.Now().Add(-2 * time.Hour)
seedEpisode(t, repos, libID, "series-1", "剧一", 1, 1, &older, false)
seedEpisode(t, repos, libID, "series-1", "剧一", 1, 2, &newer, false)
seedEpisode(t, repos, libID, "series-1", "剧一", 1, 3, nil, false)
svc := NewMediaDiscoveryService(zap.NewNop(), repos)
got := nextUpIDs(t, svc, MediaVisibility{IncludeNSFW: true})
if len(got) != 1 || got[0] != "S1E2" {
t.Fatalf("next up = %v, want [S1E2]", got)
}
}
// 跨季时下一集应是下一季的第一集。
func TestNextUpCrossesSeason(t *testing.T) {
repos := newDiscoveryTestDB(t)
libID := seedDiscoveryLibrary(t, repos, "tv")
watchedAt := time.Now().Add(-time.Hour)
seedEpisode(t, repos, libID, "series-1", "剧一", 1, 12, &watchedAt, true) // 第 1 季最后一集已看完
seedEpisode(t, repos, libID, "series-1", "剧一", 2, 1, nil, false)
seedEpisode(t, repos, libID, "series-1", "剧一", 2, 2, nil, false)
svc := NewMediaDiscoveryService(zap.NewNop(), repos)
got := nextUpIDs(t, svc, MediaVisibility{IncludeNSFW: true})
if len(got) != 1 || got[0] != "S2E1" {
t.Fatalf("next up = %v, want [S2E1]", got)
}
}
// 已标记看完的下一集要跳过。
func TestNextUpSkipsCompletedEpisode(t *testing.T) {
repos := newDiscoveryTestDB(t)
libID := seedDiscoveryLibrary(t, repos, "tv")
watchedAt := time.Now().Add(-time.Hour)
seedEpisode(t, repos, libID, "series-1", "剧一", 1, 1, &watchedAt, true) // 已看完,下一集是 S1E3
seedEpisode(t, repos, libID, "series-1", "剧一", 1, 2, nil, true) // 已看完
seedEpisode(t, repos, libID, "series-1", "剧一", 1, 3, nil, false)
svc := NewMediaDiscoveryService(zap.NewNop(), repos)
got := nextUpIDs(t, svc, MediaVisibility{IncludeNSFW: true})
if len(got) != 1 || got[0] != "S1E3" {
t.Fatalf("next up = %v, want [S1E3]", got)
}
}
// 追到最后一集且已看完时没有下一集,结果为空而不是重复返回最后一集。
func TestNextUpEmptyAtSeriesEnd(t *testing.T) {
repos := newDiscoveryTestDB(t)
libID := seedDiscoveryLibrary(t, repos, "tv")
watchedAt := time.Now().Add(-time.Hour)
seedEpisode(t, repos, libID, "series-1", "剧一", 1, 3, &watchedAt, true)
svc := NewMediaDiscoveryService(zap.NewNop(), repos)
if got := nextUpIDs(t, svc, MediaVisibility{IncludeNSFW: true}); len(got) != 0 {
t.Fatalf("next up = %v, want empty", got)
}
}
// 不可见媒体库里的下一集不能被推荐出去。
func TestNextUpRespectsVisibility(t *testing.T) {
repos := newDiscoveryTestDB(t)
visibleLib := seedDiscoveryLibrary(t, repos, "tv")
hiddenLib := seedDiscoveryLibrary(t, repos, "tv")
watchedAt := time.Now().Add(-time.Hour)
seedEpisode(t, repos, visibleLib, "series-1", "剧一", 1, 1, &watchedAt, true)
seedEpisode(t, repos, hiddenLib, "series-1", "剧一", 1, 2, nil, false)
svc := NewMediaDiscoveryService(zap.NewNop(), repos)
got := nextUpIDs(t, svc, MediaVisibility{IncludeNSFW: true, AllowedLibraryIDs: []string{visibleLib}})
if len(got) != 0 {
t.Fatalf("next up = %v, want empty (hidden library)", got)
}
}
// 最后一集看完(completed=true)后,下一部剧仍应出现在 NextUp 中,
// 而不是因为没有 completed=false 的历史而消失(bug 1 回归测试)。
func TestNextUpAfterCompletedEpisode(t *testing.T) {
repos := newDiscoveryTestDB(t)
libID := seedDiscoveryLibrary(t, repos, "tv")
watchedAt := time.Now().Add(-time.Hour)
// S1E1 已看完,S1E2 尚未开始。
seedEpisode(t, repos, libID, "series-1", "剧一", 1, 1, &watchedAt, true)
seedEpisode(t, repos, libID, "series-1", "剧一", 1, 2, nil, false)
seedEpisode(t, repos, libID, "series-1", "剧一", 1, 3, nil, false)
svc := NewMediaDiscoveryService(zap.NewNop(), repos)
got := nextUpIDs(t, svc, MediaVisibility{IncludeNSFW: true})
if len(got) != 1 || got[0] != "S1E2" {
t.Fatalf("next up after completed S1E1 = %v, want [S1E2]", got)
}
}
// 整部剧看完(所有集都 completed=true)时不应出现在 NextUp(没有下一集)。
func TestNextUpSeriesFullyWatchedIsEmpty(t *testing.T) {
repos := newDiscoveryTestDB(t)
libID := seedDiscoveryLibrary(t, repos, "tv")
watchedAt := time.Now().Add(-time.Hour)
seedEpisode(t, repos, libID, "series-1", "剧一", 1, 1, nil, true)
seedEpisode(t, repos, libID, "series-1", "剧一", 1, 2, &watchedAt, true) // 最近看完的最后一集
svc := NewMediaDiscoveryService(zap.NewNop(), repos)
if got := nextUpIDs(t, svc, MediaVisibility{IncludeNSFW: true}); len(got) != 0 {
t.Fatalf("next up for fully-watched series = %v, want empty", got)
}
}
// 多部剧时按最近观看时间排序。
func TestNextUpOrdersByRecency(t *testing.T) {
repos := newDiscoveryTestDB(t)
libID := seedDiscoveryLibrary(t, repos, "tv")
older := time.Now().Add(-24 * time.Hour)
newer := time.Now().Add(-1 * time.Hour)
seedEpisode(t, repos, libID, "series-a", "剧A", 1, 1, &older, false)
seedEpisode(t, repos, libID, "series-a", "剧A", 1, 2, nil, false)
seedEpisode(t, repos, libID, "series-b", "剧B", 1, 1, &newer, false)
seedEpisode(t, repos, libID, "series-b", "剧B", 1, 2, nil, false)
svc := NewMediaDiscoveryService(zap.NewNop(), repos)
rows, err := svc.NextUpCandidates(context.Background(), "user-1", 20, MediaVisibility{IncludeNSFW: true})
if err != nil {
t.Fatal(err)
}
if len(rows) != 2 {
t.Fatalf("rows = %d, want 2", len(rows))
}
if rows[0].SeriesID != "series-b" {
t.Fatalf("first row series = %q, want series-b (most recently watched)", rows[0].SeriesID)
}
}
@@ -0,0 +1,167 @@
package service
import (
"context"
"testing"
"go.uber.org/zap"
"github.com/truewhile/MeBox/internal/model"
"github.com/truewhile/MeBox/internal/repository"
)
func seedSimilarMedia(t *testing.T, repos *repository.Container, libID, title, genres string, year int, rating float32) *model.Media {
t.Helper()
m := &model.Media{
LibraryID: libID,
Title: title,
Genres: genres,
Year: year,
Rating: rating,
Path: "/media/" + libID + "/" + title + ".mkv",
}
if err := repos.DB.WithContext(context.Background()).Create(m).Error; err != nil {
t.Fatal(err)
}
return m
}
func similarTitles(t *testing.T, svc *MediaDiscoveryService, sourceID string, visibility MediaVisibility) []string {
t.Helper()
rows, err := svc.SimilarCandidates(context.Background(), sourceID, 12, visibility)
if err != nil {
t.Fatal(err)
}
out := make([]string, 0, len(rows))
for _, row := range rows {
out = append(out, row.Title)
}
return out
}
func containsTitle(items []string, want string) bool {
for _, item := range items {
if item == want {
return true
}
}
return false
}
// 相似推荐必须排除自己,也要排除同剧的其他集(否则详情页会推荐本剧的其它集)。
func TestSimilarExcludesSelfAndSameSeries(t *testing.T) {
repos := newDiscoveryTestDB(t)
libID := seedDiscoveryLibrary(t, repos, "tv")
source := seedSimilarMedia(t, repos, libID, "剧一 E01", "Action", 2020, 8)
source.SeriesID = "series-1"
source.SeasonNum, source.EpisodeNum = 1, 1
if err := repos.DB.WithContext(context.Background()).Save(source).Error; err != nil {
t.Fatal(err)
}
sibling := seedSimilarMedia(t, repos, libID, "剧一 E02", "Action", 2020, 8)
sibling.SeriesID = "series-1"
sibling.SeasonNum, sibling.EpisodeNum = 1, 2
if err := repos.DB.WithContext(context.Background()).Save(sibling).Error; err != nil {
t.Fatal(err)
}
// 同库另一部剧的第 1 集:这才是剧集详情页该推荐的内容。
other := seedSimilarMedia(t, repos, libID, "另一部动作剧", "Action", 2021, 7)
other.SeriesID = "series-2"
other.SeasonNum, other.EpisodeNum = 1, 1
if err := repos.DB.WithContext(context.Background()).Save(other).Error; err != nil {
t.Fatal(err)
}
svc := NewMediaDiscoveryService(zap.NewNop(), repos)
got := similarTitles(t, svc, source.ID, MediaVisibility{IncludeNSFW: true})
if containsTitle(got, "剧一 E01") {
t.Fatalf("result must exclude the source itself: %v", got)
}
if containsTitle(got, "剧一 E02") {
t.Fatalf("result must exclude other episodes of the same series: %v", got)
}
if !containsTitle(got, "另一部动作剧") {
t.Fatalf("result = %v, want it to contain 另一部动作剧", got)
}
}
// 类型重合度高的条目要排在前面。
func TestSimilarPrefersGenreOverlap(t *testing.T) {
repos := newDiscoveryTestDB(t)
libID := seedDiscoveryLibrary(t, repos, "movie")
source := seedSimilarMedia(t, repos, libID, "源片", "Action,Adventure", 2010, 7)
seedSimilarMedia(t, repos, libID, "同类型", "Action,Adventure", 2010, 7)
seedSimilarMedia(t, repos, libID, "弱相关", "Comedy", 2010, 7)
svc := NewMediaDiscoveryService(zap.NewNop(), repos)
got := similarTitles(t, svc, source.ID, MediaVisibility{IncludeNSFW: true})
if len(got) < 2 {
t.Fatalf("result = %v, want at least 2 entries", got)
}
if got[0] != "同类型" {
t.Fatalf("result = %v, want 同类型 ranked first", got)
}
}
// 不可见媒体库的条目不能被推荐。
func TestSimilarRespectsVisibility(t *testing.T) {
repos := newDiscoveryTestDB(t)
sourceLib := seedDiscoveryLibrary(t, repos, "movie")
hiddenLib := seedDiscoveryLibrary(t, repos, "movie")
source := seedSimilarMedia(t, repos, sourceLib, "源片", "Action", 2010, 7)
seedSimilarMedia(t, repos, hiddenLib, "隐藏片", "Action", 2010, 7)
svc := NewMediaDiscoveryService(zap.NewNop(), repos)
got := similarTitles(t, svc, source.ID, MediaVisibility{IncludeNSFW: true, AllowedLibraryIDs: []string{sourceLib}})
if containsTitle(got, "隐藏片") {
t.Fatalf("hidden library leaked into similar: %v", got)
}
}
// 源条目不可见或不存在时返回空,不报错:客户端不该因此看到 500。
func TestSimilarUnknownSourceReturnsEmpty(t *testing.T) {
repos := newDiscoveryTestDB(t)
svc := NewMediaDiscoveryService(zap.NewNop(), repos)
rows, err := svc.SimilarCandidates(context.Background(), "missing", 12, MediaVisibility{IncludeNSFW: true})
if err != nil {
t.Fatal(err)
}
if len(rows) != 0 {
t.Fatalf("rows = %v, want empty", rows)
}
}
// limit 生效,且不返回重复条目。
func TestSimilarHonoursLimit(t *testing.T) {
repos := newDiscoveryTestDB(t)
libID := seedDiscoveryLibrary(t, repos, "movie")
source := seedSimilarMedia(t, repos, libID, "源片", "Action", 2010, 7)
for i := 0; i < 5; i++ {
seedSimilarMedia(t, repos, libID, "候选"+string(rune('A'+i)), "Action", 2010, 7)
}
svc := NewMediaDiscoveryService(zap.NewNop(), repos)
rows, err := svc.SimilarCandidates(context.Background(), source.ID, 3, MediaVisibility{IncludeNSFW: true})
if err != nil {
t.Fatal(err)
}
if len(rows) != 3 {
t.Fatalf("rows = %d, want 3", len(rows))
}
seen := map[string]bool{}
for _, row := range rows {
if seen[row.ID] {
t.Fatalf("duplicate row %q in result", row.Title)
}
seen[row.ID] = true
}
}

Some files were not shown because too many files have changed in this diff Show More