Compare commits
32
Commits
v0.2.0
..
3f18f85925
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3f18f85925 | ||
|
|
155017a27b | ||
|
|
ad4727c507 | ||
|
|
65247b095a | ||
|
|
8a4187720c | ||
|
|
92cf8fab8a | ||
|
|
aa3f09752e | ||
|
|
f5563e6f31 | ||
|
|
d22abecf12 | ||
|
|
7660db14d8 | ||
|
|
1bed8d8ed0 | ||
|
|
a4ea53bfa0 | ||
|
|
9db038dd05 | ||
|
|
70865a3cf4 | ||
|
|
51bd7ae37a | ||
|
|
dbaee35400 | ||
|
|
7984c1880a | ||
|
|
865fdd81e8 | ||
|
|
dc3248d11c | ||
|
|
8be40ae6dc | ||
|
|
cdc9a7c94b | ||
|
|
c00c46e7a1 | ||
|
|
3b3aa3b708 | ||
|
|
695b3ecf25 | ||
|
|
7343d5aa5c | ||
|
|
171503d775 | ||
|
|
91b0c8acee | ||
|
|
a238e5c2a4 | ||
|
|
272565f736 | ||
|
|
ed3d7c6b61 | ||
|
|
72d0d6a3a9 | ||
|
|
78c72004bf |
+2
-1
@@ -1,7 +1,8 @@
|
|||||||
*.exe
|
*.exe
|
||||||
*.md
|
*.md
|
||||||
.env
|
.env
|
||||||
.env.example
|
.env.*
|
||||||
|
!.env.example
|
||||||
.git
|
.git
|
||||||
.gitignore
|
.gitignore
|
||||||
tts_api_architecture.html
|
tts_api_architecture.html
|
||||||
|
|||||||
@@ -51,6 +51,17 @@ BYTEDANCE_TTS_SAMPLE_RATE=24000
|
|||||||
# OpenAI兼容接口的API密钥(可选,多个用逗号分隔)
|
# OpenAI兼容接口的API密钥(可选,多个用逗号分隔)
|
||||||
OPENAI_TTS_API_KEY=your_openai_compatible_key_here
|
OPENAI_TTS_API_KEY=your_openai_compatible_key_here
|
||||||
|
|
||||||
|
# 反代拓扑配置(0-10)。控制 X-Forwarded-For 解析方式,影响 IP 限流的 key。
|
||||||
|
# 不设置 / 0:启发式模式(默认)—— 从 XFF 链尾扫描,跳过私有 IP,返回第一个公网 IP
|
||||||
|
# 适合 90% 部署(单跳/多跳/直出),无需了解精确跳数
|
||||||
|
# N (N>0) :精确模式 —— 精准到真实 client IP,需要正确配置跳数
|
||||||
|
# N=1:单跳反代(client → nginx → 本服务)
|
||||||
|
# N=2:双跳反代(client → CDN → nginx → 本服务,如 Cloudflare + nginx)
|
||||||
|
# N=3:三跳,以此类推
|
||||||
|
# 直出部署(无反代):无需配置,XFF 分支不会执行
|
||||||
|
# 详见 README "反代拓扑与 X-Forwarded-For 解析"章节
|
||||||
|
# TRUSTED_PROXY_HOPS=
|
||||||
|
|
||||||
# CORS 跨域白名单(逗号分隔;开发环境可设 *;空则拒绝所有跨域)
|
# CORS 跨域白名单(逗号分隔;开发环境可设 *;空则拒绝所有跨域)
|
||||||
# ALLOWED_ORIGINS=https://example.com,https://app.example.com
|
# ALLOWED_ORIGINS=https://example.com,https://app.example.com
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,65 @@
|
|||||||
|
name: Docker Publish
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- 'v*'
|
||||||
|
workflow_dispatch: # 允许手动触发测试
|
||||||
|
|
||||||
|
env:
|
||||||
|
REGISTRY: ghcr.io
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build-and-push:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
packages: write
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
fetch-depth: 0 # 拉完整历史,git describe 能取到 tag
|
||||||
|
|
||||||
|
- name: Set up QEMU
|
||||||
|
uses: docker/setup-qemu-action@v3
|
||||||
|
|
||||||
|
- name: Set up Docker Buildx
|
||||||
|
uses: docker/setup-buildx-action@v3
|
||||||
|
|
||||||
|
- name: Login to GHCR
|
||||||
|
uses: docker/login-action@v3
|
||||||
|
with:
|
||||||
|
registry: ${{ env.REGISTRY }}
|
||||||
|
username: ${{ github.actor }}
|
||||||
|
password: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
|
||||||
|
- name: Extract version from git
|
||||||
|
id: version
|
||||||
|
run: |
|
||||||
|
echo "version=$(git describe --tags --always --dirty)" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "commit=$(git rev-parse --short HEAD)" >> "$GITHUB_OUTPUT"
|
||||||
|
|
||||||
|
- name: Extract Docker metadata
|
||||||
|
id: meta
|
||||||
|
uses: docker/metadata-action@v5
|
||||||
|
with:
|
||||||
|
images: ${{ env.REGISTRY }}/${{ github.repository }}
|
||||||
|
tags: |
|
||||||
|
type=semver,pattern={{version}}
|
||||||
|
type=sha,format=short
|
||||||
|
labels: |
|
||||||
|
org.opencontainers.image.version=${{ steps.version.outputs.version }}
|
||||||
|
org.opencontainers.image.revision=${{ steps.version.outputs.commit }}
|
||||||
|
|
||||||
|
- name: Build and push
|
||||||
|
uses: docker/build-push-action@v5
|
||||||
|
with:
|
||||||
|
context: .
|
||||||
|
platforms: linux/amd64,linux/arm64
|
||||||
|
push: true
|
||||||
|
tags: ${{ steps.meta.outputs.tags }}
|
||||||
|
labels: ${{ steps.meta.outputs.labels }}
|
||||||
|
build-args: |
|
||||||
|
VERSION=${{ steps.version.outputs.version }}
|
||||||
|
COMMIT=${{ steps.version.outputs.commit }}
|
||||||
+33
-1
@@ -1,9 +1,12 @@
|
|||||||
# Go build cache
|
# Go build cache
|
||||||
.gocache/
|
.gocache/
|
||||||
*.exe
|
*.exe
|
||||||
*.test
|
*.test
|
||||||
*.out
|
*.out
|
||||||
|
|
||||||
|
# Go test sources (prevent accidental commit; tests live outside the repo by policy)
|
||||||
|
*_test.go
|
||||||
|
|
||||||
# Editor / OS
|
# Editor / OS
|
||||||
.vscode/
|
.vscode/
|
||||||
.idea/
|
.idea/
|
||||||
@@ -12,3 +15,32 @@ Thumbs.db
|
|||||||
|
|
||||||
# Logs
|
# Logs
|
||||||
*.log
|
*.log
|
||||||
|
|
||||||
|
# Secrets (do NOT commit local .env files; keep .env.example tracked as template)
|
||||||
|
.env
|
||||||
|
.env.*
|
||||||
|
!.env.example
|
||||||
|
|
||||||
|
# Local-only working notes (use task board for shared tracking)
|
||||||
|
TODO.md
|
||||||
|
|
||||||
|
# Release artifacts (build output)
|
||||||
|
release/
|
||||||
|
|
||||||
|
# Local build output (start-local.ps1 builds to bin/)
|
||||||
|
bin/
|
||||||
|
|
||||||
|
# Local dev scripts (per-user; not part of repo)
|
||||||
|
start-local.ps1
|
||||||
|
|
||||||
|
# Runtime database artifacts (created by M1 installer flow)
|
||||||
|
tts.db
|
||||||
|
tts.db-*
|
||||||
|
tts.db.*
|
||||||
|
installed.lock
|
||||||
|
|
||||||
|
# UI handoff bundle (for external AI redesign work; not deployed)
|
||||||
|
ui-handoff/
|
||||||
|
|
||||||
|
# Docs (本地草稿,不入库)
|
||||||
|
docs/
|
||||||
|
|||||||
+10
-2
@@ -7,7 +7,15 @@ RUN go mod download
|
|||||||
|
|
||||||
COPY . .
|
COPY . .
|
||||||
|
|
||||||
RUN CGO_ENABLED=0 GOOS=linux go build -o tts-api .
|
# VERSION 由 CI/CD 传入,通常为 `git describe --tags --always --dirty` 的输出
|
||||||
|
# COMMIT 为 `git rev-parse --short HEAD`
|
||||||
|
# 本地默认 dev
|
||||||
|
ARG VERSION=dev
|
||||||
|
ARG COMMIT=dev
|
||||||
|
RUN CGO_ENABLED=0 GOOS=linux go build \
|
||||||
|
-ldflags "-X github.com/volcano-tts/tts-api/version.Version=${VERSION} \
|
||||||
|
-X github.com/volcano-tts/tts-api/version.Commit=${COMMIT}" \
|
||||||
|
-o tts-api .
|
||||||
|
|
||||||
FROM alpine:3.21
|
FROM alpine:3.21
|
||||||
|
|
||||||
@@ -17,7 +25,7 @@ RUN apk --no-cache add ca-certificates tzdata \
|
|||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
|
|
||||||
COPY --from=builder /app/tts-api .
|
COPY --from=builder /app/tts-api .
|
||||||
COPY --from=builder /app/health.html .
|
# health.html 已通过 //go:embed 嵌入 binary,无需单独复制
|
||||||
|
|
||||||
RUN chown -R appuser:appgroup /app
|
RUN chown -R appuser:appgroup /app
|
||||||
|
|
||||||
|
|||||||
+391
@@ -0,0 +1,391 @@
|
|||||||
|
# 火山 TTS 聚合平台 · 项目书(v0.1)
|
||||||
|
|
||||||
|
> 定位:个人自用(无甲方)· 单机部署 · 单二进制分发
|
||||||
|
> 基线代码:Volcano-Engine-TTS-UI(develop 分支,Go,约 2900 行)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 1. 项目概述
|
||||||
|
|
||||||
|
### 1.1 背景与动机
|
||||||
|
|
||||||
|
现有 `Volcano-Engine-TTS-UI` 是一个"火山引擎 TTS v3 → OpenAI 兼容接口"的适配器,已具备 `/v1/audio/speech`、多格式输出、鉴权限流、Prometheus 观测等能力。当前存在三个核心问题:
|
||||||
|
|
||||||
|
1. **配置全部堆在环境变量里**:API Key、资源 ID、音色、采样率……随音色增长会持续"溢出",无法维护。
|
||||||
|
2. **音色是静态的**:`voice`/`model` 请求字段被接收但忽略,只支持 env 里配死的单音色。
|
||||||
|
3. **首次启动没有入口**:无 UI、无数据库,配置只能靠手写 env。
|
||||||
|
|
||||||
|
### 1.2 项目目标
|
||||||
|
|
||||||
|
把该项目升级为**自用聚合平台**:
|
||||||
|
|
||||||
|
- 用 **SQLite** 接管所有运行时可变配置(全局设置 + 音色库),环境变量只保留 3 个左右引导参数;
|
||||||
|
- 提供**引导式安装 UI**:首次启动(未安装)进入 `/setup` 向导收集配置,写入数据库后即完成安装;
|
||||||
|
- 采用 **lock 文件**作为安装状态判据,支持"损坏自动回退、可重置安装";
|
||||||
|
- `/v1/audio/speech` 的 `voice` 参数**按数据库路由**,实现多音色动态切换;
|
||||||
|
- 保持**单二进制分发**(SQLite 用纯 Go 驱动,`//go:embed` 嵌入引导页)。
|
||||||
|
|
||||||
|
### 1.3 设计原则
|
||||||
|
|
||||||
|
| 原则 | 说明 |
|
||||||
|
|---|---|
|
||||||
|
| 数据库为唯一配置源 | 运行时的全局参数、音色全部读库,不做"库 + env 双轨" |
|
||||||
|
| 环境变量只做引导 | 仅保留 DB 路径、端口、初始化凭证 |
|
||||||
|
| lock 是安装门卫 | 存在 = 已安装;不存在 = 安装模式;损坏 = 备份 + 删 lock + 回退 |
|
||||||
|
| 损坏可自愈 | 库异常自动备份留档并回退安装模式,不裸奔 |
|
||||||
|
| 先内核后 UI | 本期只做"引导页"(安装必需),完整管理后台后置 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 2. 需求范围
|
||||||
|
|
||||||
|
### 2.1 本期(MVP)范围
|
||||||
|
|
||||||
|
| 编号 | 需求 | 说明 |
|
||||||
|
|---|---|---|
|
||||||
|
| R1 | SQLite 接入 | `modernc.org/sqlite`(纯 Go、无 CGO),自动建表、轻量迁移 |
|
||||||
|
| R2 | 全局配置入库 | `settings` 表接管现有全部 TTS 全局环境变量 |
|
||||||
|
| R3 | 音色库 | `voices` 表:name → speaker/resource_id/model/…,支持增删改查 |
|
||||||
|
| R4 | 安装状态检测 | `installed.lock` 判据 + 启动判定流程 |
|
||||||
|
| R5 | 引导式安装 UI | `/setup` 引导页(首次启动数据收集)+ `POST /api/setup` |
|
||||||
|
| R6 | 安装模式路由守卫 | 未安装时全站只开放 `/setup`,其余返回 503/跳转 |
|
||||||
|
| R7 | voice 动态路由 | `/v1/audio/speech` 按 `voice` 查库路由到火山 |
|
||||||
|
| R8 | 音色管理 API | `GET/POST /api/voices`、`PUT/DELETE /api/voices/:id`(带鉴权) |
|
||||||
|
| R9 | 损坏回退 | 库校验失败 → 备份 `.corrupt-<ts>` → 删 lock → 重新安装 |
|
||||||
|
| R10 | 环境变量收敛 | 迁移后 env 仅剩:`TTS_DB_PATH`、`PORT`、初始化凭证 |
|
||||||
|
|
||||||
|
### 2.2 后置(不在本期)
|
||||||
|
|
||||||
|
- 完整管理后台(音色列表/用量图表/配置管理)
|
||||||
|
- 多服务商聚合(火山 / OpenAI / 微软统一适配)
|
||||||
|
- 流式实时输出(SSE/WebSocket)
|
||||||
|
- TTS 结果缓存、长文本自动分片、字幕透出
|
||||||
|
- ASR 转写端点(`/v1/audio/transcriptions`)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 3. 总体架构
|
||||||
|
|
||||||
|
```
|
||||||
|
┌───────────────────────────── 单二进制 tts-api ─────────────────────────────┐
|
||||||
|
│ │
|
||||||
|
│ main.go ── 启动:初始化 DB → 安装状态检测 → 加载配置 → 路由 → 监听 │
|
||||||
|
│ │
|
||||||
|
│ ┌────────────┐ ┌─────────────┐ ┌────────────────────────────────────┐ │
|
||||||
|
│ │ installer/ │──▶│ store/ │ │ router/ │ │
|
||||||
|
│ │ lock 检测 │ │ SQLite 访问 │ │ /setup(引导页·embed) /api/setup │ │
|
||||||
|
│ │ 安装模式 │ │ settings │ │ /api/voices* /v1/audio/speech│ │
|
||||||
|
│ └────────────┘ │ voices │ │ /health /metrics /dashboard │ │
|
||||||
|
│ └─────────────┘ └────────────────────────────────────┘ │
|
||||||
|
│ │
|
||||||
|
│ controller/ ── 语音合成(查库路由) · setup · voices CRUD │
|
||||||
|
│ middleware/ ── 鉴权 · 限流 · 并发 · 安装守卫 │
|
||||||
|
│ setting/ ── 仅保留引导参数(DB路径/端口/凭证) + 启动汇总 │
|
||||||
|
│ adapter/volcano/ ── 火山 v3 客户端(不改,仅入参来源变为 DB) │
|
||||||
|
└──────────────────────────────────────────────────────────────────────────────┘
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 4. 技术选型
|
||||||
|
|
||||||
|
| 项 | 选型 | 理由 |
|
||||||
|
|---|---|---|
|
||||||
|
| 语言 | Go(沿用) | 现有项目基线,无迁移成本 |
|
||||||
|
| 数据库 | SQLite(`modernc.org/sqlite`) | 纯 Go 无 CGO,保持 `CGO_ENABLED=0` 单二进制;单文件零运维 |
|
||||||
|
| 前端 | Vue3 + axios(沿用 dashboard 技术栈) | 复用现有 `//go:embed` 模式,`setup.html` 嵌入二进制 |
|
||||||
|
| 路由 | gorilla/mux(沿用) | 现有实现 |
|
||||||
|
| 构建 | 保持单二进制 | `//go:embed` 内嵌引导页与监控页 |
|
||||||
|
|
||||||
|
> 依赖注意:`modernc.org/sqlite` 体积较大(约 30-40MB 二进制),如介意可换 `mattn/go-sqlite3`(需 CGO,破坏单二进制),**本项目选前者**。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 5. 数据模型设计
|
||||||
|
|
||||||
|
### 5.1 `settings` 表(全局配置)
|
||||||
|
|
||||||
|
```sql
|
||||||
|
CREATE TABLE IF NOT EXISTS settings (
|
||||||
|
key TEXT PRIMARY KEY, -- 配置键名
|
||||||
|
value TEXT NOT NULL, -- 配置值(统一存字符串,读取时按需转换)
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now'))
|
||||||
|
);
|
||||||
|
```
|
||||||
|
|
||||||
|
初始化后必填的键:
|
||||||
|
|
||||||
|
| key | 说明 | 来源(原环境变量) |
|
||||||
|
|---|---|---|
|
||||||
|
| `api_key` | 火山 API Key | `BYTEDANCE_TTS_API_KEY` |
|
||||||
|
| `default_resource_id` | 默认资源 ID | `BYTEDANCE_TTS_RESOURCE_ID` |
|
||||||
|
| `default_speaker` | 默认音色 | `BYTEDANCE_TTS_SPEAKER` |
|
||||||
|
| `initialized` | 安装完成标记 `"1"` | —(双保险,配合 lock) |
|
||||||
|
|
||||||
|
可选键(读取时带默认值):
|
||||||
|
|
||||||
|
| key | 默认值 | 来源 |
|
||||||
|
|---|---|---|
|
||||||
|
| `default_format` | `mp3` | `BYTEDANCE_TTS_FORMAT` |
|
||||||
|
| `sample_rate` | `24000` | `BYTEDANCE_TTS_SAMPLE_RATE` |
|
||||||
|
| `timeout` | `30s` | `BYTEDANCE_TTS_TIMEOUT` |
|
||||||
|
| `model` | 空 | `BYTEDANCE_TTS_MODEL` |
|
||||||
|
| `model_type` | 空 | `BYTEDANCE_TTS_MODEL_TYPE` |
|
||||||
|
| `explicit_language` | 空 | `BYTEDANCE_TTS_EXPLICIT_LANGUAGE` |
|
||||||
|
| `enable_subtitle` | `false` | `BYTEDANCE_TTS_ENABLE_SUBTITLE` |
|
||||||
|
|
||||||
|
> 迁移建议:首次安装时若检测到旧的对应环境变量仍存在,可作为引导页**预填默认值**(仅预填,不替代库),便于老用户平滑迁移。
|
||||||
|
|
||||||
|
### 5.2 `voices` 表(音色库)
|
||||||
|
|
||||||
|
```sql
|
||||||
|
CREATE TABLE IF NOT EXISTS voices (
|
||||||
|
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
||||||
|
name TEXT NOT NULL UNIQUE, -- 对外 voice 名,请求里 voice 字段查它
|
||||||
|
speaker TEXT NOT NULL, -- 火山音色 ID(复刻音色以 S_ 开头)
|
||||||
|
resource_id TEXT NOT NULL, -- 对应火山资源 ID(决定计费/模型族)
|
||||||
|
model TEXT DEFAULT '', -- 子模型 seed-tts-2.0-standard / -expressive
|
||||||
|
language TEXT DEFAULT '', -- 显式语种(可选)
|
||||||
|
description TEXT DEFAULT '', -- 备注
|
||||||
|
enabled INTEGER NOT NULL DEFAULT 1, -- 0/1 启用
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now'))
|
||||||
|
);
|
||||||
|
CREATE UNIQUE INDEX IF NOT EXISTS idx_voices_name ON voices(name);
|
||||||
|
```
|
||||||
|
|
||||||
|
> 默认音色:`settings.default_speaker` 表示请求**未传 voice** 时用的音色;也可以约定默认 voice 名为 `default` 的行,二选一,建议用 settings 字段(更直观)。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 6. 安装与启动流程设计
|
||||||
|
|
||||||
|
### 6.1 lock 判据
|
||||||
|
|
||||||
|
- lock 文件:`<DB目录>/installed.lock`(与 `tts.db` 同目录)。
|
||||||
|
- **存在 = 已成功完成过安装**;不存在 = 未安装。
|
||||||
|
- lock 内容:一行文本 `version <版本号> <初始化时间>`,便于未来判断是否需要重装/迁移。
|
||||||
|
- 写入时机:**先写库、后写 lock**(`/api/setup` 成功后、且通过完整性校验后才原子创建 lock),避免"lock 在、库是半成品"。
|
||||||
|
- **不用 `.db` 文件是否存在作为安装判据**(建表会自动创建 db 文件,无法区分"从未安装"和"已安装")。
|
||||||
|
|
||||||
|
### 6.2 启动判定流程
|
||||||
|
|
||||||
|
```
|
||||||
|
main 启动
|
||||||
|
├─ 解析引导环境变量(TTS_DB_PATH / PORT / 初始化凭证)
|
||||||
|
├─ store.Open()(打开/创建 SQLite,自动建表)
|
||||||
|
│
|
||||||
|
├─ installed.lock 不存在?
|
||||||
|
│ └─ YES → 进入【安装模式】:仅开放 /setup(静态资源 + 引导页 + POST /api/setup)
|
||||||
|
│ 其余路由(/v1/audio/speech、/api/voices 等)→ 503 + 跳转 /setup
|
||||||
|
│ └─ NO → 尝试读库 + PRAGMA integrity_check
|
||||||
|
│ ├─ 通过 → 加载 settings/voices 到内存缓存 → 【正常模式】
|
||||||
|
│ └─ 失败 → 备份 tts.db → tts.db.corrupt-<时间戳>
|
||||||
|
│ → 删除 installed.lock → 进入【安装模式】
|
||||||
|
│
|
||||||
|
└─ 打印启动摘要(模式 / DB路径 / lock状态 / 音色数)
|
||||||
|
```
|
||||||
|
|
||||||
|
### 6.3 损坏回退规则
|
||||||
|
|
||||||
|
1. 只在 lock 存在但库打不开 / `integrity_check` 失败时触发回退;
|
||||||
|
2. **先备份**:损坏的 `.db` 改名 `tts.db.corrupt-<ts>` 留档,不直接删除;
|
||||||
|
3. 删除 `installed.lock`,进入安装模式;
|
||||||
|
4. 日志明确打印回退原因(文件损坏 / 权限 / 磁盘 / 版本等),便于排查;
|
||||||
|
5. 回退后用户重新走 `/setup` 即可恢复。
|
||||||
|
|
||||||
|
### 6.4 setup 劫持防护(必须)
|
||||||
|
|
||||||
|
安装模式是"谁先访问谁配置",公网暴露时存在被抢先初始化的风险。防护方案(至少一项):
|
||||||
|
|
||||||
|
- **A(推荐)初始化凭证**:启动时打印一次性 setup token(或从环境变量 `TTS_ADMIN_KEY` 指定),引导页提交时必须带 token,校验通过才写入;
|
||||||
|
- **B 回环限制**:安装模式下 `/setup` 仅允许本机回环地址访问(`127.0.0.1`),初始化完成后即失效;
|
||||||
|
- 二者可叠加。初始化完成后 `/api/setup` 永久关闭。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 7. 接口设计
|
||||||
|
|
||||||
|
### 7.1 安装相关
|
||||||
|
|
||||||
|
| 方法 | 路径 | 说明 | 鉴权 |
|
||||||
|
|---|---|---|---|
|
||||||
|
| GET | `/setup` | 引导页 HTML(`//go:embed`) | 安装模式开放 |
|
||||||
|
| GET | `/api/setup/status` | 返回 `{installed: bool}`,供引导页判断 | 无 |
|
||||||
|
| POST | `/api/setup` | 提交初始配置(全局 + 音色列表 + token)→ 写库 → 写 lock | 初始化凭证 |
|
||||||
|
|
||||||
|
`POST /api/setup` 请求体示例:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"token": "一次性凭证",
|
||||||
|
"settings": {
|
||||||
|
"api_key": "xxx",
|
||||||
|
"default_resource_id": "volc.megatts.default",
|
||||||
|
"default_speaker": "zh_female_qingxin",
|
||||||
|
"default_format": "mp3",
|
||||||
|
"sample_rate": 24000
|
||||||
|
},
|
||||||
|
"voices": [
|
||||||
|
{ "name": "qian", "speaker": "S_xxx", "resource_id": "volc.megatts.icl", "model": "seed-tts-2.0-standard" },
|
||||||
|
{ "name": "xun", "speaker": "S_yyy", "resource_id": "volc.megatts.icl", "model": "seed-tts-2.0-expressive" }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
响应:`200 {ok:true, message:"installed"}` 或 `400/401/409`。
|
||||||
|
|
||||||
|
### 7.2 音色管理(正常模式)
|
||||||
|
|
||||||
|
| 方法 | 路径 | 说明 |
|
||||||
|
|---|---|---|
|
||||||
|
| GET | `/api/voices` | 列表(可分页/过滤 enabled) |
|
||||||
|
| POST | `/api/voices` | 新增音色(name 唯一冲突返回 409) |
|
||||||
|
| PUT | `/api/voices/:id` | 更新音色 |
|
||||||
|
| DELETE | `/api/voices/:id` | 删除音色(`default_speaker` 引用的音色禁止删除) |
|
||||||
|
|
||||||
|
鉴权:复用现有 `OPENAI_TTS_API_KEY`(Bearer)。若安装后用户未配置管理 Key,可提示在 settings 中配置。
|
||||||
|
|
||||||
|
### 7.3 语音合成(改造点)
|
||||||
|
|
||||||
|
`/v1/audio/speech` 改造逻辑:
|
||||||
|
|
||||||
|
```
|
||||||
|
收到请求
|
||||||
|
├─ voice 为空 → 用 settings.default_speaker(无默认 → 400 "no default voice")
|
||||||
|
├─ voice 非空 → 查 voices 表
|
||||||
|
│ ├─ 命中 → 用该行 speaker/resource_id/model/language 覆盖 opts
|
||||||
|
│ └─ 未命中 → 400 "unknown voice: <name>"
|
||||||
|
├─ model 非空 → 查库/映射(本期:model 仅校验长度,不做映射,或按 settings 默认)
|
||||||
|
└─ 其余逻辑不变(格式解析、speed、鉴权、限流、埋点)
|
||||||
|
```
|
||||||
|
|
||||||
|
### 7.4 现有端点(不变)
|
||||||
|
|
||||||
|
`/health`、`/metrics`、`/dashboard`、`/` 行为保持;但**安装模式下**除 `/setup` 外统一返回 503(`/health` 可返回 `installed:false` 便于部署探针识别未初始化)。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 8. 模块划分与代码改动清单
|
||||||
|
|
||||||
|
### 8.1 新增包
|
||||||
|
|
||||||
|
| 包 | 职责 | 关键文件 |
|
||||||
|
|---|---|---|
|
||||||
|
| `store/` | SQLite 访问层:打开/建表/迁移、settings CRUD、voices CRUD、integrity_check | `db.go`、`settings.go`、`voices.go`、`migrate.go` |
|
||||||
|
| `installer/` | 安装状态:lock 检测/创建/删除、安装模式判定、损坏回退 | `lock.go`、`bootstrap.go` |
|
||||||
|
|
||||||
|
### 8.2 改造文件
|
||||||
|
|
||||||
|
| 文件 | 改动 |
|
||||||
|
|---|---|
|
||||||
|
| `router/router.go` | 新增 `/setup`、`/api/setup/*`、`/api/voices`;安装模式路由守卫 |
|
||||||
|
| `controller/` | 新增 `setup.go`(安装提交)、`voices.go`(CRUD);改造 `tts.go`(voice 查库路由) |
|
||||||
|
| `middleware/` | 新增 `installguard.go`(安装模式拦截,未安装非 `/setup` → 503) |
|
||||||
|
| `setting/config.go` | 收敛:仅读 `TTS_DB_PATH`、`PORT`、初始化凭证;启动汇总展示"模式/lock/音色数" |
|
||||||
|
| `main.go` | 启动流程:初始化 DB → 安装检测 → 模式分支 |
|
||||||
|
| `router/setup.html` | 新增引导页(Vue3 + axios,`//go:embed`) |
|
||||||
|
| `go.mod` | 新增 `modernc.org/sqlite` |
|
||||||
|
| `.env.example` / `README.md` / `docker-compose.yml` | 更新为新的引导参数与首次安装说明 |
|
||||||
|
|
||||||
|
### 8.3 环境变量收敛表
|
||||||
|
|
||||||
|
**迁移前(现状,会持续膨胀):**
|
||||||
|
|
||||||
|
```
|
||||||
|
BYTEDANCE_TTS_API_KEY
|
||||||
|
BYTEDANCE_TTS_RESOURCE_ID
|
||||||
|
BYTEDANCE_TTS_SPEAKER
|
||||||
|
BYTEDANCE_TTS_FORMAT
|
||||||
|
BYTEDANCE_TTS_SAMPLE_RATE
|
||||||
|
BYTEDANCE_TTS_BIT_RATE
|
||||||
|
BYTEDANCE_TTS_MODEL
|
||||||
|
BYTEDANCE_TTS_MODEL_TYPE
|
||||||
|
BYTEDANCE_TTS_EXPLICIT_LANGUAGE
|
||||||
|
BYTEDANCE_TTS_ENABLE_SUBTITLE
|
||||||
|
BYTEDANCE_TTS_TIMEOUT
|
||||||
|
BYTEDANCE_TTS_DEBUG
|
||||||
|
OPENAI_TTS_API_KEY
|
||||||
|
ALLOWED_ORIGINS
|
||||||
|
TRUSTED_PROXY_HOPS
|
||||||
|
PORT
|
||||||
|
```
|
||||||
|
|
||||||
|
**迁移后(仅引导参数,其余进库):**
|
||||||
|
|
||||||
|
```
|
||||||
|
TTS_DB_PATH # 数据库/lock 目录(默认 ./)
|
||||||
|
PORT # 监听端口
|
||||||
|
TTS_ADMIN_KEY # 安装初始化凭证(可选,不设则启动打印一次性 token)
|
||||||
|
OPENAI_TTS_API_KEY # 管理 API / 合成 API 鉴权(可选,迁移进 settings 或保留)
|
||||||
|
ALLOWED_ORIGINS # CORS(可保留,属运行环境而非业务配置)
|
||||||
|
TRUSTED_PROXY_HOPS # 反代拓扑参数(保留,属部署环境)
|
||||||
|
```
|
||||||
|
|
||||||
|
> `BYTEDANCE_TTS_DEBUG`、`TRUSTED_PROXY_HOPS`、`ALLOWED_ORIGINS` 属"部署/运维环境"而非"业务配置",可留在 env;其余 TTS 业务配置全部进库。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 9. 安全设计
|
||||||
|
|
||||||
|
| 项 | 措施 |
|
||||||
|
|---|---|
|
||||||
|
| Setup 劫持 | 初始化凭证(`TTS_ADMIN_KEY` 或一次性 token)+ 可选回环限制;完成后 `/api/setup` 永久关闭 |
|
||||||
|
| 合成/管理鉴权 | 复用 `OPENAI_TTS_API_KEY`(Bearer);voice 路由不绕过鉴权 |
|
||||||
|
| 敏感信息 | API Key 在引导页只进不出;日志/`/health` 不回显明文 Key(沿用 `maskAPIKey`) |
|
||||||
|
| 输入校验 | voice 名白名单(字母数字 `_-`)、长度限制;SQL 全部参数化,防注入 |
|
||||||
|
| lock/DB 写入 | 先写库后写 lock;lock 原子创建;损坏先备份再回退 |
|
||||||
|
| 默认音色保护 | 删除被 `default_speaker` 引用的音色时拒绝(409) |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 10. 开发计划与里程碑
|
||||||
|
|
||||||
|
| 里程碑 | 内容 | 验收标准 |
|
||||||
|
|---|---|---|
|
||||||
|
| M1 存储层 | `store/` 包:SQLite 接入、两表建表、迁移、settings/voices CRUD、`integrity_check` | `go build` 通过;单测覆盖 CRUD |
|
||||||
|
| M2 安装流程 | `installer/`:lock 检测/创建/删除、安装模式判定、损坏回退;`middleware/installguard` | 无 lock → 安装模式;有 lock → 正常模式;损坏库 → 备份+回退 |
|
||||||
|
| M3 引导 UI | `/setup` 引导页 + `POST /api/setup`(token 校验、写库、写 lock) | 首次访问可完成安装;重复安装被拒;token 错误 401 |
|
||||||
|
| M4 音色路由 | `/api/voices` CRUD + `/v1/audio/speech` voice 查库路由 | 新增音色后 voice 生效;未知 voice 400;默认音色兜底 |
|
||||||
|
| M5 收敛与文档 | `setting/` 收敛、`.env.example`/README/部署更新、启动摘要展示模式与音色数 | 迁移后仅引导 env;文档与行为一致 |
|
||||||
|
| M6 测试收尾 | 覆盖 lock 判定、setup 流程、voice 路由、损坏回退的集成测试 | 关键路径有自动化测试 |
|
||||||
|
|
||||||
|
建议 M1→M2 连续做(安装流程是主链路),M3 与 M2 可并行;M4 依赖 M1 完成。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 11. 风险与对策
|
||||||
|
|
||||||
|
| 风险 | 影响 | 对策 |
|
||||||
|
|---|---|---|
|
||||||
|
| `modernc.org/sqlite` 体积增大 | 单二进制从 ~7MB 增至 ~40MB | 接受;如不可接受改 CGO 版(牺牲单文件) |
|
||||||
|
| Setup 劫持(公网部署) | 他人抢先配置 | 初始化凭证 + 回环限制 + 完成后关闭端点(见 6.4) |
|
||||||
|
| 库损坏导致服务不可用 | 服务起不来 | 自愈回退:备份 + 删 lock + 重新安装(见 6.3) |
|
||||||
|
| 老用户迁移 | 现有 env 用户升级后无库 | 引导页预填旧 env 值;README 给出迁移步骤 |
|
||||||
|
| voice 名冲突/默认引用 | 删除默认音色致不可用 | 唯一约束 + 默认音色删除保护(409) |
|
||||||
|
| 并发写库 | 数据竞争 | 单写锁(`database/sql` 默认 + 业务层互斥),单用户场景风险低 |
|
||||||
|
| 表结构未来升级 | 旧库不兼容 | lock 内容带版本号;`migrate.go` 预留版本迁移 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 12. 验收标准(本期 MVP)
|
||||||
|
|
||||||
|
1. 删除所有业务 env 后,首次启动进入 `/setup` 引导页,可完成安装(全局 + ≥1 音色);
|
||||||
|
2. 安装完成后有 `installed.lock`,重启进入正常模式,`/v1/audio/speech` 可用;
|
||||||
|
3. 通过 `/api/voices` 新增音色后,请求带该 `voice` 能正常合成;未知 voice 返回 400;
|
||||||
|
4. 未传 `voice` 时使用默认音色;
|
||||||
|
5. 手动制造损坏库 → 自动备份 `.corrupt-*` 并删 lock 回退安装模式;
|
||||||
|
6. 安装模式下 `/v1/audio/speech` 返回 503 或跳转 `/setup`;
|
||||||
|
7. 单二进制运行,无外部文件依赖(引导页已 embed)。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 13. 非目标(明确不做)
|
||||||
|
|
||||||
|
- 本期不做多服务商聚合、流式输出、缓存、字幕透出、ASR;
|
||||||
|
- 不做完整的运营管理后台(仅引导页,管理 API 先行);
|
||||||
|
- 不做多租户/多用户体系(个人自用,单管理员)。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*文档版本:v0.1 · 状态:待评审 · 配套代码基线:Volcano-Engine-TTS-UI @ develop*
|
||||||
@@ -63,7 +63,7 @@ tts-api.exe
|
|||||||
|--------|------|--------|
|
|--------|------|--------|
|
||||||
| `BYTEDANCE_TTS_TIMEOUT` | 单次合成超时 | `30s` |
|
| `BYTEDANCE_TTS_TIMEOUT` | 单次合成超时 | `30s` |
|
||||||
| `BYTEDANCE_TTS_FORMAT` | 上游实际请求的音频格式(mp3 / pcm / ogg_opus);客户端要求 wav 时内部自动转 pcm + 本地拼 WAV 头 | `mp3` |
|
| `BYTEDANCE_TTS_FORMAT` | 上游实际请求的音频格式(mp3 / pcm / ogg_opus);客户端要求 wav 时内部自动转 pcm + 本地拼 WAV 头 | `mp3` |
|
||||||
| `BYTEDANCE_TTS_SAMPLE_RATE` | 上游采样率(8000 / 16000 / 22050 / 24000 / 32000 / 44100 / 48000) | `24000` |
|
| `BYTEDANCE_TTS_SAMPLE_RATE` | 上游采样率(8000 / 16000 / 22050 / 24000 / 32000 / 44100 / 48000);**此值直接写入 WAV 头,需与上游实际 PCM 采样率一致,否则音频变速变调** | `24000` |
|
||||||
| `BYTEDANCE_TTS_BIT_RATE` | MP3 比特率,仅 mp3 生效 | 无 |
|
| `BYTEDANCE_TTS_BIT_RATE` | MP3 比特率,仅 mp3 生效 | 无 |
|
||||||
|
|
||||||
### 复刻 2.0 扩展参数
|
### 复刻 2.0 扩展参数
|
||||||
@@ -79,10 +79,87 @@ tts-api.exe
|
|||||||
|
|
||||||
| 变量名 | 说明 | 默认值 |
|
| 变量名 | 说明 | 默认值 |
|
||||||
|--------|------|--------|
|
|--------|------|--------|
|
||||||
| `OPENAI_TTS_API_KEY` | OpenAI 兼容接口的 API Key(逗号分隔支持多个) | 无(不鉴权) |
|
| `OPENAI_TTS_API_KEY` | 🔴 **公网必设** OpenAI 兼容接口的 API Key(逗号分隔支持多个);**未设置时鉴权完全关闭** | 无(不鉴权) |
|
||||||
|
| `TRUSTED_PROXY_HOPS` | X-Forwarded-For 解析模式(0=启发式/默认,>0=精确 N 跳) | `0`(启发式) |
|
||||||
| `PORT` | 服务监听端口 | `8080` |
|
| `PORT` | 服务监听端口 | `8080` |
|
||||||
| `ALLOWED_ORIGINS` | CORS 跨域白名单(逗号分隔,调试可设 `*`;空则拒绝所有跨域) | 无 |
|
| `ALLOWED_ORIGINS` | CORS 跨域白名单(逗号分隔,调试可设 `*`;空则拒绝所有跨域) | 无 |
|
||||||
|
|
||||||
|
### 反代拓扑与 X-Forwarded-For 解析
|
||||||
|
|
||||||
|
当服务部署在反代(nginx / caddy / CDN)后面时,反代会通过 `X-Forwarded-For`(XFF)头传递真实客户端 IP。本服务通过 `TRUSTED_PROXY_HOPS` 环境变量控制 XFF 解析方式,支持两种模式。
|
||||||
|
|
||||||
|
#### 何时需要关心这个配置
|
||||||
|
|
||||||
|
| 部署方式 | 是否需要配置 |
|
||||||
|
|---|---|
|
||||||
|
| 服务直接暴露公网 IP(无反代)| ❌ 不适用,跳过本节 |
|
||||||
|
| 服务前有 1 个反代(nginx / caddy)| ❌ 不必配置,启发式模式自动处理 |
|
||||||
|
| 服务前有 2 跳以上反代(CDN + 自建反代)| ⚠️ 启发式模式"够用",需要精准按真实 client 限流时再设 |
|
||||||
|
|
||||||
|
> **直出部署(无反代)的用户**:本节不适用,跳过阅读。`TRUSTED_PROXY_HOPS` 在你的部署下不会被读取。
|
||||||
|
|
||||||
|
#### 启发式模式(默认 / `TRUSTED_PROXY_HOPS=0`)
|
||||||
|
|
||||||
|
从 XFF 链尾向前扫描,**跳过私有 IP,返回第一个公网 IP**。
|
||||||
|
|
||||||
|
适用场景:单跳反代(最常见)、多跳含公网代理(CDN + nginx)。
|
||||||
|
|
||||||
|
**行为示例**:
|
||||||
|
|
||||||
|
| XFF 链 | 启发式返回 | 备注 |
|
||||||
|
|---|---|---|
|
||||||
|
| `1.2.3.4` | `1.2.3.4` | 单跳,真实 client |
|
||||||
|
| `fake, 1.2.3.4` | `1.2.3.4` | 攻击者伪造首值,跳过 fake |
|
||||||
|
| `1.2.3.4, 5.6.7.8, 10.0.0.1` | `5.6.7.8` | 多跳,返回最末公网 IP(CDN 边缘) |
|
||||||
|
| `1.2.3.4, 192.168.1.1` | `1.2.3.4` | 链尾是私有 IP,跳过 |
|
||||||
|
|
||||||
|
**优点**:零配置,大多数部署自动正确。
|
||||||
|
|
||||||
|
**限制**:多跳 CDN 场景下,限流粒度为"按 CDN 边缘 IP"而非"按真实 client"。攻击者填满某 CDN 边缘配额可能影响该 CDN 下的其他用户——但无法伪造身份、无法越权。
|
||||||
|
|
||||||
|
#### 精确模式(`TRUSTED_PROXY_HOPS=N`,N > 0)
|
||||||
|
|
||||||
|
从 XFF 链尾倒数第 N+1 个位置取值,即"信任最近 N 跳反代,取该信任链之前那一跳的 IP"。
|
||||||
|
|
||||||
|
适用场景:多跳 CDN + 反代,且需要精准按真实 client 限流。
|
||||||
|
|
||||||
|
**N 的确定方法**:统计客户端到本服务之间的反代跳数。
|
||||||
|
|
||||||
|
| 拓扑 | 跳数 | 配置 |
|
||||||
|
|---|---|---|
|
||||||
|
| `client → nginx → 本服务` | 1 | `TRUSTED_PROXY_HOPS=1` |
|
||||||
|
| `client → Cloudflare → nginx → 本服务` | 2 | `TRUSTED_PROXY_HOPS=2` |
|
||||||
|
| `client → CDN → WAF → nginx → 本服务` | 3 | `TRUSTED_PROXY_HOPS=3` |
|
||||||
|
|
||||||
|
**行为对比**(以 `client(1.2.3.4) → CDN(203.0.113.5) → nginx(10.0.0.1) → 本服务` 为例,XFF 链 = `1.2.3.4, 203.0.113.5`):
|
||||||
|
|
||||||
|
| `TRUSTED_PROXY_HOPS` | 返回 | 评价 |
|
||||||
|
|---|---|---|
|
||||||
|
| 0(默认启发式)| `203.0.113.5` | CDN 边缘 IP,限流粒度粗 |
|
||||||
|
| 1(数到 nginx,未穿透)| `203.0.113.5` | 配置不当,与默认相同 |
|
||||||
|
| 2(穿透到真实 client)| `1.2.3.4` | 精准到真实 client ✓ |
|
||||||
|
| 3(超出实际跳数)| `directIP`(链长不足保护)| 配置错误,需修正 |
|
||||||
|
|
||||||
|
#### 为什么两种模式都从链尾扫描
|
||||||
|
|
||||||
|
XFF 链的第一个值是**客户端可控**的:攻击者可以发送任意 `X-Forwarded-For: 1.2.3.4`,若反代用追加模式(如 nginx 默认的 `$proxy_add_x_forwarded_for`),链尾才会追加真实 IP。
|
||||||
|
|
||||||
|
若代码取首值,攻击者每次换伪造 IP 即可绕过 IP 限流,也可伪装成受害 IP 把其配额耗尽(间接 DoS)。两种模式都从链尾扫描,天然免疫这种攻击。
|
||||||
|
|
||||||
|
#### 验证当前模式
|
||||||
|
|
||||||
|
启动期日志会显示当前模式:
|
||||||
|
|
||||||
|
```
|
||||||
|
TRUSTED_PROXY_HOPS 未设置,使用默认启发式模式(XFF 链尾第一个公网 IP)
|
||||||
|
# 或
|
||||||
|
已配置 TRUSTED_PROXY_HOPS=0(启发式模式,等同默认)
|
||||||
|
# 或
|
||||||
|
已配置 TRUSTED_PROXY_HOPS=2(精确模式,信任 2 跳反代)
|
||||||
|
```
|
||||||
|
|
||||||
|
也可在 `GetClientIP` 临时加 `log.Printf` 打印解析结果,或参考已有的 `middleware/ratelimit_test.go`(24 个 XFF 表驱动用例)来扩展更多 XFF 链场景。生产环境不要保留 debug 日志。
|
||||||
|
|
||||||
### Resource ID 说明
|
### Resource ID 说明
|
||||||
|
|
||||||
| Resource ID | 模型说明 |
|
| Resource ID | 模型说明 |
|
||||||
@@ -166,6 +243,8 @@ CORS拦截: 来源="https://..." 路径=/v1/audio/speech 方法=POST 客户端=.
|
|||||||
|
|
||||||
## API 使用说明
|
## API 使用说明
|
||||||
|
|
||||||
|
> ⚠️ **公网部署前必读**:如果你的服务暴露在公网,**必须**设置 `OPENAI_TTS_API_KEY` 或由前置反代(nginx / caddy)承担鉴权。未设置时 `Authorization` 头完全跳过校验,任何能访问 `:8080` 的人都能调用 TTS 合成,消耗你的火山额度。详见[部署 → 公网安全清单](#公网部署安全清单)。
|
||||||
|
|
||||||
### OpenAI 兼容接口
|
### OpenAI 兼容接口
|
||||||
|
|
||||||
**端点:** `POST /v1/audio/speech`
|
**端点:** `POST /v1/audio/speech`
|
||||||
@@ -191,7 +270,7 @@ CORS拦截: 来源="https://..." 路径=/v1/audio/speech 方法=POST 客户端=.
|
|||||||
- `input` — 要合成的文本
|
- `input` — 要合成的文本
|
||||||
- `voice` — 发音人(OpenAI 兼容,实际用 `BYTEDANCE_TTS_SPEAKER`)
|
- `voice` — 发音人(OpenAI 兼容,实际用 `BYTEDANCE_TTS_SPEAKER`)
|
||||||
- `response_format` — 输出格式:`mp3`(默认)/ `opus`(映射 ogg_opus)/ `wav` / `pcm` / `aac` / `flac`(降级到 mp3)
|
- `response_format` — 输出格式:`mp3`(默认)/ `opus`(映射 ogg_opus)/ `wav` / `pcm` / `aac` / `flac`(降级到 mp3)
|
||||||
- `speed` — 语速,0.25 ~ 4.0(火山侧转换为 speech_rate [-50, 100])
|
- `speed` — 语速倍率,客户端接受范围 0.25 ~ 4.0;**火山实际生效范围 0.5 ~ 2.0**(speech_rate [-50, 100]),超出范围会被静默截断,客户端无感反馈
|
||||||
|
|
||||||
**格式映射:**
|
**格式映射:**
|
||||||
|
|
||||||
@@ -281,6 +360,40 @@ scrape_configs:
|
|||||||
|
|
||||||
`/dashboard` 展示服务状态 + 内存 + 配置信息,并内嵌 `/metrics` 预览;Grafana 等工具可直接基于上面指标做面板。
|
`/dashboard` 展示服务状态 + 内存 + 配置信息,并内嵌 `/metrics` 预览;Grafana 等工具可直接基于上面指标做面板。
|
||||||
|
|
||||||
|
### ⚠️ 公网部署:监控端点无鉴权
|
||||||
|
|
||||||
|
`/metrics`、`/health`、`/dashboard` **均不鉴权**,这是对齐 Prometheus 抓取场景的设计权衡:
|
||||||
|
|
||||||
|
| 端点 | 暴露内容 | 风险 |
|
||||||
|
|---|---|---|
|
||||||
|
| `/metrics` | 业务标签(speaker/model/format)、运行指标、错误计数 | 侦察面:可推断使用量、技术栈、错误模式 |
|
||||||
|
| `/health` | 服务状态、版本号、运行时长、内存 | 侦察面:版本号可用于匹配已知 CVE |
|
||||||
|
| `/dashboard` | 配置检查结果(含 `TTSConfigErr` 状态) | 信息泄露:可确认配置是否就绪 |
|
||||||
|
|
||||||
|
**部署建议**:
|
||||||
|
|
||||||
|
- **内网 / 反代后**:无影响,符合预期
|
||||||
|
- **公网直接暴露**:在前置反代(nginx / caddy)上保护这些端点,示例 nginx 配置:
|
||||||
|
|
||||||
|
```nginx
|
||||||
|
location /metrics {
|
||||||
|
auth_basic "metrics";
|
||||||
|
auth_basic_user_file /etc/nginx/.htpasswd;
|
||||||
|
allow 10.0.0.0/8; # 仅允许 Prometheus 服务器网段
|
||||||
|
deny all;
|
||||||
|
}
|
||||||
|
location /dashboard {
|
||||||
|
auth_basic "admin";
|
||||||
|
auth_basic_user_file /etc/nginx/.htpasswd;
|
||||||
|
}
|
||||||
|
location /health {
|
||||||
|
allow 10.0.0.0/8; # 或保留给监控系统访问
|
||||||
|
deny all;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- **最简方案**:反代层直接限制 `/metrics` 只能从 Prometheus 服务器 IP 访问,无需 basic auth
|
||||||
|
|
||||||
## 架构
|
## 架构
|
||||||
|
|
||||||
| 包 | 职责 |
|
| 包 | 职责 |
|
||||||
@@ -333,6 +446,34 @@ docker compose up -d
|
|||||||
|
|
||||||
环境变量通过 `.env` 或 `docker-compose.yml` 传入。
|
环境变量通过 `.env` 或 `docker-compose.yml` 传入。
|
||||||
|
|
||||||
|
### 公网部署安全清单
|
||||||
|
|
||||||
|
公网直接暴露(`:8080` 可被互联网任意访问)时,**至少满足以下两条之一**,否则视为不安全的部署:
|
||||||
|
|
||||||
|
1. **设置 `OPENAI_TTS_API_KEY`**(推荐,最简单)
|
||||||
|
```bash
|
||||||
|
# .env
|
||||||
|
OPENAI_TTS_API_KEY=<32+ 位随机字符串>
|
||||||
|
```
|
||||||
|
客户端请求时带 `Authorization: Bearer <那个字符串>`。
|
||||||
|
|
||||||
|
2. **前置反代承担鉴权**(nginx / caddy / Cloudflare Access)
|
||||||
|
- 反代层做 basic auth、mTLS、Cloudflare Access 等任一方案
|
||||||
|
- 反代**仅**把鉴权后的请求转发到 `:8080`,Go 服务本身保持"无鉴权"
|
||||||
|
- 此时 `OPENAI_TTS_API_KEY` 可不设
|
||||||
|
|
||||||
|
**两个端点还需要单独保护**(无论上面哪种方案):
|
||||||
|
|
||||||
|
- `/metrics`:暴露业务标签与运行指标,详见[观测 / Metrics → 公网部署](#公网部署监控端点无鉴权)
|
||||||
|
- `/dashboard`:暴露配置检查结果,同上
|
||||||
|
|
||||||
|
**未做保护的典型风险**:
|
||||||
|
- 任意人 curl `POST /v1/audio/speech` → 消耗你火山账号的字符额度
|
||||||
|
- 任意人 `GET /metrics` → 推断你的使用量、技术栈、错误模式
|
||||||
|
- 任意人 `GET /dashboard` → 确认你 TTS 配置就绪状态
|
||||||
|
|
||||||
|
**内网部署 / 私网反代后**:这些警示不适用,直接用就行。
|
||||||
|
|
||||||
## 常见问题
|
## 常见问题
|
||||||
|
|
||||||
### 1. `code=55000000, message=resource ID is mismatched with speaker related resource`
|
### 1. `code=55000000, message=resource ID is mismatched with speaker related resource`
|
||||||
|
|||||||
@@ -6,10 +6,12 @@ import (
|
|||||||
"encoding/hex"
|
"encoding/hex"
|
||||||
"fmt"
|
"fmt"
|
||||||
"log"
|
"log"
|
||||||
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/volcano-tts/tts-api/common"
|
"github.com/volcano-tts/tts-api/common"
|
||||||
"github.com/volcano-tts/tts-api/dto"
|
"github.com/volcano-tts/tts-api/dto"
|
||||||
|
"github.com/volcano-tts/tts-api/telemetry"
|
||||||
)
|
)
|
||||||
|
|
||||||
// MetricsRecorder 是适配器向上报告埋点的接口。
|
// MetricsRecorder 是适配器向上报告埋点的接口。
|
||||||
@@ -82,7 +84,7 @@ func Synthesis(
|
|||||||
|
|
||||||
if common.DebugLog {
|
if common.DebugLog {
|
||||||
log.Printf("TTS upstream: resource_id=%s speaker=%s model=%q format=%s sample_rate=%d speech_rate=%d additions=%q",
|
log.Printf("TTS upstream: resource_id=%s speaker=%s model=%q format=%s sample_rate=%d speech_rate=%d additions=%q",
|
||||||
opts.ResourceID, opts.Speaker, opts.Model, opts.Format, opts.SampleRate, opts.SpeechRate, extractAdditionsForLog(body))
|
opts.ResourceID, telemetry.MaskSpeaker(opts.Speaker), opts.Model, opts.Format, opts.SampleRate, opts.SpeechRate, extractAdditionsForLog(body))
|
||||||
}
|
}
|
||||||
|
|
||||||
resp, err := client.PostStream(ctx, "https://openspeech.bytedance.com/api/v3/tts/unidirectional", headers, body)
|
resp, err := client.PostStream(ctx, "https://openspeech.bytedance.com/api/v3/tts/unidirectional", headers, body)
|
||||||
@@ -94,10 +96,13 @@ func Synthesis(
|
|||||||
|
|
||||||
if resp.StatusCode != 200 {
|
if resp.StatusCode != 200 {
|
||||||
rawBody := ReadErrorBody(resp.Body)
|
rawBody := ReadErrorBody(resp.Body)
|
||||||
|
// rawBody 来自上游响应体,可能是攻击者控制的恶意内容(例如包含
|
||||||
|
// \n 伪造日志行)。转义后再嵌入错误消息。
|
||||||
|
safeBody := strings.NewReplacer("\n", "\\n", "\r", "\\r").Replace(rawBody)
|
||||||
mtr.UpstreamFinished(opts.Speaker, opts.Model, opts.Format, fmt.Sprintf("http_%d", resp.StatusCode), time.Since(started), 0, 0, 0, resp.StatusCode)
|
mtr.UpstreamFinished(opts.Speaker, opts.Model, opts.Format, fmt.Sprintf("http_%d", resp.StatusCode), time.Since(started), 0, 0, 0, resp.StatusCode)
|
||||||
return nil, &UpstreamError{
|
return nil, &UpstreamError{
|
||||||
Code: resp.StatusCode,
|
Code: resp.StatusCode,
|
||||||
Message: fmt.Sprintf("upstream http %d: %s", resp.StatusCode, rawBody),
|
Message: fmt.Sprintf("upstream http %d: %s", resp.StatusCode, safeBody),
|
||||||
Stage: "http",
|
Stage: "http",
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -116,7 +121,14 @@ func Synthesis(
|
|||||||
duration := time.Since(started)
|
duration := time.Since(started)
|
||||||
|
|
||||||
finalData := parsed.AudioData
|
finalData := parsed.AudioData
|
||||||
|
// finalFormat 反映真实输出格式(用于 controller 写 Content-Type):
|
||||||
|
// - wav 走 pcm 上游 + 本地拼头,对外仍是 wav
|
||||||
|
// - aac/flac 在上方已被上游降级为 mp3,真实输出也是 mp3
|
||||||
|
// - 其余与 clientFormat 一致
|
||||||
finalFormat := clientFormat
|
finalFormat := clientFormat
|
||||||
|
if clientFormat != "wav" {
|
||||||
|
finalFormat = opts.Format
|
||||||
|
}
|
||||||
sampleRate := opts.SampleRate
|
sampleRate := opts.SampleRate
|
||||||
if clientFormat == "wav" {
|
if clientFormat == "wav" {
|
||||||
wav, wrapErr := WrapWAVHeader(parsed.AudioData, opts.SampleRate)
|
wav, wrapErr := WrapWAVHeader(parsed.AudioData, opts.SampleRate)
|
||||||
@@ -133,7 +145,7 @@ func Synthesis(
|
|||||||
mtr.UpstreamFinished(opts.Speaker, opts.Model, opts.Format, "ok", duration, parsed.FirstChunk, parsed.Chunks, len(finalData), 0)
|
mtr.UpstreamFinished(opts.Speaker, opts.Model, opts.Format, "ok", duration, parsed.FirstChunk, parsed.Chunks, len(finalData), 0)
|
||||||
|
|
||||||
log.Printf("TTS 合成成功 - 音色=%s 格式=%s 文本=%d字 音频=%d字节 分片=%d 耗时=%v",
|
log.Printf("TTS 合成成功 - 音色=%s 格式=%s 文本=%d字 音频=%d字节 分片=%d 耗时=%v",
|
||||||
opts.Speaker, clientFormat, len(text), len(finalData), parsed.Chunks, duration)
|
telemetry.MaskSpeaker(opts.Speaker), clientFormat, len(text), len(finalData), parsed.Chunks, duration)
|
||||||
|
|
||||||
return &dto.SynthesisResult{
|
return &dto.SynthesisResult{
|
||||||
AudioData: finalData,
|
AudioData: finalData,
|
||||||
|
|||||||
@@ -0,0 +1,130 @@
|
|||||||
|
// dumpdb 是个 ops 工具: dump tts.db 里的 settings + voices 表(明文打码)。
|
||||||
|
//
|
||||||
|
// 用法:
|
||||||
|
// go run ./cmd/dumpdb /path/to/tts.db
|
||||||
|
//
|
||||||
|
// 输出 schema_version / settings(键值,敏感字段打码) / voices(完整行)。
|
||||||
|
// 调试时方便:不依赖 sqlite3 CLI,不暴露明文 key/speaker ID。
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"database/sql"
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
|
||||||
|
_ "modernc.org/sqlite"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
if len(os.Args) < 2 {
|
||||||
|
fmt.Fprintf(os.Stderr, "usage: %s <db-path>\n", os.Args[0])
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
dbPath := os.Args[1]
|
||||||
|
|
||||||
|
dsn := "file:" + dbPath + "?mode=ro&_pragma=query_only"
|
||||||
|
conn, err := sql.Open("sqlite", dsn)
|
||||||
|
if err != nil {
|
||||||
|
fmt.Fprintf(os.Stderr, "open: %v\n", err)
|
||||||
|
os.Exit(2)
|
||||||
|
}
|
||||||
|
defer conn.Close()
|
||||||
|
|
||||||
|
// 1. tables
|
||||||
|
fmt.Println("=== Tables ===")
|
||||||
|
rows, _ := conn.Query("SELECT name FROM sqlite_master WHERE type='table' ORDER BY name")
|
||||||
|
for rows.Next() {
|
||||||
|
var name string
|
||||||
|
_ = rows.Scan(&name)
|
||||||
|
fmt.Printf(" %s\n", name)
|
||||||
|
}
|
||||||
|
rows.Close()
|
||||||
|
|
||||||
|
// 2. schema_version
|
||||||
|
fmt.Println("\n=== schema_version ===")
|
||||||
|
var ver int
|
||||||
|
var ts string
|
||||||
|
err = conn.QueryRow(`SELECT version, applied_at FROM schema_version LIMIT 1`).Scan(&ver, &ts)
|
||||||
|
if err != nil {
|
||||||
|
fmt.Printf(" (no row: %v)\n", err)
|
||||||
|
} else {
|
||||||
|
fmt.Printf(" version: %d, applied_at: %s\n", ver, ts)
|
||||||
|
}
|
||||||
|
|
||||||
|
// 3. settings
|
||||||
|
fmt.Println("\n=== settings ===")
|
||||||
|
rows, err = conn.Query(`SELECT key, value FROM settings ORDER BY key`)
|
||||||
|
if err != nil {
|
||||||
|
fmt.Printf(" err: %v\n", err)
|
||||||
|
} else {
|
||||||
|
for rows.Next() {
|
||||||
|
var k, v string
|
||||||
|
_ = rows.Scan(&k, &v)
|
||||||
|
if v == "" {
|
||||||
|
fmt.Printf(" %-30s = (empty)\n", k)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
lowK := k
|
||||||
|
_ = lowK
|
||||||
|
masked := v
|
||||||
|
if isSensitive(k) {
|
||||||
|
if len(v) <= 8 {
|
||||||
|
masked = "****"
|
||||||
|
} else {
|
||||||
|
masked = v[:4] + "****" + v[len(v)-4:]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
fmt.Printf(" %-30s = %s\n", k, masked)
|
||||||
|
}
|
||||||
|
rows.Close()
|
||||||
|
}
|
||||||
|
|
||||||
|
// 4. voices
|
||||||
|
fmt.Println("\n=== voices ===")
|
||||||
|
rows, err = conn.Query(`SELECT id, name, speaker, resource_id, model, language, description, enabled, created_at, updated_at FROM voices ORDER BY id`)
|
||||||
|
if err != nil {
|
||||||
|
fmt.Printf(" err: %v\n", err)
|
||||||
|
} else {
|
||||||
|
count := 0
|
||||||
|
for rows.Next() {
|
||||||
|
count++
|
||||||
|
var id int64
|
||||||
|
var name, speaker, resourceID, model, lang, desc, created, updated string
|
||||||
|
var enabled int
|
||||||
|
_ = rows.Scan(&id, &name, &speaker, &resourceID, &model, &lang, &desc, &enabled, &created, &updated)
|
||||||
|
en := "true"
|
||||||
|
if enabled == 0 {
|
||||||
|
en = "false"
|
||||||
|
}
|
||||||
|
fmt.Printf(" [%d] name=%s\n speaker=%s\n resource_id=%s\n model=%s\n lang=%s enabled=%s\n created=%s updated=%s\n",
|
||||||
|
id, name, speaker, resourceID, model, lang, en, created, updated)
|
||||||
|
if desc != "" {
|
||||||
|
fmt.Printf(" desc: %s\n", desc)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
fmt.Printf(" total: %d\n", count)
|
||||||
|
rows.Close()
|
||||||
|
}
|
||||||
|
|
||||||
|
// 5. pragmas
|
||||||
|
fmt.Println("\n=== Pragmas ===")
|
||||||
|
for _, p := range []string{"journal_mode", "synchronous", "foreign_keys", "page_size", "page_count"} {
|
||||||
|
var v string
|
||||||
|
_ = conn.QueryRow("PRAGMA " + p).Scan(&v)
|
||||||
|
fmt.Printf(" %-15s = %s\n", p, v)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func isSensitive(key string) bool {
|
||||||
|
lowK := key
|
||||||
|
// 简单 contains (不引 strings 包保持精简)
|
||||||
|
markers := []string{"key", "token", "speaker"}
|
||||||
|
for _, m := range markers {
|
||||||
|
for i := 0; i+len(m) <= len(lowK); i++ {
|
||||||
|
if lowK[i:i+len(m)] == m {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
+19
-2
@@ -15,10 +15,27 @@ const (
|
|||||||
MaxRequestBodySize = 1024 * 1024
|
MaxRequestBodySize = 1024 * 1024
|
||||||
RateLimitRequests = 100
|
RateLimitRequests = 100
|
||||||
RateLimitWindow = time.Minute
|
RateLimitWindow = time.Minute
|
||||||
MaxResponseTimes = 100
|
|
||||||
MaxErrors = 10
|
|
||||||
MaxConcurrentRequests = 10
|
MaxConcurrentRequests = 10
|
||||||
CleanupInterval = time.Hour
|
CleanupInterval = time.Hour
|
||||||
MaxModelNameLength = 64
|
MaxModelNameLength = 64
|
||||||
MaxRateLimiterEntries = 100000
|
MaxRateLimiterEntries = 100000
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// SecureEqualString 是常量时间字符串比较,防 token 计时攻击。
|
||||||
|
// 长度先比对(避免短串早返回时泄漏长度信息),再遍历每个字节做 XOR 累加;
|
||||||
|
// diff 为 0 才返 true。用于 Bearer token、setup token 等敏感比较场景。
|
||||||
|
func SecureEqualString(a, b string) bool {
|
||||||
|
if len(a) != len(b) {
|
||||||
|
// 先比对长度(避免短串早返回时泄漏长度信息)
|
||||||
|
// 但仍要遍历一遍避免优化器消除分支
|
||||||
|
if len(a) > 0 {
|
||||||
|
_ = a[0]
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
var diff byte
|
||||||
|
for i := 0; i < len(a); i++ {
|
||||||
|
diff |= a[i] ^ b[i]
|
||||||
|
}
|
||||||
|
return diff == 0
|
||||||
|
}
|
||||||
|
|||||||
@@ -0,0 +1,301 @@
|
|||||||
|
package controller
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"log"
|
||||||
|
"net/http"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/gorilla/mux"
|
||||||
|
"github.com/volcano-tts/tts-api/installer"
|
||||||
|
"github.com/volcano-tts/tts-api/middleware"
|
||||||
|
"github.com/volcano-tts/tts-api/store"
|
||||||
|
"github.com/volcano-tts/tts-api/version"
|
||||||
|
)
|
||||||
|
|
||||||
|
// SetAdminStore 注入 admin 控制器需要的 store;main 启动期调一次。
|
||||||
|
// store 可能在自愈回退后为 nil,GetAdminStore 返 nil 时 controller 应返 503。
|
||||||
|
var adminStore *store.Store
|
||||||
|
|
||||||
|
// SetAdminStore 在 main 启动期调,设置 admin 用的 store 句柄。
|
||||||
|
func SetAdminStore(s *store.Store) { adminStore = s }
|
||||||
|
|
||||||
|
// GetAdminStore admin 控制器用,获取已注入的 store;nil 表示服务在 setup 模式。
|
||||||
|
func GetAdminStore() *store.Store { return adminStore }
|
||||||
|
|
||||||
|
// metricsTextWriter 是 admin 端点写 Prometheus 文本的回调,
|
||||||
|
// 由 main 启动期注入(避免 controller → metrics → controller 循环)。
|
||||||
|
type metricsTextWriter func(w http.ResponseWriter) error
|
||||||
|
|
||||||
|
var (
|
||||||
|
metricsTextWriterMu sync.RWMutex
|
||||||
|
metricsTextWriterFn metricsTextWriter
|
||||||
|
)
|
||||||
|
|
||||||
|
// SetMetricsTextWriter 注入 Prometheus 文本写入函数;main 启动期调一次。
|
||||||
|
func SetMetricsTextWriter(fn metricsTextWriter) {
|
||||||
|
metricsTextWriterMu.Lock()
|
||||||
|
metricsTextWriterFn = fn
|
||||||
|
metricsTextWriterMu.Unlock()
|
||||||
|
}
|
||||||
|
|
||||||
|
// AdminOverviewResponse 是 GET /api/admin/overview 的响应体。
|
||||||
|
type AdminOverviewResponse struct {
|
||||||
|
Mode string `json:"mode"`
|
||||||
|
Installed bool `json:"installed"`
|
||||||
|
DBPath string `json:"db_path"`
|
||||||
|
LockPath string `json:"lock_path"`
|
||||||
|
Version string `json:"version"`
|
||||||
|
Commit string `json:"commit"`
|
||||||
|
UptimeSeconds int64 `json:"uptime_seconds"`
|
||||||
|
StartTime string `json:"start_time"`
|
||||||
|
VoiceCount int `json:"voice_count"`
|
||||||
|
VoiceEnabledCount int `json:"voice_enabled_count"`
|
||||||
|
Memory map[string]interface{} `json:"memory"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// AdminOverviewHandler GET /api/admin/overview
|
||||||
|
// 鉴权: RequireAdmin;store 为 nil 时仍可服务,但 voice 字段为 0。
|
||||||
|
func AdminOverviewHandler(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.Method != http.MethodGet {
|
||||||
|
http.Error(w, "Method not allowed", http.StatusMethodNotAllowed)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
resp := AdminOverviewResponse{
|
||||||
|
Mode: installer.GetMode().String(),
|
||||||
|
Installed: installer.GetMode() == installer.ModeNormal,
|
||||||
|
Version: version.Version,
|
||||||
|
Commit: version.Commit,
|
||||||
|
StartTime: startTime.Format(time.RFC3339),
|
||||||
|
UptimeSeconds: int64(time.Since(startTime).Seconds()),
|
||||||
|
Memory: collectMemorySnapshot(),
|
||||||
|
}
|
||||||
|
|
||||||
|
if s := GetAdminStore(); s != nil {
|
||||||
|
if p, err := s.Path(); err == nil {
|
||||||
|
resp.DBPath = p
|
||||||
|
}
|
||||||
|
resp.LockPath = installer.LockPath(resp.DBPath)
|
||||||
|
if n, err := s.VoiceCount(); err == nil {
|
||||||
|
resp.VoiceCount = n
|
||||||
|
}
|
||||||
|
if n, err := s.VoiceCountEnabled(); err == nil {
|
||||||
|
resp.VoiceEnabledCount = n
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
w.Header().Set("Content-Type", "application/json; charset=utf-8")
|
||||||
|
if err := json.NewEncoder(w).Encode(resp); err != nil {
|
||||||
|
log.Printf("[admin] overview encode failed: %v", err)
|
||||||
|
middleware.SendJSONError(w, http.StatusInternalServerError, "encode failed", "server_error", "encode_failed")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// AdminMetricsHandler GET /api/admin/metrics
|
||||||
|
// 鉴权: RequireAdmin;返 Prometheus 文本。
|
||||||
|
func AdminMetricsHandler(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.Method != http.MethodGet {
|
||||||
|
http.Error(w, "Method not allowed", http.StatusMethodNotAllowed)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
metricsTextWriterMu.RLock()
|
||||||
|
fn := metricsTextWriterFn
|
||||||
|
metricsTextWriterMu.RUnlock()
|
||||||
|
if fn == nil {
|
||||||
|
// 启动期没注入,返 503 + 提示(不应该发生)
|
||||||
|
middleware.SendJSONError(w, http.StatusServiceUnavailable,
|
||||||
|
"metrics writer not initialized", "configuration_error", "metrics_not_ready")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
w.Header().Set("Content-Type", "text/plain; version=0.0.4; charset=utf-8")
|
||||||
|
if err := fn(w); err != nil {
|
||||||
|
log.Printf("[admin] metrics write: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// AdminVoicesListResponse 是 GET /api/voices 的响应。
|
||||||
|
type AdminVoicesListResponse struct {
|
||||||
|
Voices []store.Voice `json:"voices"`
|
||||||
|
Total int `json:"total"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// AdminVoicesListHandler GET /api/voices
|
||||||
|
// 鉴权: RequireAdmin;返所有 voice(包含 disabled)。
|
||||||
|
func AdminVoicesListHandler(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.Method != http.MethodGet {
|
||||||
|
http.Error(w, "Method not allowed", http.StatusMethodNotAllowed)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
s := GetAdminStore()
|
||||||
|
if s == nil {
|
||||||
|
middleware.SendJSONError(w, http.StatusServiceUnavailable, "database not ready", "configuration_error", "db_not_ready")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
vs, err := s.VoiceList(true)
|
||||||
|
if err != nil {
|
||||||
|
log.Printf("[admin] voice list: %v", err)
|
||||||
|
middleware.SendJSONError(w, http.StatusInternalServerError, "list voices failed", "server_error", "db_read_failed")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
w.Header().Set("Content-Type", "application/json; charset=utf-8")
|
||||||
|
_ = json.NewEncoder(w).Encode(AdminVoicesListResponse{Voices: vs, Total: len(vs)})
|
||||||
|
}
|
||||||
|
|
||||||
|
// AdminVoiceCreateRequest 是 POST /api/voices 的 body。
|
||||||
|
type AdminVoiceCreateRequest struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Speaker string `json:"speaker"`
|
||||||
|
ResourceID string `json:"resource_id"`
|
||||||
|
Model string `json:"model"`
|
||||||
|
Language string `json:"language"`
|
||||||
|
Description string `json:"description"`
|
||||||
|
Enabled *bool `json:"enabled,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// AdminVoiceCreateHandler POST /api/voices
|
||||||
|
// 鉴权: RequireAdmin;store nil 时 503。
|
||||||
|
func AdminVoiceCreateHandler(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.Method != http.MethodPost {
|
||||||
|
http.Error(w, "Method not allowed", http.StatusMethodNotAllowed)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
s := GetAdminStore()
|
||||||
|
if s == nil {
|
||||||
|
middleware.SendJSONError(w, http.StatusServiceUnavailable, "database not ready", "configuration_error", "db_not_ready")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
r.Body = http.MaxBytesReader(w, r.Body, 1<<16)
|
||||||
|
var body AdminVoiceCreateRequest
|
||||||
|
if err := json.NewDecoder(r.Body).Decode(&body); err != nil {
|
||||||
|
middleware.SendJSONError(w, http.StatusBadRequest, "invalid JSON body", "invalid_request_error", "bad_request")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
enabled := true
|
||||||
|
if body.Enabled != nil {
|
||||||
|
enabled = *body.Enabled
|
||||||
|
}
|
||||||
|
|
||||||
|
v := store.Voice{
|
||||||
|
Name: body.Name,
|
||||||
|
Speaker: body.Speaker,
|
||||||
|
ResourceID: body.ResourceID,
|
||||||
|
Model: body.Model,
|
||||||
|
Language: body.Language,
|
||||||
|
Description: body.Description,
|
||||||
|
Enabled: enabled,
|
||||||
|
}
|
||||||
|
id, err := s.VoiceInsert(v)
|
||||||
|
if err != nil {
|
||||||
|
switch err {
|
||||||
|
case store.ErrDuplicate:
|
||||||
|
middleware.SendJSONError(w, http.StatusConflict,
|
||||||
|
fmt.Sprintf("voice name %q already exists", v.Name),
|
||||||
|
"invalid_request_error", "voice_duplicate")
|
||||||
|
default:
|
||||||
|
log.Printf("[admin] voice insert: %v", err)
|
||||||
|
middleware.SendJSONError(w, http.StatusBadRequest, err.Error(), "invalid_request_error", "voice_invalid")
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
created, _ := s.VoiceGet(id)
|
||||||
|
w.Header().Set("Content-Type", "application/json; charset=utf-8")
|
||||||
|
w.WriteHeader(http.StatusCreated)
|
||||||
|
_ = json.NewEncoder(w).Encode(created)
|
||||||
|
}
|
||||||
|
|
||||||
|
// AdminVoiceDeleteHandler DELETE /api/voices/{name}
|
||||||
|
func AdminVoiceDeleteHandler(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.Method != http.MethodDelete {
|
||||||
|
http.Error(w, "Method not allowed", http.StatusMethodNotAllowed)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
s := GetAdminStore()
|
||||||
|
if s == nil {
|
||||||
|
middleware.SendJSONError(w, http.StatusServiceUnavailable, "database not ready", "configuration_error", "db_not_ready")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
name := mux.Vars(r)["name"]
|
||||||
|
if name == "" {
|
||||||
|
middleware.SendJSONError(w, http.StatusBadRequest, "missing voice name", "invalid_request_error", "bad_request")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
v, err := s.VoiceGetByName(name)
|
||||||
|
if err != nil {
|
||||||
|
if err == store.ErrNotFound {
|
||||||
|
http.Error(w, "voice not found", http.StatusNotFound)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
log.Printf("[admin] voice lookup: %v", err)
|
||||||
|
middleware.SendJSONError(w, http.StatusInternalServerError, "lookup failed", "server_error", "db_read_failed")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if err := s.VoiceDelete(v.ID); err != nil {
|
||||||
|
switch err {
|
||||||
|
case store.ErrInUse:
|
||||||
|
middleware.SendJSONError(w, http.StatusConflict,
|
||||||
|
fmt.Sprintf("voice %q is referenced by default_speaker; remove the default first", name),
|
||||||
|
"invalid_request_error", "voice_in_use")
|
||||||
|
case store.ErrNotFound:
|
||||||
|
http.Error(w, "voice not found", http.StatusNotFound)
|
||||||
|
default:
|
||||||
|
log.Printf("[admin] voice delete: %v", err)
|
||||||
|
middleware.SendJSONError(w, http.StatusInternalServerError, "delete failed", "server_error", "db_write_failed")
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
w.Header().Set("Content-Type", "application/json; charset=utf-8")
|
||||||
|
_ = json.NewEncoder(w).Encode(map[string]any{"ok": true, "deleted": name})
|
||||||
|
}
|
||||||
|
|
||||||
|
// AdminVoiceToggleRequest 是 PATCH /api/voices/{name}/toggle 的 body。
|
||||||
|
type AdminVoiceToggleRequest struct {
|
||||||
|
Enabled bool `json:"enabled"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// AdminVoiceToggleHandler PATCH /api/voices/{name}/toggle
|
||||||
|
func AdminVoiceToggleHandler(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.Method != http.MethodPatch {
|
||||||
|
http.Error(w, "Method not allowed", http.StatusMethodNotAllowed)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
s := GetAdminStore()
|
||||||
|
if s == nil {
|
||||||
|
middleware.SendJSONError(w, http.StatusServiceUnavailable, "database not ready", "configuration_error", "db_not_ready")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
name := mux.Vars(r)["name"]
|
||||||
|
if name == "" {
|
||||||
|
middleware.SendJSONError(w, http.StatusBadRequest, "missing voice name", "invalid_request_error", "bad_request")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
v, err := s.VoiceGetByName(name)
|
||||||
|
if err != nil {
|
||||||
|
if err == store.ErrNotFound {
|
||||||
|
http.Error(w, "voice not found", http.StatusNotFound)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
log.Printf("[admin] voice lookup: %v", err)
|
||||||
|
middleware.SendJSONError(w, http.StatusInternalServerError, "lookup failed", "server_error", "db_read_failed")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
var body AdminVoiceToggleRequest
|
||||||
|
r.Body = http.MaxBytesReader(w, r.Body, 1<<10)
|
||||||
|
if err := json.NewDecoder(r.Body).Decode(&body); err != nil {
|
||||||
|
middleware.SendJSONError(w, http.StatusBadRequest, "invalid JSON body", "invalid_request_error", "bad_request")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if err := s.VoiceToggleEnabled(v.ID, body.Enabled); err != nil {
|
||||||
|
log.Printf("[admin] voice toggle: %v", err)
|
||||||
|
middleware.SendJSONError(w, http.StatusInternalServerError, "toggle failed", "server_error", "db_write_failed")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
updated, _ := s.VoiceGet(v.ID)
|
||||||
|
w.Header().Set("Content-Type", "application/json; charset=utf-8")
|
||||||
|
_ = json.NewEncoder(w).Encode(updated)
|
||||||
|
}
|
||||||
@@ -0,0 +1,432 @@
|
|||||||
|
package controller
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"log"
|
||||||
|
"net/http"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/volcano-tts/tts-api/middleware"
|
||||||
|
"github.com/volcano-tts/tts-api/setting"
|
||||||
|
)
|
||||||
|
|
||||||
|
// SettingsResponse 是 GET /api/settings 的响应。
|
||||||
|
// API key 永远打码(借用 setting.maskAPIKey 风格,前 4 后 4 中间 ****)。
|
||||||
|
type SettingsResponse struct {
|
||||||
|
APIKey string `json:"api_key"` // 打码形式,例如 S_G8****naJ1
|
||||||
|
APIKeySet bool `json:"api_key_set"` // 是否已设置(用于前端判断要不要提示必填)
|
||||||
|
AuthKey string `json:"auth_key"` // 鉴权 key 打码(客户端访问 + admin 登录用)
|
||||||
|
AuthKeySet bool `json:"auth_key_set"`
|
||||||
|
CORSAllowAll bool `json:"cors_allow_all"` // 允许所有来源(*)
|
||||||
|
CORSOrigins string `json:"cors_origins"` // 逗号分隔的白名单(原文,含大小写,trim 末尾 /)
|
||||||
|
CORSConfigured bool `json:"cors_configured"` // 是否配了 CORS(给 banner 用)
|
||||||
|
DefaultResourceID string `json:"default_resource_id"`
|
||||||
|
DefaultSpeaker string `json:"default_speaker"`
|
||||||
|
DefaultFormat string `json:"default_format"`
|
||||||
|
SampleRate int `json:"sample_rate"`
|
||||||
|
Model string `json:"model"`
|
||||||
|
ModelType int `json:"model_type"`
|
||||||
|
ExplicitLanguage string `json:"explicit_language"`
|
||||||
|
EnableSubtitle bool `json:"enable_subtitle"`
|
||||||
|
UpdatedAt string `json:"updated_at"` // RFC3339,来自 settings.installed_at(沿用)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SettingsGetHandler GET /api/settings
|
||||||
|
// 鉴权: RequireAdmin;store nil 时 503。
|
||||||
|
func SettingsGetHandler(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.Method != http.MethodGet {
|
||||||
|
http.Error(w, "Method not allowed", http.StatusMethodNotAllowed)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
s := GetAdminStore()
|
||||||
|
if s == nil {
|
||||||
|
middleware.SendJSONError(w, http.StatusServiceUnavailable, "database not ready", "configuration_error", "db_not_ready")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
all, err := s.SettingsGetAll()
|
||||||
|
if err != nil {
|
||||||
|
log.Printf("[settings] getall: %v", err)
|
||||||
|
middleware.SendJSONError(w, http.StatusInternalServerError, "read settings failed", "server_error", "db_read_failed")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
resp := SettingsResponse{
|
||||||
|
APIKey: maskAPIKeyField(all["api_key"]),
|
||||||
|
APIKeySet: all["api_key"] != "",
|
||||||
|
AuthKey: maskAPIKeyField(all["auth_key"]),
|
||||||
|
AuthKeySet: all["auth_key"] != "",
|
||||||
|
CORSAllowAll: all["cors_allow_all"] == "1" || all["cors_allow_all"] == "true",
|
||||||
|
CORSOrigins: all["cors_origins"],
|
||||||
|
CORSConfigured: all["cors_allow_all"] == "1" || all["cors_allow_all"] == "true" || all["cors_origins"] != "",
|
||||||
|
DefaultResourceID: all["default_resource_id"],
|
||||||
|
DefaultSpeaker: all["default_speaker"],
|
||||||
|
DefaultFormat: all["default_format"],
|
||||||
|
Model: all["model"],
|
||||||
|
ExplicitLanguage: all["explicit_language"],
|
||||||
|
}
|
||||||
|
if v, _ := s.SettingsGetInt("sample_rate", 0); v > 0 {
|
||||||
|
resp.SampleRate = v
|
||||||
|
}
|
||||||
|
if v, _ := s.SettingsGetInt("model_type", 0); v > 0 {
|
||||||
|
resp.ModelType = v
|
||||||
|
}
|
||||||
|
if v, _ := s.SettingsGetBool("enable_subtitle", false); v {
|
||||||
|
resp.EnableSubtitle = true
|
||||||
|
}
|
||||||
|
if ts := all["installed_at"]; ts != "" {
|
||||||
|
resp.UpdatedAt = ts
|
||||||
|
}
|
||||||
|
w.Header().Set("Content-Type", "application/json; charset=utf-8")
|
||||||
|
_ = json.NewEncoder(w).Encode(resp)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SettingsUpdateRequest 是 PUT /api/settings 的 body(部分更新)。
|
||||||
|
// 字段都是可选;只更新非空 / 非零值。
|
||||||
|
type SettingsUpdateRequest struct {
|
||||||
|
APIKey *string `json:"api_key,omitempty"` // 用指针区分 "未传" vs "传空串"
|
||||||
|
DefaultResourceID *string `json:"default_resource_id,omitempty"`
|
||||||
|
DefaultSpeaker *string `json:"default_speaker,omitempty"`
|
||||||
|
DefaultFormat *string `json:"default_format,omitempty"`
|
||||||
|
SampleRate *int `json:"sample_rate,omitempty"`
|
||||||
|
Model *string `json:"model,omitempty"`
|
||||||
|
ModelType *int `json:"model_type,omitempty"`
|
||||||
|
ExplicitLanguage *string `json:"explicit_language,omitempty"`
|
||||||
|
EnableSubtitle *bool `json:"enable_subtitle,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SettingsUpdateHandler PUT /api/settings
|
||||||
|
// 鉴权: RequireAdmin;store nil 时 503。
|
||||||
|
// 至少要改 1 个字段(空 body 返 400);api_key 修改走专用端点 /api/settings/api-key。
|
||||||
|
func SettingsUpdateHandler(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.Method != http.MethodPut {
|
||||||
|
http.Error(w, "Method not allowed", http.StatusMethodNotAllowed)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
s := GetAdminStore()
|
||||||
|
if s == nil {
|
||||||
|
middleware.SendJSONError(w, http.StatusServiceUnavailable, "database not ready", "configuration_error", "db_not_ready")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
r.Body = http.MaxBytesReader(w, r.Body, 1<<16) // 64KB
|
||||||
|
var body SettingsUpdateRequest
|
||||||
|
if err := json.NewDecoder(r.Body).Decode(&body); err != nil {
|
||||||
|
middleware.SendJSONError(w, http.StatusBadRequest, "invalid JSON body", "invalid_request_error", "bad_request")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// 收集要更新的键值对
|
||||||
|
updates := make(map[string]string)
|
||||||
|
if body.DefaultResourceID != nil {
|
||||||
|
v := trimAll(*body.DefaultResourceID)
|
||||||
|
if v == "" {
|
||||||
|
middleware.SendJSONError(w, http.StatusBadRequest, "default_resource_id cannot be empty", "invalid_request_error", "missing_field")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
updates["default_resource_id"] = v
|
||||||
|
}
|
||||||
|
if body.DefaultSpeaker != nil {
|
||||||
|
v := trimAll(*body.DefaultSpeaker)
|
||||||
|
if v == "" {
|
||||||
|
middleware.SendJSONError(w, http.StatusBadRequest, "default_speaker cannot be empty", "invalid_request_error", "missing_field")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
// 校验音色在库中(避免 default_speaker 引用不存在的 voice)
|
||||||
|
if _, err := s.VoiceGetByName(v); err != nil {
|
||||||
|
middleware.SendJSONError(w, http.StatusBadRequest,
|
||||||
|
fmt.Sprintf("default_speaker %q not found in voices table", v),
|
||||||
|
"invalid_request_error", "default_speaker_missing")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
updates["default_speaker"] = v
|
||||||
|
}
|
||||||
|
if body.DefaultFormat != nil {
|
||||||
|
v := trimAll(*body.DefaultFormat)
|
||||||
|
if !isValidFormat(v) {
|
||||||
|
middleware.SendJSONError(w, http.StatusBadRequest,
|
||||||
|
fmt.Sprintf("default_format %q invalid; valid: mp3/wav/opus/pcm/aac/flac", v),
|
||||||
|
"invalid_request_error", "format_invalid")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
updates["default_format"] = v
|
||||||
|
}
|
||||||
|
if body.SampleRate != nil {
|
||||||
|
v := *body.SampleRate
|
||||||
|
if v < 8000 || v > 48000 {
|
||||||
|
middleware.SendJSONError(w, http.StatusBadRequest,
|
||||||
|
"sample_rate must be 8000-48000", "invalid_request_error", "sample_rate_invalid")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
updates["sample_rate"] = strconv.Itoa(v)
|
||||||
|
}
|
||||||
|
if body.Model != nil {
|
||||||
|
updates["model"] = trimAll(*body.Model)
|
||||||
|
}
|
||||||
|
if body.ModelType != nil {
|
||||||
|
updates["model_type"] = strconv.Itoa(*body.ModelType)
|
||||||
|
}
|
||||||
|
if body.ExplicitLanguage != nil {
|
||||||
|
updates["explicit_language"] = trimAll(*body.ExplicitLanguage)
|
||||||
|
}
|
||||||
|
if body.EnableSubtitle != nil {
|
||||||
|
updates["enable_subtitle"] = boolToStr(*body.EnableSubtitle)
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(updates) == 0 {
|
||||||
|
middleware.SendJSONError(w, http.StatusBadRequest,
|
||||||
|
"at least one field is required (use /api/settings/api-key to change api_key)",
|
||||||
|
"invalid_request_error", "no_fields")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// 写入 DB
|
||||||
|
if err := s.SettingsSetBatch(updates); err != nil {
|
||||||
|
log.Printf("[settings] update: %v", err)
|
||||||
|
middleware.SendJSONError(w, http.StatusInternalServerError, "write settings failed", "server_error", "db_write_failed")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// 关键: 更新后**立刻刷新运行时缓存**,M3 要求"改设置实时生效"
|
||||||
|
if err := setting.LoadRuntimeConfig(s); err != nil {
|
||||||
|
log.Printf("[settings] reload runtime: %v", err)
|
||||||
|
// 不返 500:DB 已写,只是 reload 失败;下次启动会生效
|
||||||
|
middleware.SendJSONError(w, http.StatusInternalServerError,
|
||||||
|
"settings saved but runtime reload failed; restart required",
|
||||||
|
"server_error", "reload_failed")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
log.Printf("[settings] updated %d fields, runtime reloaded", len(updates))
|
||||||
|
w.Header().Set("Content-Type", "application/json; charset=utf-8")
|
||||||
|
_ = json.NewEncoder(w).Encode(map[string]any{
|
||||||
|
"ok": true,
|
||||||
|
"updated": len(updates),
|
||||||
|
"updated_at": time.Now().UTC().Format(time.RFC3339),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// SettingsAPIKeyRequest 是 PUT /api/settings/api-key 的 body。
|
||||||
|
type SettingsAPIKeyRequest struct {
|
||||||
|
APIKey string `json:"api_key"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SettingsAPIKeyHandler PUT /api/settings/api-key
|
||||||
|
// 鉴权: RequireAdmin。专门改 api_key,因为它需要单独的安全处理(不能 mask,要走加密通道)。
|
||||||
|
func SettingsAPIKeyHandler(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.Method != http.MethodPut {
|
||||||
|
http.Error(w, "Method not allowed", http.StatusMethodNotAllowed)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
s := GetAdminStore()
|
||||||
|
if s == nil {
|
||||||
|
middleware.SendJSONError(w, http.StatusServiceUnavailable, "database not ready", "configuration_error", "db_not_ready")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
r.Body = http.MaxBytesReader(w, r.Body, 1<<10) // 1KB
|
||||||
|
var body SettingsAPIKeyRequest
|
||||||
|
if err := json.NewDecoder(r.Body).Decode(&body); err != nil {
|
||||||
|
middleware.SendJSONError(w, http.StatusBadRequest, "invalid JSON body", "invalid_request_error", "bad_request")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
key := trimAll(body.APIKey)
|
||||||
|
if key == "" {
|
||||||
|
middleware.SendJSONError(w, http.StatusBadRequest, "api_key cannot be empty", "invalid_request_error", "missing_field")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := s.SettingsSet("api_key", key); err != nil {
|
||||||
|
log.Printf("[settings] api-key set: %v", err)
|
||||||
|
middleware.SendJSONError(w, http.StatusInternalServerError, "write api_key failed", "server_error", "db_write_failed")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if err := setting.LoadRuntimeConfig(s); err != nil {
|
||||||
|
log.Printf("[settings] reload after api-key: %v", err)
|
||||||
|
middleware.SendJSONError(w, http.StatusInternalServerError,
|
||||||
|
"api_key saved but runtime reload failed", "server_error", "reload_failed")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
log.Printf("[settings] api_key updated, runtime reloaded")
|
||||||
|
w.Header().Set("Content-Type", "application/json; charset=utf-8")
|
||||||
|
_ = json.NewEncoder(w).Encode(map[string]any{"ok": true})
|
||||||
|
}
|
||||||
|
|
||||||
|
// SettingsAuthKeyRequest 是 PUT /api/settings/auth-key 的 body。
|
||||||
|
// auth_key 是 admin 鉴权和 /v1/audio/speech 鉴权用的 key(火山上游 key 是 api_key,这是两套)。
|
||||||
|
type SettingsAuthKeyRequest struct {
|
||||||
|
AuthKey string `json:"auth_key"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SettingsAuthKeyHandler PUT /api/settings/auth-key
|
||||||
|
// 鉴权: RequireAdmin。改完立即更新 setting.Auth.APIKeys(进程内生效),
|
||||||
|
// 下一个请求就用新 key — admin 自己改完要等下一次请求才能验证(避免改完立刻自踢)。
|
||||||
|
func SettingsAuthKeyHandler(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.Method != http.MethodPut {
|
||||||
|
http.Error(w, "Method not allowed", http.StatusMethodNotAllowed)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
s := GetAdminStore()
|
||||||
|
if s == nil {
|
||||||
|
middleware.SendJSONError(w, http.StatusServiceUnavailable, "database not ready", "configuration_error", "db_not_ready")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
r.Body = http.MaxBytesReader(w, r.Body, 1<<10)
|
||||||
|
var body SettingsAuthKeyRequest
|
||||||
|
if err := json.NewDecoder(r.Body).Decode(&body); err != nil {
|
||||||
|
middleware.SendJSONError(w, http.StatusBadRequest, "invalid JSON body", "invalid_request_error", "bad_request")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
key := trimAll(body.AuthKey)
|
||||||
|
if key == "" {
|
||||||
|
middleware.SendJSONError(w, http.StatusBadRequest, "auth_key cannot be empty", "invalid_request_error", "missing_field")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if err := s.SettingsSet("auth_key", key); err != nil {
|
||||||
|
log.Printf("[settings] auth-key set: %v", err)
|
||||||
|
middleware.SendJSONError(w, http.StatusInternalServerError, "write auth_key failed", "server_error", "db_write_failed")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
// 立即生效:不重新 LoadRuntimeConfig(那会覆盖其它字段),
|
||||||
|
// 只单独刷新 Auth.APIKeys
|
||||||
|
setting.Auth.APIKeys = []string{key}
|
||||||
|
log.Printf("[settings] auth_key updated, runtime active (next request uses new key)")
|
||||||
|
w.Header().Set("Content-Type", "application/json; charset=utf-8")
|
||||||
|
_ = json.NewEncoder(w).Encode(map[string]any{"ok": true})
|
||||||
|
}
|
||||||
|
|
||||||
|
// SettingsCORSRequest 是 PUT /api/settings/cors 的 body。
|
||||||
|
// 两个字段都可选(至少给一个):
|
||||||
|
// - allow_all: true → 任意 Origin 都接受(*);设了之后 origins 失效
|
||||||
|
// - origins: 一行一个 origin,后端 trim + lower + 去末尾 /
|
||||||
|
type SettingsCORSRequest struct {
|
||||||
|
AllowAll *bool `json:"allow_all,omitempty"`
|
||||||
|
Origins string `json:"origins,omitempty"` // 也接受 string 数组(任一形式)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SettingsCORSHandler PUT /api/settings/cors
|
||||||
|
// 鉴权: RequireAdmin。改完立即更新 setting.CORS(进程内生效,跨域请求从下个请求开始按新配置)。
|
||||||
|
// 同源豁免由 middleware/cors.go 的 isSameOrigin 处理,不在这里管。
|
||||||
|
func SettingsCORSHandler(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.Method != http.MethodPut {
|
||||||
|
http.Error(w, "Method not allowed", http.StatusMethodNotAllowed)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
s := GetAdminStore()
|
||||||
|
if s == nil {
|
||||||
|
middleware.SendJSONError(w, http.StatusServiceUnavailable, "database not ready", "configuration_error", "db_not_ready")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
r.Body = http.MaxBytesReader(w, r.Body, 1<<10)
|
||||||
|
var body SettingsCORSRequest
|
||||||
|
if err := json.NewDecoder(r.Body).Decode(&body); err != nil {
|
||||||
|
middleware.SendJSONError(w, http.StatusBadRequest, "invalid JSON body", "invalid_request_error", "bad_request")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if body.AllowAll == nil && trimAll(body.Origins) == "" && body.Origins != "" {
|
||||||
|
// 空 body 不算错误,用户可能是想"清空"(只清 origins 保留现状)
|
||||||
|
}
|
||||||
|
if body.AllowAll == nil && body.Origins == "" {
|
||||||
|
middleware.SendJSONError(w, http.StatusBadRequest,
|
||||||
|
"at least one of allow_all / origins required",
|
||||||
|
"invalid_request_error", "no_fields")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
updates := map[string]string{}
|
||||||
|
if body.AllowAll != nil {
|
||||||
|
updates["cors_allow_all"] = boolToStr(*body.AllowAll)
|
||||||
|
}
|
||||||
|
if body.Origins != "" {
|
||||||
|
// 校验每个 origin 至少像 http(s)://... (防止用户填空或填乱字符)
|
||||||
|
for _, line := range strings.Split(body.Origins, "\n") {
|
||||||
|
line = strings.TrimSpace(line)
|
||||||
|
if line == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
low := strings.ToLower(line)
|
||||||
|
if !strings.HasPrefix(low, "http://") && !strings.HasPrefix(low, "https://") {
|
||||||
|
middleware.SendJSONError(w, http.StatusBadRequest,
|
||||||
|
fmt.Sprintf("invalid origin: %q (must start with http:// or https://)", line),
|
||||||
|
"invalid_request_error", "origin_invalid")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
updates["cors_origins"] = body.Origins
|
||||||
|
}
|
||||||
|
if err := s.SettingsSetBatch(updates); err != nil {
|
||||||
|
log.Printf("[settings] cors set: %v", err)
|
||||||
|
middleware.SendJSONError(w, http.StatusInternalServerError, "write cors failed", "server_error", "db_write_failed")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// 立即刷新 setting.CORS,跨域请求从下个请求开始按新配置生效
|
||||||
|
// 复用 LoadRuntimeConfig 的解析逻辑(只取 cors 部分,避免覆盖其它运行时字段)
|
||||||
|
corsAllowAll, _ := s.SettingsGetBool("cors_allow_all", false)
|
||||||
|
originsStr := ""
|
||||||
|
if v, _, _ := s.SettingsGet("cors_origins"); v != "" {
|
||||||
|
originsStr = v
|
||||||
|
}
|
||||||
|
if corsAllowAll {
|
||||||
|
setting.CORS.AllowAll = true
|
||||||
|
setting.CORS.Origins = nil
|
||||||
|
} else if originsStr != "" {
|
||||||
|
setting.CORS.AllowAll = false
|
||||||
|
setting.CORS.Origins = setting.SplitOriginsForCORS(originsStr)
|
||||||
|
} else {
|
||||||
|
setting.CORS.AllowAll = false
|
||||||
|
setting.CORS.Origins = nil
|
||||||
|
}
|
||||||
|
log.Printf("[settings] cors updated (allow_all=%v origins=%q), runtime active", setting.CORS.AllowAll, originsStr)
|
||||||
|
w.Header().Set("Content-Type", "application/json; charset=utf-8")
|
||||||
|
_ = json.NewEncoder(w).Encode(map[string]any{
|
||||||
|
"ok": true,
|
||||||
|
"allow_all": setting.CORS.AllowAll,
|
||||||
|
"origins": originsStr,
|
||||||
|
"cors_active": true,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// maskAPIKeyField 复用 setting 包的打码风格(前 4 后 4 中间 ****)。
|
||||||
|
// 单独导出版本避免从 setting 包拉整个 APIKeyMask 之类的工具(那个是 unexported)。
|
||||||
|
func maskAPIKeyField(s string) string {
|
||||||
|
if s == "" {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
if len(s) <= 4 {
|
||||||
|
return "****"
|
||||||
|
}
|
||||||
|
// 仿 setting.maskAPIKey: 但这里打的是 TTS 服务用的 key,可能含字母数字和连字符
|
||||||
|
return s[:4] + "****" + s[len(s)-4:]
|
||||||
|
}
|
||||||
|
|
||||||
|
func trimAll(s string) string {
|
||||||
|
// 简单 trim 前后空白;不剥中间空格
|
||||||
|
out := s
|
||||||
|
for len(out) > 0 && (out[0] == ' ' || out[0] == '\t' || out[0] == '\n' || out[0] == '\r') {
|
||||||
|
out = out[1:]
|
||||||
|
}
|
||||||
|
for len(out) > 0 && (out[len(out)-1] == ' ' || out[len(out)-1] == '\t' || out[len(out)-1] == '\n' || out[len(out)-1] == '\r') {
|
||||||
|
out = out[:len(out)-1]
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
func isValidFormat(s string) bool {
|
||||||
|
switch s {
|
||||||
|
case "mp3", "wav", "opus", "pcm", "aac", "flac", "":
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
func boolToStr(b bool) string {
|
||||||
|
if b {
|
||||||
|
return "1"
|
||||||
|
}
|
||||||
|
return "0"
|
||||||
|
}
|
||||||
@@ -0,0 +1,292 @@
|
|||||||
|
package controller
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"log"
|
||||||
|
"net/http"
|
||||||
|
"os"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/volcano-tts/tts-api/common"
|
||||||
|
"github.com/volcano-tts/tts-api/installer"
|
||||||
|
"github.com/volcano-tts/tts-api/middleware"
|
||||||
|
"github.com/volcano-tts/tts-api/setting"
|
||||||
|
"github.com/volcano-tts/tts-api/store"
|
||||||
|
)
|
||||||
|
|
||||||
|
// SetupAPIState 是 setup 控制器需要的状态:
|
||||||
|
// - Store: db 访问,可能为 nil(自愈回退后 store 已关闭,等待重新 setup)
|
||||||
|
// - DBPath: 用于安装完成时写 lock
|
||||||
|
type SetupAPIState struct {
|
||||||
|
Store *store.Store
|
||||||
|
DBPath string
|
||||||
|
Token string
|
||||||
|
}
|
||||||
|
|
||||||
|
// 全局 setup 状态,在 main.go 启动时通过 SetSetupState 注入。
|
||||||
|
// 进程内只有一个二进制实例,全局变量是合适的。
|
||||||
|
var setupState SetupAPIState
|
||||||
|
|
||||||
|
// SetSetupState 注入 setup 控制器所需的 store + dbPath,启动期调用一次。
|
||||||
|
func SetSetupState(s *store.Store, dbPath string) {
|
||||||
|
setupState.Store = s
|
||||||
|
setupState.DBPath = dbPath
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetSetupStore 供 router/main 注入的 store 访问函数。
|
||||||
|
func GetSetupStore() *store.Store { return setupState.Store }
|
||||||
|
|
||||||
|
// GetSetupDBPath 供 router/main 注入的 dbPath 访问函数。
|
||||||
|
func GetSetupDBPath() string { return setupState.DBPath }
|
||||||
|
|
||||||
|
// SetupStatusHandler GET /api/setup/status
|
||||||
|
// 始终返回当前模式,无论安装与否;用于部署探针 + 引导页判断。
|
||||||
|
func SetupStatusHandler(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.Method != http.MethodGet {
|
||||||
|
http.Error(w, "Method not allowed", http.StatusMethodNotAllowed)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
w.Header().Set("Content-Type", "application/json; charset=utf-8")
|
||||||
|
resp := map[string]any{
|
||||||
|
"installed": installer.GetMode() == installer.ModeNormal,
|
||||||
|
"mode": installer.GetMode().String(),
|
||||||
|
}
|
||||||
|
_ = json.NewEncoder(w).Encode(resp)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetupPrefillHandler GET /api/setup/prefill
|
||||||
|
// 仅在安装模式有响应;返回旧 env 变量值,便于引导页预填,实现平滑迁移。
|
||||||
|
func SetupPrefillHandler(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.Method != http.MethodGet {
|
||||||
|
http.Error(w, "Method not allowed", http.StatusMethodNotAllowed)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if installer.GetMode() != installer.ModeSetup {
|
||||||
|
http.Error(w, "not in setup mode", http.StatusNotFound)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
w.Header().Set("Content-Type", "application/json; charset=utf-8")
|
||||||
|
resp := map[string]any{
|
||||||
|
"settings": prefillFromEnv(),
|
||||||
|
}
|
||||||
|
_ = json.NewEncoder(w).Encode(resp)
|
||||||
|
}
|
||||||
|
|
||||||
|
// prefillFromEnv 读 BYTEDANCE_TTS_* 等旧 env,作为引导页预填值。
|
||||||
|
// 读不到就返回空串,前端会用默认值。
|
||||||
|
func prefillFromEnv() map[string]string {
|
||||||
|
get := func(k string) string { return os.Getenv(k) }
|
||||||
|
return map[string]string{
|
||||||
|
"api_key": "", // API key 永不回显,即便 env 里有;必须让用户重新输入
|
||||||
|
"default_resource_id": get("BYTEDANCE_TTS_RESOURCE_ID"),
|
||||||
|
"default_speaker": get("BYTEDANCE_TTS_SPEAKER"),
|
||||||
|
"default_format": get("BYTEDANCE_TTS_FORMAT"),
|
||||||
|
"sample_rate": get("BYTEDANCE_TTS_SAMPLE_RATE"),
|
||||||
|
"model": get("BYTEDANCE_TTS_MODEL"),
|
||||||
|
"model_type": get("BYTEDANCE_TTS_MODEL_TYPE"),
|
||||||
|
"explicit_language": get("BYTEDANCE_TTS_EXPLICIT_LANGUAGE"),
|
||||||
|
"enable_subtitle": get("BYTEDANCE_TTS_ENABLE_SUBTITLE"),
|
||||||
|
"timeout": get("BYTEDANCE_TTS_TIMEOUT"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetupRequestBody 是 POST /api/setup 的请求体结构。
|
||||||
|
type SetupRequestBody struct {
|
||||||
|
Token string `json:"token"`
|
||||||
|
Settings map[string]string `json:"settings"`
|
||||||
|
Voices []SetupVoice `json:"voices"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetupVoice 是 POST /api/setup 里 voices 数组的条目。
|
||||||
|
type SetupVoice struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Speaker string `json:"speaker"`
|
||||||
|
ResourceID string `json:"resource_id"`
|
||||||
|
Model string `json:"model"`
|
||||||
|
Language string `json:"language"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetupSubmitHandler POST /api/setup
|
||||||
|
// 校验 token → 校验字段 → 写 settings → 写 voices → 写 lock。
|
||||||
|
// 必须在安装模式才接受;装完后永久 404。
|
||||||
|
func SetupSubmitHandler(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.Method != http.MethodPost {
|
||||||
|
http.Error(w, "Method not allowed", http.StatusMethodNotAllowed)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
// 安装完成后此端点永久关闭(防止被误触)
|
||||||
|
if installer.GetMode() != installer.ModeSetup {
|
||||||
|
http.NotFound(w, r)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// 解析 body
|
||||||
|
r.Body = http.MaxBytesReader(w, r.Body, 1<<20) // 1MB
|
||||||
|
var body SetupRequestBody
|
||||||
|
if err := json.NewDecoder(r.Body).Decode(&body); err != nil {
|
||||||
|
middleware.SendJSONError(w, http.StatusBadRequest, "invalid JSON body", "invalid_request_error", "bad_request")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// token 校验(常量时间比较防计时攻击)
|
||||||
|
if setting.SetupToken == "" || !secureEqualString(body.Token, setting.SetupToken) {
|
||||||
|
log.Printf("[setup] token 校验失败 - 客户端=%s", middleware.GetClientIP(r))
|
||||||
|
middleware.SendJSONError(w, http.StatusUnauthorized, "invalid setup token", "authentication_error", "invalid_token")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// 校验 settings 必填项
|
||||||
|
if err := validateSetupSettings(body.Settings); err != nil {
|
||||||
|
middleware.SendJSONError(w, http.StatusBadRequest, err.Error(), "invalid_request_error", "missing_field")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// 校验 voices
|
||||||
|
if err := validateSetupVoices(body.Voices); err != nil {
|
||||||
|
middleware.SendJSONError(w, http.StatusBadRequest, err.Error(), "invalid_request_error", "invalid_voice")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// 取 store:必须为非 nil(自愈回退后 store 是 nil,这种状态下不接 setup,要求重启)
|
||||||
|
s := GetSetupStore()
|
||||||
|
if s == nil {
|
||||||
|
middleware.SendJSONError(w, http.StatusServiceUnavailable, "database not ready, please restart service", "configuration_error", "db_not_ready")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// 写 settings(包含 initialized=1)
|
||||||
|
settingsKV := make(map[string]string, len(body.Settings)+1)
|
||||||
|
for k, v := range body.Settings {
|
||||||
|
settingsKV[k] = v
|
||||||
|
}
|
||||||
|
settingsKV["initialized"] = "1"
|
||||||
|
settingsKV["installed_at"] = time.Now().UTC().Format(time.RFC3339)
|
||||||
|
if err := s.SettingsSetBatch(settingsKV); err != nil {
|
||||||
|
log.Printf("[setup] 写 settings 失败: %v", err)
|
||||||
|
middleware.SendJSONError(w, http.StatusInternalServerError, "failed to write settings", "server_error", "db_write_failed")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// 立即把 auth_key 灌到 setting.Auth.APIKeys,这样后续 /v1/audio/speech 和 /admin
|
||||||
|
// 在本进程内能立刻用新 key(无需等 LoadRuntimeConfig)。
|
||||||
|
authKey := strings.TrimSpace(body.Settings["auth_key"])
|
||||||
|
if authKey != "" {
|
||||||
|
setting.Auth.APIKeys = []string{authKey}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 装完 reload TTS 全局配置(让 TTSOptions 立即有可用的 api_key/speaker/resource_id,
|
||||||
|
// 否则 /v1/audio/speech 会因为 TTSConfigErr 在启动期被设而返 503,要重启才生效)。
|
||||||
|
if err := setting.LoadRuntimeConfig(GetSetupStore()); err != nil {
|
||||||
|
log.Printf("[setup] warning: 装完 LoadRuntimeConfig 失败: %v(下次启动会恢复)", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// 清空旧 voices 再插入(假设是首次安装;若不是,name 冲突会变成 409)
|
||||||
|
// 这里选择 "清空+插入" 语义,符合"setup 是首次安装"的产品定位
|
||||||
|
// 如果想保留旧 voices,可以改成 UPSERT,但 M1 不做
|
||||||
|
if existing, _ := s.VoiceList(true); len(existing) > 0 {
|
||||||
|
// 留作未来:如果是非首次 setup(M2 加 reset 功能),这里需要更精细处理
|
||||||
|
log.Printf("[setup] 检测到 %d 条已存在 voices,本次将跳过清空(name 冲突由 ErrDuplicate 处理)", len(existing))
|
||||||
|
}
|
||||||
|
inserted := 0
|
||||||
|
// 【UX 改进】voice 行的 resource_id 留空时,自动用 settings.default_resource_id 兜底。
|
||||||
|
// 用户在 step 2 填了 default_resource_id 后,step 3 的 voice 行 resource_id
|
||||||
|
// 可以不填 — 保持一致。否则会出现 "settings 里 seed-icl-2.0,voice 里 volc.megatts.icl"
|
||||||
|
// 这种 mismatch,运行时 500。
|
||||||
|
defaultResourceID := settingsKV["default_resource_id"]
|
||||||
|
for _, v := range body.Voices {
|
||||||
|
voiceResourceID := v.ResourceID
|
||||||
|
if voiceResourceID == "" {
|
||||||
|
voiceResourceID = defaultResourceID
|
||||||
|
log.Printf("[setup] voice %q resource_id 留空,自动用 default_resource_id=%q", v.Name, defaultResourceID)
|
||||||
|
}
|
||||||
|
_, err := s.VoiceInsert(store.Voice{
|
||||||
|
Name: v.Name,
|
||||||
|
Speaker: v.Speaker,
|
||||||
|
ResourceID: voiceResourceID,
|
||||||
|
Model: v.Model,
|
||||||
|
Language: v.Language,
|
||||||
|
Enabled: true,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
log.Printf("[setup] 插入 voice %q 失败: %v", v.Name, err)
|
||||||
|
// 不回滚 settings(用户重启后会重新 setup)
|
||||||
|
// 但已插入的 voices 会留着,下次 setup 会撞 ErrDuplicate
|
||||||
|
// 安全:把 ErrDuplicate 视作可继续(用户重复 setup 同一组 voice)
|
||||||
|
if err == store.ErrDuplicate {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
middleware.SendJSONError(w, http.StatusInternalServerError,
|
||||||
|
fmt.Sprintf("failed to insert voice %q: %v", v.Name, err),
|
||||||
|
"server_error", "voice_insert_failed")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
inserted++
|
||||||
|
}
|
||||||
|
log.Printf("[setup] 写入 settings=%d, voices=%d/%d", len(settingsKV), inserted, len(body.Voices))
|
||||||
|
|
||||||
|
// 写 lock(原子):从这一刻起,/api/setup 永久关闭
|
||||||
|
if err := installer.CreateLock(GetSetupDBPath()); err != nil {
|
||||||
|
log.Printf("[setup] 写 lock 失败: %v", err)
|
||||||
|
middleware.SendJSONError(w, http.StatusInternalServerError, "failed to create install lock", "server_error", "lock_write_failed")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
// 切到正常模式(本进程内)
|
||||||
|
installer.SetMode(installer.ModeNormal)
|
||||||
|
log.Printf("[setup] 安装完成!后续请求将进入正常模式")
|
||||||
|
|
||||||
|
w.Header().Set("Content-Type", "application/json; charset=utf-8")
|
||||||
|
_ = json.NewEncoder(w).Encode(map[string]any{
|
||||||
|
"ok": true,
|
||||||
|
"message": "installed",
|
||||||
|
"redirect": "/admin",
|
||||||
|
"settings": len(settingsKV),
|
||||||
|
"voices": inserted,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// validateSetupSettings 校验必填项。
|
||||||
|
// auth_key (鉴权) 也是必填 — 让 setup 成为"单一配置入口",
|
||||||
|
// 用户装完不用再回去设 OPENAI_TTS_API_KEY env。
|
||||||
|
func validateSetupSettings(m map[string]string) error {
|
||||||
|
required := []string{"api_key", "auth_key", "default_resource_id", "default_speaker"}
|
||||||
|
var missing []string
|
||||||
|
for _, k := range required {
|
||||||
|
if strings.TrimSpace(m[k]) == "" {
|
||||||
|
missing = append(missing, k)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(missing) > 0 {
|
||||||
|
return fmt.Errorf("missing required fields: %v", missing)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// validateSetupVoices 校验音色列表;至少 1 条。
|
||||||
|
// 详细合法性(白名单、speaker 非空)由 store.VoiceInsert 负责。
|
||||||
|
func validateSetupVoices(vs []SetupVoice) error {
|
||||||
|
if len(vs) == 0 {
|
||||||
|
return fmt.Errorf("at least one voice is required")
|
||||||
|
}
|
||||||
|
names := make(map[string]struct{}, len(vs))
|
||||||
|
for i, v := range vs {
|
||||||
|
if strings.TrimSpace(v.Name) == "" {
|
||||||
|
return fmt.Errorf("voices[%d]: name is required", i)
|
||||||
|
}
|
||||||
|
if strings.TrimSpace(v.Speaker) == "" {
|
||||||
|
return fmt.Errorf("voices[%d] (%s): speaker is required", i, v.Name)
|
||||||
|
}
|
||||||
|
// 【UX 改进】resource_id 留空是允许的 — 装时(下面那个循环)会自动用
|
||||||
|
// settings.default_resource_id 兜底。用户只填 step 2 一处即可。
|
||||||
|
_ = v.ResourceID // (保留以便以后加更细的校验)
|
||||||
|
if _, dup := names[v.Name]; dup {
|
||||||
|
return fmt.Errorf("voices[%d]: duplicate name %q", i, v.Name)
|
||||||
|
}
|
||||||
|
names[v.Name] = struct{}{}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// secureEqualString wraps common.SecureEqualString 保持向后兼容(原文件内已有调用)。
|
||||||
|
func secureEqualString(a, b string) bool { return common.SecureEqualString(a, b) }
|
||||||
+68
-7
@@ -14,10 +14,13 @@ import (
|
|||||||
"github.com/volcano-tts/tts-api/adapter/volcano"
|
"github.com/volcano-tts/tts-api/adapter/volcano"
|
||||||
"github.com/volcano-tts/tts-api/common"
|
"github.com/volcano-tts/tts-api/common"
|
||||||
"github.com/volcano-tts/tts-api/dto"
|
"github.com/volcano-tts/tts-api/dto"
|
||||||
|
"github.com/volcano-tts/tts-api/installer"
|
||||||
"github.com/volcano-tts/tts-api/metrics"
|
"github.com/volcano-tts/tts-api/metrics"
|
||||||
"github.com/volcano-tts/tts-api/middleware"
|
"github.com/volcano-tts/tts-api/middleware"
|
||||||
"github.com/volcano-tts/tts-api/setting"
|
"github.com/volcano-tts/tts-api/setting"
|
||||||
|
"github.com/volcano-tts/tts-api/store"
|
||||||
"github.com/volcano-tts/tts-api/telemetry"
|
"github.com/volcano-tts/tts-api/telemetry"
|
||||||
|
"github.com/volcano-tts/tts-api/version"
|
||||||
)
|
)
|
||||||
|
|
||||||
var (
|
var (
|
||||||
@@ -46,9 +49,6 @@ func resolveClientFormat(reqFmt string) string {
|
|||||||
}
|
}
|
||||||
return strings.ToLower(reqFmt)
|
return strings.ToLower(reqFmt)
|
||||||
}
|
}
|
||||||
if reqFmt == "" {
|
|
||||||
return setting.TTSOptions.Format
|
|
||||||
}
|
|
||||||
return setting.TTSOptions.Format
|
return setting.TTSOptions.Format
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -64,6 +64,15 @@ func OpenaiTTSHandler(w http.ResponseWriter, r *http.Request) {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// 安装模式双保险:即使 InstallGuard 中间件没拦住,这里也 503 + 引导跳转
|
||||||
|
if installer.GetMode() == installer.ModeSetup {
|
||||||
|
log.Printf("[tts] 安装模式下拒绝 /v1/audio/speech - 客户端=%s", middleware.GetClientIP(r))
|
||||||
|
w.Header().Set("Content-Type", "application/json; charset=utf-8")
|
||||||
|
w.WriteHeader(http.StatusServiceUnavailable)
|
||||||
|
_, _ = w.Write([]byte(`{"error":"not installed","code":"install_required","redirect":"/setup"}`))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
if !middleware.ValidateAPIKey(r) {
|
if !middleware.ValidateAPIKey(r) {
|
||||||
metrics.AuthFailed.Inc(telemetry.Labels{})
|
metrics.AuthFailed.Inc(telemetry.Labels{})
|
||||||
log.Printf("警告: API Key 鉴权失败 - 路径=%s 客户端=%s 远端=%s",
|
log.Printf("警告: API Key 鉴权失败 - 路径=%s 客户端=%s 远端=%s",
|
||||||
@@ -145,6 +154,45 @@ func OpenaiTTSHandler(w http.ResponseWriter, r *http.Request) {
|
|||||||
opts := setting.TTSOptions
|
opts := setting.TTSOptions
|
||||||
opts.Text = req.Input
|
opts.Text = req.Input
|
||||||
|
|
||||||
|
// M3: voice 路由
|
||||||
|
// - voice 为空 → 走 LoadRuntimeConfig 解析过的 opts.Speaker (已是真 speaker ID,
|
||||||
|
// default_speaker 是 voice 名,LoadRuntimeConfig 查 voice 表后替换)
|
||||||
|
// - voice 非空 → 查 voices 表,替换 opts.Speaker / ResourceID / Model
|
||||||
|
// - 命中但 enabled=0 → 仍可用(用户显式传 voice 即覆盖 enabled 状态;若想禁用在 admin UI 关掉就行)
|
||||||
|
// - 未命中 → 400 "unknown voice: <name>"
|
||||||
|
if req.Voice != "" {
|
||||||
|
s := GetAdminStore()
|
||||||
|
if s == nil {
|
||||||
|
log.Printf("警告: voice=%s 路由但 store 未初始化 - 路径=%s", req.Voice, r.URL.Path)
|
||||||
|
middleware.SendJSONError(w, http.StatusServiceUnavailable,
|
||||||
|
"voice routing requires database; not initialized",
|
||||||
|
"configuration_error", "db_not_ready")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
v, err := s.VoiceGetByName(req.Voice)
|
||||||
|
if err != nil {
|
||||||
|
if err == store.ErrNotFound {
|
||||||
|
log.Printf("警告: 未知 voice=%s - 路径=%s 客户端=%s", req.Voice, r.URL.Path, middleware.GetClientIP(r))
|
||||||
|
middleware.SendJSONError(w, http.StatusBadRequest,
|
||||||
|
fmt.Sprintf("unknown voice: %s", req.Voice),
|
||||||
|
"invalid_request_error", "unknown_voice")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
log.Printf("警告: voice 查库失败 - 错误=%v voice=%s", err, req.Voice)
|
||||||
|
middleware.SendJSONError(w, http.StatusInternalServerError,
|
||||||
|
"voice lookup failed", "server_error", "db_read_failed")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
// 覆盖 opts(API key / UID 保留自 setting.TTSOptions)
|
||||||
|
opts.Speaker = v.Speaker
|
||||||
|
opts.ResourceID = v.ResourceID
|
||||||
|
if v.Model != "" {
|
||||||
|
opts.Model = v.Model
|
||||||
|
}
|
||||||
|
log.Printf("[tts] voice=%s 命中 (speaker=%s resource=%s model=%s) - 客户端=%s",
|
||||||
|
req.Voice, telemetry.MaskSpeaker(v.Speaker), v.ResourceID, v.Model, middleware.GetClientIP(r))
|
||||||
|
}
|
||||||
|
|
||||||
ctx, cancel := context.WithTimeout(r.Context(), setting.TTSTimeout)
|
ctx, cancel := context.WithTimeout(r.Context(), setting.TTSTimeout)
|
||||||
defer cancel()
|
defer cancel()
|
||||||
|
|
||||||
@@ -153,7 +201,10 @@ func OpenaiTTSHandler(w http.ResponseWriter, r *http.Request) {
|
|||||||
|
|
||||||
finalLabels := telemetry.Labels{
|
finalLabels := telemetry.Labels{
|
||||||
"format": clientFormat,
|
"format": clientFormat,
|
||||||
"speaker": opts.Speaker,
|
// speaker 是火山复刻音色 ID(用户付费资产),不能直接出现在 /metrics label 里
|
||||||
|
//(无鉴权可枚举)。用 sha1[:8] 替代:同 speaker 同 label 保留 per-voice 观测,
|
||||||
|
//但反推不出原值。Admin UI 想要看原名通过 /api/voices 拿 name 字段。
|
||||||
|
"speaker": telemetry.SpeakerLabel(opts.Speaker),
|
||||||
"model": opts.Model,
|
"model": opts.Model,
|
||||||
}
|
}
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -215,7 +266,12 @@ func contentTypeFor(format string) string {
|
|||||||
func HealthHandler(w http.ResponseWriter, r *http.Request) {
|
func HealthHandler(w http.ResponseWriter, r *http.Request) {
|
||||||
w.Header().Set("Content-Type", "application/json")
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
|
||||||
if setting.TTSConfigErr != nil {
|
// 安装模式下 /health 仍然 200,但通过 installed 字段让探针/运维识别
|
||||||
|
// (Kubernetes readiness probe 可以用 installed=false 决定是否放流量)
|
||||||
|
mode := installer.GetMode()
|
||||||
|
if mode == installer.ModeSetup {
|
||||||
|
w.WriteHeader(http.StatusOK) // 200,因为进程活着,只是还没初始化
|
||||||
|
} else if setting.TTSConfigErr != nil {
|
||||||
w.WriteHeader(http.StatusServiceUnavailable)
|
w.WriteHeader(http.StatusServiceUnavailable)
|
||||||
} else {
|
} else {
|
||||||
w.WriteHeader(http.StatusOK)
|
w.WriteHeader(http.StatusOK)
|
||||||
@@ -225,14 +281,17 @@ func HealthHandler(w http.ResponseWriter, r *http.Request) {
|
|||||||
allRequired := env["all_required_vars_set"].(bool)
|
allRequired := env["all_required_vars_set"].(bool)
|
||||||
|
|
||||||
status := "ok"
|
status := "ok"
|
||||||
if !allRequired {
|
if mode == installer.ModeSetup {
|
||||||
|
status = "not_installed"
|
||||||
|
} else if !allRequired {
|
||||||
status = "configuration_error"
|
status = "configuration_error"
|
||||||
}
|
}
|
||||||
|
|
||||||
resp := dto.HealthResponse{
|
resp := dto.HealthResponse{
|
||||||
Status: status,
|
Status: status,
|
||||||
Service: "ByteDance TTS to OpenAI API Adapter",
|
Service: "ByteDance TTS to OpenAI API Adapter",
|
||||||
Version: "2.0.0 (v3 API)",
|
Version: version.Version,
|
||||||
|
Commit: version.Commit,
|
||||||
Uptime: fmt.Sprintf("%.0f seconds", time.Since(startTime).Seconds()),
|
Uptime: fmt.Sprintf("%.0f seconds", time.Since(startTime).Seconds()),
|
||||||
StartTime: startTime.Format(time.RFC3339),
|
StartTime: startTime.Format(time.RFC3339),
|
||||||
Memory: collectMemorySnapshot(),
|
Memory: collectMemorySnapshot(),
|
||||||
@@ -240,6 +299,8 @@ func HealthHandler(w http.ResponseWriter, r *http.Request) {
|
|||||||
AllRequiredVarsSet: allRequired,
|
AllRequiredVarsSet: allRequired,
|
||||||
ConfigError: setting.TTSConfigErr != nil,
|
ConfigError: setting.TTSConfigErr != nil,
|
||||||
},
|
},
|
||||||
|
Installed: mode == installer.ModeNormal,
|
||||||
|
Mode: mode.String(),
|
||||||
}
|
}
|
||||||
json.NewEncoder(w).Encode(resp)
|
json.NewEncoder(w).Encode(resp)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -7,10 +7,14 @@ type HealthResponse struct {
|
|||||||
Status string `json:"status"`
|
Status string `json:"status"`
|
||||||
Service string `json:"service"`
|
Service string `json:"service"`
|
||||||
Version string `json:"version"`
|
Version string `json:"version"`
|
||||||
|
Commit string `json:"commit"`
|
||||||
Uptime string `json:"uptime"`
|
Uptime string `json:"uptime"`
|
||||||
StartTime string `json:"start_time"`
|
StartTime string `json:"start_time"`
|
||||||
Memory map[string]interface{} `json:"memory"`
|
Memory map[string]interface{} `json:"memory"`
|
||||||
ConfigStatus ConfigStatusResponse `json:"config_status"`
|
ConfigStatus ConfigStatusResponse `json:"config_status"`
|
||||||
|
// M1 新增:反映 installer 模式,便于部署探针/运维识别未初始化状态
|
||||||
|
Installed bool `json:"installed"`
|
||||||
|
Mode string `json:"mode"`
|
||||||
}
|
}
|
||||||
|
|
||||||
type ConfigStatusResponse struct {
|
type ConfigStatusResponse struct {
|
||||||
|
|||||||
@@ -58,15 +58,6 @@ type V3Usage struct {
|
|||||||
TextWords int `json:"text_words"`
|
TextWords int `json:"text_words"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// ByteDanceTTSConfig 是 setting 包的全局 TTS 配置,目前只承载鉴权 / URL / 超时;
|
|
||||||
// 完整的合成参数见 adapter/volcano.Options。
|
|
||||||
type ByteDanceTTSConfig struct {
|
|
||||||
ApiKey string
|
|
||||||
ResourceId string
|
|
||||||
URL string
|
|
||||||
Timeout time.Duration
|
|
||||||
}
|
|
||||||
|
|
||||||
// SynthesisResult 是火山适配器向 controller 返回的最终结果。
|
// SynthesisResult 是火山适配器向 controller 返回的最终结果。
|
||||||
// Format 与 AudioData 的实际编码一致;controller 据此设置响应 Content-Type。
|
// Format 与 AudioData 的实际编码一致;controller 据此设置响应 Content-Type。
|
||||||
type SynthesisResult struct {
|
type SynthesisResult struct {
|
||||||
|
|||||||
@@ -3,3 +3,16 @@ module github.com/volcano-tts/tts-api
|
|||||||
go 1.26
|
go 1.26
|
||||||
|
|
||||||
require github.com/gorilla/mux v1.8.1
|
require github.com/gorilla/mux v1.8.1
|
||||||
|
|
||||||
|
require (
|
||||||
|
github.com/dustin/go-humanize v1.0.1 // indirect
|
||||||
|
github.com/google/uuid v1.6.0 // indirect
|
||||||
|
github.com/mattn/go-isatty v0.0.24 // indirect
|
||||||
|
github.com/ncruces/go-strftime v1.0.0 // indirect
|
||||||
|
github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec // indirect
|
||||||
|
golang.org/x/sys v0.47.0 // indirect
|
||||||
|
modernc.org/libc v1.74.4 // indirect
|
||||||
|
modernc.org/mathutil v1.7.1 // indirect
|
||||||
|
modernc.org/memory v1.11.0 // indirect
|
||||||
|
modernc.org/sqlite v1.57.0 // indirect
|
||||||
|
)
|
||||||
|
|||||||
@@ -1,2 +1,22 @@
|
|||||||
|
github.com/dustin/go-humanize v1.0.1 h1:GzkhY7T5VNhEkwH0PVJgjz+fX1rhBrR7pRT3mDkpeCY=
|
||||||
|
github.com/dustin/go-humanize v1.0.1/go.mod h1:Mu1zIs6XwVuF/gI1OepvI0qD18qycQx+mFykh5fBlto=
|
||||||
|
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
|
||||||
|
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
|
||||||
github.com/gorilla/mux v1.8.1 h1:TuBL49tXwgrFYWhqrNgrUNEY92u81SPhu7sTdzQEiWY=
|
github.com/gorilla/mux v1.8.1 h1:TuBL49tXwgrFYWhqrNgrUNEY92u81SPhu7sTdzQEiWY=
|
||||||
github.com/gorilla/mux v1.8.1/go.mod h1:AKf9I4AEqPTmMytcMc0KkNouC66V3BtZ4qD5fmWSiMQ=
|
github.com/gorilla/mux v1.8.1/go.mod h1:AKf9I4AEqPTmMytcMc0KkNouC66V3BtZ4qD5fmWSiMQ=
|
||||||
|
github.com/mattn/go-isatty v0.0.24 h1:tGZZoVgT/KiqK1c8ocVLeDS8BSWMRd47J3Lbz7vsReI=
|
||||||
|
github.com/mattn/go-isatty v0.0.24/go.mod h1:nMCL3Zebbrt45jsMDgnfIwz6ydEQApk5oEI3HqDio6A=
|
||||||
|
github.com/ncruces/go-strftime v1.0.0 h1:HMFp8mLCTPp341M/ZnA4qaf7ZlsbTc+miZjCLOFAw7w=
|
||||||
|
github.com/ncruces/go-strftime v1.0.0/go.mod h1:Fwc5htZGVVkseilnfgOVb9mKy6w1naJmn9CehxcKcls=
|
||||||
|
github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec h1:W09IVJc94icq4NjY3clb7Lk8O1qJ8BdBEF8z0ibU0rE=
|
||||||
|
github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec/go.mod h1:qqbHyh8v60DhA7CoWK5oRCqLrMHRGoxYCSS9EjAz6Eo=
|
||||||
|
golang.org/x/sys v0.47.0 h1:o7XGOvZQCADBQQ4Y7VNq2dRWQR7JmOUW8Kxx4ZsNgWs=
|
||||||
|
golang.org/x/sys v0.47.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
|
||||||
|
modernc.org/libc v1.74.4 h1:fX1Omw4o2/1C2iRkkIsrQTasJQldLhRmuPreXLoWs9k=
|
||||||
|
modernc.org/libc v1.74.4/go.mod h1:eeQAS9W3sZeKYMFubydxJpII9ybHWshk+7or7bLG9co=
|
||||||
|
modernc.org/mathutil v1.7.1 h1:GCZVGXdaN8gTqB1Mf/usp1Y/hSqgI2vAGGP4jZMCxOU=
|
||||||
|
modernc.org/mathutil v1.7.1/go.mod h1:4p5IwJITfppl0G4sUEDtCr4DthTaT47/N3aT6MhfgJg=
|
||||||
|
modernc.org/memory v1.11.0 h1:o4QC8aMQzmcwCK3t3Ux/ZHmwFPzE6hf2Y5LbkRs+hbI=
|
||||||
|
modernc.org/memory v1.11.0/go.mod h1:/JP4VbVC+K5sU2wZi9bHoq2MAkCnrt2r98UGeSK7Mjw=
|
||||||
|
modernc.org/sqlite v1.57.0 h1:qNQP6xnx5M0ISNtlnxoOX0+cD5bJ0/gr9aMmndFczzg=
|
||||||
|
modernc.org/sqlite v1.57.0/go.mod h1:yCJ2cmAaIkHQ25oXWrF8H4O1lIfPYPR26yCEDj2P3pQ=
|
||||||
|
|||||||
@@ -0,0 +1,191 @@
|
|||||||
|
package installer
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"log"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/volcano-tts/tts-api/store"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Mode 表示服务当前的运行模式。
|
||||||
|
// 启动期由 Detect 确定,运行期不变。
|
||||||
|
type Mode int
|
||||||
|
|
||||||
|
const (
|
||||||
|
// ModeSetup 未安装,只放行 /setup + /api/setup/*。
|
||||||
|
ModeSetup Mode = iota
|
||||||
|
// ModeNormal 已安装,全部路由可用。
|
||||||
|
ModeNormal
|
||||||
|
)
|
||||||
|
|
||||||
|
func (m Mode) String() string {
|
||||||
|
switch m {
|
||||||
|
case ModeSetup:
|
||||||
|
return "setup"
|
||||||
|
case ModeNormal:
|
||||||
|
return "normal"
|
||||||
|
}
|
||||||
|
return "unknown"
|
||||||
|
}
|
||||||
|
|
||||||
|
// CurrentMode 是 Detect 确定的运行期模式;供 controller/middleware 双保险使用。
|
||||||
|
// 进程内只有一个二进制实例,所以全局变量是合适的;不必走 DI。
|
||||||
|
var CurrentMode Mode = ModeSetup // 默认 setup,Detect 后会被覆盖
|
||||||
|
|
||||||
|
// SetMode 在 Detect 完成后调用,设置进程级模式。
|
||||||
|
func SetMode(m Mode) { CurrentMode = m }
|
||||||
|
|
||||||
|
// GetMode 返回进程级模式;Controller 双保险用。
|
||||||
|
func GetMode() Mode { return CurrentMode }
|
||||||
|
|
||||||
|
// Result 是 Detect 的完整输出;调用方关心 Mode + 一些诊断信息。
|
||||||
|
type Result struct {
|
||||||
|
Mode Mode
|
||||||
|
DBPath string // 实际打开的 db 路径
|
||||||
|
LockPath string
|
||||||
|
Corrupted bool // 这次启动是否从损坏回退
|
||||||
|
BackupTo string // 损坏回退时备份文件路径
|
||||||
|
}
|
||||||
|
|
||||||
|
// ErrInUse 标识在 Detect 期间发现 db 正在被另一个进程占用;
|
||||||
|
// 这种情况下不应该自动 rename,会破坏另一个进程的运行。
|
||||||
|
// 上层应记录日志并按"装模式"启动,等下次重启再处理。
|
||||||
|
var ErrInUse = errors.New("installer: database is locked by another process")
|
||||||
|
|
||||||
|
// Detect 是启动期的总入口:打开/创建 db、判定 lock、检测损坏并自愈。
|
||||||
|
//
|
||||||
|
// 流程:
|
||||||
|
// 1. Open db(可能新建)
|
||||||
|
// 2. 检查 lock:
|
||||||
|
// - 不存在 → ModeSetup
|
||||||
|
// - 存在 → 跑 IntegrityCheck
|
||||||
|
// - 通过 → ModeNormal
|
||||||
|
// - 不通过 → 备份 db.corrupt-<ts> + 删 lock + ModeSetup(并标记 Corrupted=true)
|
||||||
|
//
|
||||||
|
// 返回的 *store.Store 必须由调用方在进程退出时 Close。
|
||||||
|
func Detect(dbPath string) (*store.Store, Result, error) {
|
||||||
|
if dbPath == "" {
|
||||||
|
return nil, Result{}, fmt.Errorf("installer: db path is empty")
|
||||||
|
}
|
||||||
|
|
||||||
|
res := Result{
|
||||||
|
DBPath: dbPath,
|
||||||
|
LockPath: LockPath(dbPath),
|
||||||
|
}
|
||||||
|
|
||||||
|
s, err := store.Open(dbPath)
|
||||||
|
if err != nil {
|
||||||
|
// 打开失败通常意味着文件损坏;走自愈回退。
|
||||||
|
// 重要:不要区分"不存在"和"损坏"——SQLite 第一次 Open 会自动建空库,
|
||||||
|
// 如果"不存在"能走到这里说明更严重的系统错误,也不该贸然启动。
|
||||||
|
if backup, ok := tryBackupCorrupt(dbPath, err); ok {
|
||||||
|
res.Corrupted = true
|
||||||
|
res.BackupTo = backup
|
||||||
|
log.Printf("[installer] 检测到损坏 db,已备份到 %q,删除 lock,回退到安装模式", backup)
|
||||||
|
} else {
|
||||||
|
return nil, res, fmt.Errorf("installer: open db %q failed: %w", dbPath, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// lock 状态判定
|
||||||
|
exists, err := LockExists(dbPath)
|
||||||
|
if err != nil {
|
||||||
|
if s != nil {
|
||||||
|
_ = s.Close()
|
||||||
|
}
|
||||||
|
return nil, res, fmt.Errorf("installer: lock check failed: %w", err)
|
||||||
|
}
|
||||||
|
if !exists {
|
||||||
|
res.Mode = ModeSetup
|
||||||
|
SetMode(ModeSetup)
|
||||||
|
if !res.Corrupted {
|
||||||
|
log.Printf("[installer] 启动模式: 安装模式(无 lock 文件)")
|
||||||
|
}
|
||||||
|
return s, res, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// lock 在,跑完整性检查
|
||||||
|
if s == nil {
|
||||||
|
// 自愈回退已经走完,应该删了 lock;但保险起见再删一次
|
||||||
|
if err := DeleteLock(dbPath); err != nil {
|
||||||
|
return nil, res, fmt.Errorf("installer: delete lock after fallback: %w", err)
|
||||||
|
}
|
||||||
|
res.Mode = ModeSetup
|
||||||
|
SetMode(ModeSetup)
|
||||||
|
return nil, res, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
check, err := s.IntegrityCheck()
|
||||||
|
if err != nil {
|
||||||
|
_ = s.Close()
|
||||||
|
// integrity_check 自身报错,等同损坏,走自愈
|
||||||
|
backup, ok := tryBackupCorrupt(dbPath, err)
|
||||||
|
if !ok {
|
||||||
|
return nil, res, fmt.Errorf("installer: integrity_check failed: %w", err)
|
||||||
|
}
|
||||||
|
_ = DeleteLock(dbPath)
|
||||||
|
res.Corrupted = true
|
||||||
|
res.BackupTo = backup
|
||||||
|
res.Mode = ModeSetup
|
||||||
|
SetMode(ModeSetup)
|
||||||
|
log.Printf("[installer] integrity_check 错误,已备份到 %q,删除 lock,回退到安装模式", backup)
|
||||||
|
return nil, res, nil
|
||||||
|
}
|
||||||
|
if check != "ok" {
|
||||||
|
_ = s.Close()
|
||||||
|
backup, ok := tryBackupCorrupt(dbPath, fmt.Errorf("integrity_check returned: %s", check))
|
||||||
|
if !ok {
|
||||||
|
return nil, res, fmt.Errorf("installer: integrity_check = %q (not ok)", check)
|
||||||
|
}
|
||||||
|
_ = DeleteLock(dbPath)
|
||||||
|
res.Corrupted = true
|
||||||
|
res.BackupTo = backup
|
||||||
|
res.Mode = ModeSetup
|
||||||
|
SetMode(ModeSetup)
|
||||||
|
log.Printf("[installer] 库不完整(integrity_check=%q),已备份到 %q,删除 lock,回退到安装模式", check, backup)
|
||||||
|
return nil, res, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
res.Mode = ModeNormal
|
||||||
|
SetMode(ModeNormal)
|
||||||
|
log.Printf("[installer] 启动模式: 正常模式(lock=%s)", res.LockPath)
|
||||||
|
return s, res, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// tryBackupCorrupt 尝试把损坏的 db 文件 rename 为 .corrupt-<unix-ms>;
|
||||||
|
// 成功返回 (新路径, true),失败 (任何原因) 返回 ("", false)。
|
||||||
|
// 注意:这里不返回 error,因为 "无法备份" 不应阻止回退(可以后续人工排查)。
|
||||||
|
func tryBackupCorrupt(dbPath string, reason error) (string, bool) {
|
||||||
|
if dbPath == "" {
|
||||||
|
return "", false
|
||||||
|
}
|
||||||
|
// 不存在的话没法 rename(也没必要)
|
||||||
|
if _, err := os.Stat(dbPath); err != nil {
|
||||||
|
return "", false
|
||||||
|
}
|
||||||
|
ts := time.Now().UnixMilli()
|
||||||
|
backup := fmt.Sprintf("%s.corrupt-%d", dbPath, ts)
|
||||||
|
if err := os.Rename(dbPath, backup); err != nil {
|
||||||
|
log.Printf("[installer] 备份损坏 db 失败: %v(将直接重建空库)", err)
|
||||||
|
return "", false
|
||||||
|
}
|
||||||
|
log.Printf("[installer] 损坏原因: %v", reason)
|
||||||
|
return backup, true
|
||||||
|
}
|
||||||
|
|
||||||
|
// EnsureDBDir 确保 dbPath 所在目录存在(对首次安装很有用;
|
||||||
|
// 当 dbDir 是新目录时 store.Open 之前需要先 mkdir)。
|
||||||
|
func EnsureDBDir(dbPath string) error {
|
||||||
|
if dbPath == "" {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
dir := filepath.Dir(dbPath)
|
||||||
|
if dir == "" || dir == "." {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return os.MkdirAll(dir, 0o755)
|
||||||
|
}
|
||||||
@@ -0,0 +1,121 @@
|
|||||||
|
// Package installer 负责安装状态判定:lock 文件检测/创建/删除、
|
||||||
|
// 启动期 Detect 流程、损坏自愈回退。
|
||||||
|
//
|
||||||
|
// 设计要点:
|
||||||
|
// - lock 文件路径: <dbDir>/installed.lock,与 tts.db 同目录
|
||||||
|
// - lock 不存在 = 未安装(进入安装模式)
|
||||||
|
// - lock 存在 + 库 OK = 已安装(正常模式)
|
||||||
|
// - lock 存在 + 库损坏 = 自动备份 + 删 lock + 回到安装模式
|
||||||
|
// - 写顺序: 先写库,后写 lock(避免 lock 在、库是半成品)
|
||||||
|
// - 写锁用临时文件 + 原子 rename,避免崩溃中途留半成品 lock
|
||||||
|
package installer
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// lockFileName 是 lock 文件名;固定不变,所有部署共用。
|
||||||
|
const lockFileName = "installed.lock"
|
||||||
|
|
||||||
|
// schemaVersion 是 lock 内容里的 schema 版本号;留作未来版本兼容判断。
|
||||||
|
// 未来若有破坏性升级,可读这个值决定是否要重装/迁移。
|
||||||
|
const schemaVersion = "1"
|
||||||
|
|
||||||
|
// LockPath 返回给定 db 路径下 lock 文件的绝对路径。
|
||||||
|
// dbPath 通常是 .db 文件路径(不是目录);若传入目录则直接拼 lockFileName。
|
||||||
|
func LockPath(dbPath string) string {
|
||||||
|
if dbPath == "" {
|
||||||
|
return lockFileName
|
||||||
|
}
|
||||||
|
// 如果 dbPath 是已存在的目录,直接拼文件名
|
||||||
|
if info, err := os.Stat(dbPath); err == nil && info.IsDir() {
|
||||||
|
return filepath.Join(dbPath, lockFileName)
|
||||||
|
}
|
||||||
|
dir := filepath.Dir(dbPath)
|
||||||
|
return filepath.Join(dir, lockFileName)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ErrLockExists 表示 lock 已存在;CreateLock 会返回这个,提醒上层别覆盖。
|
||||||
|
var ErrLockExists = errors.New("installer: lock already exists")
|
||||||
|
|
||||||
|
// LockExists 检测 lock 文件是否存在;不存在不算错误(常见的"未安装"状态)。
|
||||||
|
func LockExists(dbPath string) (bool, error) {
|
||||||
|
p := LockPath(dbPath)
|
||||||
|
_, err := os.Stat(p)
|
||||||
|
if err == nil {
|
||||||
|
return true, nil
|
||||||
|
}
|
||||||
|
if errors.Is(err, os.ErrNotExist) {
|
||||||
|
return false, nil
|
||||||
|
}
|
||||||
|
return false, fmt.Errorf("installer: stat lock %q: %w", p, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CreateLock 原子写入 lock 文件;lock 已存在返回 ErrLockExists。
|
||||||
|
// 内容: "version <schemaVersion> <RFC3339 时间戳>"
|
||||||
|
func CreateLock(dbPath string) error {
|
||||||
|
exists, err := LockExists(dbPath)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if exists {
|
||||||
|
return ErrLockExists
|
||||||
|
}
|
||||||
|
|
||||||
|
p := LockPath(dbPath)
|
||||||
|
content := fmt.Sprintf("version %s %s\n", schemaVersion, time.Now().UTC().Format(time.RFC3339))
|
||||||
|
|
||||||
|
// 原子写入:先写临时文件,再 rename
|
||||||
|
dir := filepath.Dir(p)
|
||||||
|
tmp, err := os.CreateTemp(dir, ".installed.lock.*.tmp")
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("installer: create lock tmp: %w", err)
|
||||||
|
}
|
||||||
|
tmpName := tmp.Name()
|
||||||
|
// 确保临时文件最终被清理(出错时)
|
||||||
|
defer func() {
|
||||||
|
_ = os.Remove(tmpName)
|
||||||
|
}()
|
||||||
|
|
||||||
|
if _, err := tmp.WriteString(content); err != nil {
|
||||||
|
_ = tmp.Close()
|
||||||
|
return fmt.Errorf("installer: write lock tmp: %w", err)
|
||||||
|
}
|
||||||
|
if err := tmp.Close(); err != nil {
|
||||||
|
return fmt.Errorf("installer: close lock tmp: %w", err)
|
||||||
|
}
|
||||||
|
if err := os.Rename(tmpName, p); err != nil {
|
||||||
|
return fmt.Errorf("installer: rename lock tmp: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteLock 删 lock;不存在不报错。
|
||||||
|
// 主要用于损坏自愈流程和测试清理。
|
||||||
|
func DeleteLock(dbPath string) error {
|
||||||
|
p := LockPath(dbPath)
|
||||||
|
err := os.Remove(p)
|
||||||
|
if err == nil || errors.Is(err, os.ErrNotExist) {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return fmt.Errorf("installer: remove lock %q: %w", p, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReadLock 读 lock 内容;主要用于诊断日志和未来版本兼容判断。
|
||||||
|
// 不存在返回 ("", nil)。
|
||||||
|
func ReadLock(dbPath string) (string, error) {
|
||||||
|
p := LockPath(dbPath)
|
||||||
|
b, err := os.ReadFile(p)
|
||||||
|
if err != nil {
|
||||||
|
if errors.Is(err, os.ErrNotExist) {
|
||||||
|
return "", nil
|
||||||
|
}
|
||||||
|
return "", fmt.Errorf("installer: read lock %q: %w", p, err)
|
||||||
|
}
|
||||||
|
return strings.TrimSpace(string(b)), nil
|
||||||
|
}
|
||||||
@@ -10,23 +10,68 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/volcano-tts/tts-api/controller"
|
"github.com/volcano-tts/tts-api/controller"
|
||||||
|
"github.com/volcano-tts/tts-api/installer"
|
||||||
"github.com/volcano-tts/tts-api/metrics"
|
"github.com/volcano-tts/tts-api/metrics"
|
||||||
"github.com/volcano-tts/tts-api/middleware"
|
"github.com/volcano-tts/tts-api/middleware"
|
||||||
"github.com/volcano-tts/tts-api/router"
|
"github.com/volcano-tts/tts-api/router"
|
||||||
"github.com/volcano-tts/tts-api/setting"
|
"github.com/volcano-tts/tts-api/setting"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// ttsDBPath 返回数据库/lock 所在路径;空时落到当前目录的 tts.db。
|
||||||
|
func ttsDBPath() string {
|
||||||
|
if p := os.Getenv("TTS_DB_PATH"); p != "" {
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
return "tts.db"
|
||||||
|
}
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
log.SetFlags(log.LstdFlags | log.Lshortfile)
|
log.SetFlags(log.LstdFlags | log.Lshortfile)
|
||||||
log.SetPrefix("[TTS-Server] ")
|
log.SetPrefix("[TTS-Server] ")
|
||||||
|
|
||||||
|
// 1) 加载引导环境变量(PORT / TTS_ADMIN_KEY / OPENAI_TTS_API_KEY 兜底)
|
||||||
|
// 注: Auth.APIKeys 在 InitAllConfigs 里先读 env,后被 LoadRuntimeConfig 覆盖为 DB 值。
|
||||||
setting.InitAllConfigs()
|
setting.InitAllConfigs()
|
||||||
metrics.Init()
|
metrics.Init()
|
||||||
middleware.InitRateLimiter()
|
middleware.InitRateLimiter()
|
||||||
setting.CheckStaticFiles()
|
|
||||||
controller.InitController()
|
|
||||||
setting.LogStartupSummary()
|
|
||||||
|
|
||||||
|
// 2) 启动期关键步骤:打开/建库 → 检测 lock → 判定模式
|
||||||
|
dbPath := ttsDBPath()
|
||||||
|
if err := installer.EnsureDBDir(dbPath); err != nil {
|
||||||
|
log.Fatalf("FATAL: cannot create db dir: %v", err)
|
||||||
|
}
|
||||||
|
st, res, err := installer.Detect(dbPath)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatalf("FATAL: installer detect failed: %v", err)
|
||||||
|
}
|
||||||
|
if res.Corrupted {
|
||||||
|
log.Printf("[main] 注意: 启动时检测到 db 损坏并已自愈回退(备份=%s)", res.BackupTo)
|
||||||
|
}
|
||||||
|
|
||||||
|
// 3) 注入 setup/admin 控制器需要的句柄(M1+M2)
|
||||||
|
controller.SetSetupState(st, dbPath)
|
||||||
|
controller.SetAdminStore(st)
|
||||||
|
controller.SetMetricsTextWriter(func(w http.ResponseWriter) error {
|
||||||
|
metrics.Meter.Handler().ServeHTTP(w, &http.Request{})
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
|
||||||
|
// 4) M3: 从 store 加载运行时 TTS 配置(替代原来的 env-based InitTTSConfig)
|
||||||
|
// 必须在 LogStartupSummary 之前,这样日志显示的是真实状态(API key 已从 DB 加载,不再读 env)
|
||||||
|
if st != nil {
|
||||||
|
if err := setting.LoadRuntimeConfig(st); err != nil {
|
||||||
|
log.Printf("[main] TTS 运行时配置加载失败:%v", err)
|
||||||
|
} else {
|
||||||
|
log.Printf("[main] TTS 运行时配置已加载(api_key=***, speaker=%s, resource=%s, format=%s)",
|
||||||
|
setting.TTSOptions.Speaker, setting.TTSOptions.ResourceID, setting.TTSOptions.Format)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 5) 启动摘要日志(此时 Auth.APIKeys 已是 DB 值,日志反映真实状态)
|
||||||
|
setting.LogStartupSummary()
|
||||||
|
log.Printf("[main] 当前模式: %s (db=%s lock=%s)", res.Mode, dbPath, res.LockPath)
|
||||||
|
|
||||||
|
controller.InitController()
|
||||||
controller.SetStartTime(time.Now())
|
controller.SetStartTime(time.Now())
|
||||||
|
|
||||||
r := router.Setup()
|
r := router.Setup()
|
||||||
@@ -43,12 +88,17 @@ func main() {
|
|||||||
signal.Notify(quit, syscall.SIGINT, syscall.SIGTERM)
|
signal.Notify(quit, syscall.SIGINT, syscall.SIGTERM)
|
||||||
|
|
||||||
go func() {
|
go func() {
|
||||||
|
if installer.GetMode() == installer.ModeSetup {
|
||||||
|
log.Printf("Starting TTS Server in SETUP mode")
|
||||||
|
log.Printf("Open browser to http://localhost:%s/setup to install", setting.Server.Port)
|
||||||
|
} else {
|
||||||
log.Printf("Starting ByteDance TTS to OpenAI API Adapter Server")
|
log.Printf("Starting ByteDance TTS to OpenAI API Adapter Server")
|
||||||
log.Printf("Listening on port: %s", setting.Server.Port)
|
log.Printf("Listening on port: %s", setting.Server.Port)
|
||||||
log.Printf("OpenAI TTS endpoint: http://localhost:%s/v1/audio/speech", setting.Server.Port)
|
log.Printf("OpenAI TTS endpoint: http://localhost:%s/v1/audio/speech", setting.Server.Port)
|
||||||
|
log.Printf("Admin WebUI: http://localhost:%s/admin", setting.Server.Port)
|
||||||
|
}
|
||||||
log.Printf("Health check: http://localhost:%s/health", setting.Server.Port)
|
log.Printf("Health check: http://localhost:%s/health", setting.Server.Port)
|
||||||
log.Printf("Metrics: http://localhost:%s/metrics", setting.Server.Port)
|
log.Printf("Metrics: http://localhost:%s/metrics", setting.Server.Port)
|
||||||
log.Printf("Using ByteDance v3 API")
|
|
||||||
|
|
||||||
if err := server.ListenAndServe(); err != nil && err != http.ErrServerClosed {
|
if err := server.ListenAndServe(); err != nil && err != http.ErrServerClosed {
|
||||||
log.Fatalf("Server failed to start: %v", err)
|
log.Fatalf("Server failed to start: %v", err)
|
||||||
@@ -58,6 +108,11 @@ func main() {
|
|||||||
<-quit
|
<-quit
|
||||||
log.Println("Shutting down server...")
|
log.Println("Shutting down server...")
|
||||||
|
|
||||||
|
// 关闭 db 连接(仅当 st 非 nil 时)
|
||||||
|
if st != nil {
|
||||||
|
_ = st.Close()
|
||||||
|
}
|
||||||
|
|
||||||
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
|
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
|
||||||
defer cancel()
|
defer cancel()
|
||||||
|
|
||||||
|
|||||||
+8
-3
@@ -114,12 +114,14 @@ type AdapterRecorder struct{}
|
|||||||
|
|
||||||
// UpstreamStarted 满足 volcano.MetricsRecorder 接口。
|
// UpstreamStarted 满足 volcano.MetricsRecorder 接口。
|
||||||
func (AdapterRecorder) UpstreamStarted(speaker, model, format string) {
|
func (AdapterRecorder) UpstreamStarted(speaker, model, format string) {
|
||||||
UpstreamTotal.Inc(telemetry.Labels{"status": "started", "format": format, "model": model, "speaker": speaker})
|
// speaker 用 sha1[:8] 替代,保护火山复刻音色 ID
|
||||||
|
// (无鉴权 /metrics 端点可枚举,这是 P0 隐私问题)
|
||||||
|
UpstreamTotal.Inc(telemetry.Labels{"status": "started", "format": format, "model": model, "speaker": telemetry.SpeakerLabel(speaker)})
|
||||||
}
|
}
|
||||||
|
|
||||||
// UpstreamFinished 满足 volcano.MetricsRecorder 接口。
|
// UpstreamFinished 满足 volcano.MetricsRecorder 接口。
|
||||||
func (AdapterRecorder) UpstreamFinished(speaker, model, format, status string, duration, ttfb time.Duration, chunks, audioBytes, errCode int) {
|
func (AdapterRecorder) UpstreamFinished(speaker, model, format, status string, duration, ttfb time.Duration, chunks, audioBytes, errCode int) {
|
||||||
labels := telemetry.Labels{"status": status, "format": format, "model": model, "speaker": speaker}
|
labels := telemetry.Labels{"status": status, "format": format, "model": model, "speaker": telemetry.SpeakerLabel(speaker)}
|
||||||
UpstreamTotal.Inc(labels)
|
UpstreamTotal.Inc(labels)
|
||||||
UpstreamDuration.Observe(duration.Seconds(), telemetry.Labels{"status": status, "format": format})
|
UpstreamDuration.Observe(duration.Seconds(), telemetry.Labels{"status": status, "format": format})
|
||||||
if ttfb > 0 {
|
if ttfb > 0 {
|
||||||
@@ -131,7 +133,10 @@ func (AdapterRecorder) UpstreamFinished(speaker, model, format, status string, d
|
|||||||
if audioBytes > 0 {
|
if audioBytes > 0 {
|
||||||
UpstreamBytes.Add(float64(audioBytes), telemetry.Labels{"format": format})
|
UpstreamBytes.Add(float64(audioBytes), telemetry.Labels{"format": format})
|
||||||
}
|
}
|
||||||
if errCode != 0 {
|
// 上游调用只要 status != "ok" 即视为错误。原版 if errCode != 0 会漏掉
|
||||||
|
// errCode=0 的 request_error / transport_error / wrap_error / stream_error
|
||||||
|
// (code=0 的流错误) 等场景,导致 transport 类错误在 /metrics 上完全不可见。
|
||||||
|
if status != "ok" {
|
||||||
UpstreamErrors.Inc(telemetry.Labels{"code": codeLabel(errCode)})
|
UpstreamErrors.Inc(telemetry.Labels{"code": codeLabel(errCode)})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,73 @@
|
|||||||
|
package middleware
|
||||||
|
|
||||||
|
import (
|
||||||
|
"log"
|
||||||
|
"net/http"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"github.com/volcano-tts/tts-api/common"
|
||||||
|
"github.com/volcano-tts/tts-api/setting"
|
||||||
|
)
|
||||||
|
|
||||||
|
// RequireAdmin 是 /admin 路由的鉴权中间件,复用 OPENAI_TTS_API_KEY。
|
||||||
|
// 行为:
|
||||||
|
// - Auth.APIKeys 为空 → 所有请求放行(等同无鉴权)
|
||||||
|
// - Authorization 头 Bearer token 在列表中 → 放行
|
||||||
|
// - 其它 → 401 + JSON {error: 'unauthorized', code: 'admin_auth_failed'}
|
||||||
|
//
|
||||||
|
// 设计: 与现有 /v1/audio/speech 用的 setting.Auth 共享同一份 keys,
|
||||||
|
// 用户只用管一个 env 变量(OPENAI_TTS_API_KEY)。
|
||||||
|
func RequireAdmin(next http.Handler) http.Handler {
|
||||||
|
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
// 预检: 跨域/OPTIONS 直接放行(让浏览器能发 preflight)
|
||||||
|
if r.Method == http.MethodOptions {
|
||||||
|
next.ServeHTTP(w, r)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
keys := setting.Auth.APIKeys
|
||||||
|
if len(keys) == 0 {
|
||||||
|
// 没配 admin key,等同无鉴权
|
||||||
|
next.ServeHTTP(w, r)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
auth := r.Header.Get("Authorization")
|
||||||
|
const prefix = "Bearer "
|
||||||
|
if !strings.HasPrefix(auth, prefix) {
|
||||||
|
denyAdmin(w, r)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
token := strings.TrimSpace(auth[len(prefix):])
|
||||||
|
if !inAPIKeyList(token, keys) {
|
||||||
|
denyAdmin(w, r)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
next.ServeHTTP(w, r)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// inAPIKeyList 用常量时间比较,防 token 计时攻击。
|
||||||
|
// 单个 key 也走同一条路径,无差别处理。
|
||||||
|
func inAPIKeyList(token string, keys []string) bool {
|
||||||
|
if token == "" {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
match := false
|
||||||
|
for _, k := range keys {
|
||||||
|
if common.SecureEqualString(token, k) {
|
||||||
|
match = true
|
||||||
|
// 不 break,继续遍历,保持时间恒定
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return match
|
||||||
|
}
|
||||||
|
|
||||||
|
// denyAdmin 写 401 + JSON 错误体,记录客户端 IP。
|
||||||
|
func denyAdmin(w http.ResponseWriter, r *http.Request) {
|
||||||
|
log.Printf("[admin_auth] 鉴权失败 - 路径=%s 客户端=%s", r.URL.Path, GetClientIP(r))
|
||||||
|
w.Header().Set("Content-Type", "application/json; charset=utf-8")
|
||||||
|
w.Header().Set("WWW-Authenticate", `Bearer realm="tts-admin"`)
|
||||||
|
w.WriteHeader(http.StatusUnauthorized)
|
||||||
|
_, _ = w.Write([]byte(`{"error":{"code":"admin_auth_failed","message":"unauthorized","type":"authentication_error"}}`))
|
||||||
|
}
|
||||||
@@ -9,13 +9,6 @@ import (
|
|||||||
"github.com/volcano-tts/tts-api/setting"
|
"github.com/volcano-tts/tts-api/setting"
|
||||||
)
|
)
|
||||||
|
|
||||||
// InitAPIKeys 已在 setting.InitAuthConfig 中完成,这里保留为 no-op 以维持现有调用顺序。
|
|
||||||
// 实际鉴权逻辑直接读 setting.Auth.APIKeys。
|
|
||||||
func InitAPIKeys() {
|
|
||||||
// 配置由 setting 包统一加载,日志也由 setting.LogStartupSummary 输出。
|
|
||||||
_ = setting.Auth
|
|
||||||
}
|
|
||||||
|
|
||||||
func ValidateAPIKey(r *http.Request) bool {
|
func ValidateAPIKey(r *http.Request) bool {
|
||||||
if len(setting.Auth.APIKeys) == 0 {
|
if len(setting.Auth.APIKeys) == 0 {
|
||||||
return true
|
return true
|
||||||
|
|||||||
+74
-7
@@ -6,6 +6,7 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
"github.com/volcano-tts/tts-api/common"
|
"github.com/volcano-tts/tts-api/common"
|
||||||
|
"github.com/volcano-tts/tts-api/installer"
|
||||||
"github.com/volcano-tts/tts-api/setting"
|
"github.com/volcano-tts/tts-api/setting"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -13,13 +14,6 @@ var (
|
|||||||
corsMaxAgeHeader = "86400"
|
corsMaxAgeHeader = "86400"
|
||||||
)
|
)
|
||||||
|
|
||||||
// InitCORSConfig 已在 setting.InitCORSConfig 中完成,这里保留为 no-op 以维持现有调用顺序。
|
|
||||||
// 实际 CORS 匹配逻辑直接读 setting.CORS.Origins / setting.CORS.AllowAll。
|
|
||||||
func InitCORSConfig() {
|
|
||||||
// 配置由 setting 包统一加载,日志也由 setting.LogStartupSummary 输出。
|
|
||||||
_ = setting.CORS
|
|
||||||
}
|
|
||||||
|
|
||||||
func isValidOrigin(origin string) bool {
|
func isValidOrigin(origin string) bool {
|
||||||
if origin == "" || origin == "null" || origin == "nil" {
|
if origin == "" || origin == "null" || origin == "nil" {
|
||||||
return false
|
return false
|
||||||
@@ -47,8 +41,73 @@ func matchOrigin(origin string) (string, bool) {
|
|||||||
return "", false
|
return "", false
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// isSameOrigin 比较 Origin 与 r.Host,判断是否同源。
|
||||||
|
// - 直接访问(server 自己:80): Origin=http://server:80, Host=server:80 → 同源
|
||||||
|
// - 反向代理(https://app.example.com → http://server:80):
|
||||||
|
// Origin=https://app.example.com, Host=server:80
|
||||||
|
// 默认不同源;但如果设置 TRUSTED_PROXY_HOPS 或 X-Forwarded-Host,要让它们一致。
|
||||||
|
// - 浏览器对同源 POST 也会设 Origin(避免被自己的 CORS 误伤),这里豁免。
|
||||||
|
// 返回 true 表示请求来自自己,无需 CORS 介入。
|
||||||
|
func isSameOrigin(r *http.Request) bool {
|
||||||
|
origin := r.Header.Get("Origin")
|
||||||
|
if origin == "" {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
// 解析 Origin 的 host 部分
|
||||||
|
originHost, originScheme := splitOrigin(origin)
|
||||||
|
if originHost == "" {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
// 优先用 X-Forwarded-Host / X-Forwarded-Proto(反向代理场景),
|
||||||
|
// 退而用 r.Host(直接访问场景)
|
||||||
|
reqHost := r.Host
|
||||||
|
if fh := r.Header.Get("X-Forwarded-Host"); fh != "" {
|
||||||
|
// X-Forwarded-Host 可能是 host1, host2 (取第一个)
|
||||||
|
if i := strings.Index(fh, ","); i >= 0 {
|
||||||
|
fh = strings.TrimSpace(fh[:i])
|
||||||
|
}
|
||||||
|
reqHost = fh
|
||||||
|
}
|
||||||
|
reqScheme := "http"
|
||||||
|
if r.TLS != nil {
|
||||||
|
reqScheme = "https"
|
||||||
|
} else if fp := r.Header.Get("X-Forwarded-Proto"); fp != "" {
|
||||||
|
if i := strings.Index(fp, ","); i >= 0 {
|
||||||
|
fp = strings.TrimSpace(fp[:i])
|
||||||
|
}
|
||||||
|
reqScheme = strings.ToLower(fp)
|
||||||
|
}
|
||||||
|
// host 匹配(忽略大小写)
|
||||||
|
return strings.EqualFold(originHost, reqHost) && strings.EqualFold(originScheme, reqScheme)
|
||||||
|
}
|
||||||
|
|
||||||
|
// splitOrigin 把 "https://example.com:8080" 拆成 ("example.com:8080", "https")。
|
||||||
|
// 没有 scheme 时返回 ("", "")。
|
||||||
|
func splitOrigin(origin string) (host, scheme string) {
|
||||||
|
idx := strings.Index(origin, "://")
|
||||||
|
if idx < 0 || idx == 0 {
|
||||||
|
return "", ""
|
||||||
|
}
|
||||||
|
scheme = origin[:idx]
|
||||||
|
rest := origin[idx+3:]
|
||||||
|
// 去掉 path 部分
|
||||||
|
if i := strings.Index(rest, "/"); i >= 0 {
|
||||||
|
rest = rest[:i]
|
||||||
|
}
|
||||||
|
return rest, scheme
|
||||||
|
}
|
||||||
|
|
||||||
func CORS(next http.Handler) http.Handler {
|
func CORS(next http.Handler) http.Handler {
|
||||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
// 安装模式完全跳过 CORS:
|
||||||
|
// - 用户首次装,不可能提前知道自己的访问域名来配 ALLOWED_ORIGINS
|
||||||
|
// - 装完进 normal 模式后,设的 CORS 才生效(从 DB 读)
|
||||||
|
// 这样 install 永远能成功,装完再通过 WebUI 配 CORS。
|
||||||
|
if installer.GetMode() == installer.ModeSetup {
|
||||||
|
next.ServeHTTP(w, r)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
origin := r.Header.Get("Origin")
|
origin := r.Header.Get("Origin")
|
||||||
|
|
||||||
// 无 Origin 头:非跨域请求,跳过 CORS 处理
|
// 无 Origin 头:非跨域请求,跳过 CORS 处理
|
||||||
@@ -57,6 +116,14 @@ func CORS(next http.Handler) http.Handler {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// 同源豁免:浏览器对同源 POST/JSON 也会发 Origin 头(防 fetch 滥用),
|
||||||
|
// 但同源请求本就不需要 CORS 介入。这里对比 Origin 与 Host(含 X-Forwarded-*),
|
||||||
|
// 一致就放行,避免自家人被自家 CORS 拦。
|
||||||
|
if isSameOrigin(r) {
|
||||||
|
next.ServeHTTP(w, r)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
// 有 Origin 头时,响应必须携带 Vary: Origin 防止 CDN 缓存污染
|
// 有 Origin 头时,响应必须携带 Vary: Origin 防止 CDN 缓存污染
|
||||||
vary := w.Header().Get("Vary")
|
vary := w.Header().Get("Vary")
|
||||||
if vary == "" {
|
if vary == "" {
|
||||||
|
|||||||
@@ -0,0 +1,81 @@
|
|||||||
|
package middleware
|
||||||
|
|
||||||
|
import (
|
||||||
|
"log"
|
||||||
|
"net/http"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"github.com/volcano-tts/tts-api/installer"
|
||||||
|
)
|
||||||
|
|
||||||
|
// InstallGuard 拦截所有非白名单路由,在安装模式下按 Accept 头做内容协商:
|
||||||
|
//
|
||||||
|
// - text/html 类(浏览器) → 302 重定向到 /setup
|
||||||
|
// - 其它(API 客户端、curl 等) → 503 + JSON
|
||||||
|
//
|
||||||
|
// 设计:放行白名单路径前缀,其余一律拦截。
|
||||||
|
// 中间件顺序:必须装在 RateLimit / ConcurrencyLimit / Logger 之前,
|
||||||
|
// 避免安装模式下被限流计数污染(参考 M1 风险点 #2)。
|
||||||
|
func InstallGuard(currentMode func() installer.Mode, allowPrefixes ...string) func(http.Handler) http.Handler {
|
||||||
|
defaults := []string{
|
||||||
|
"/setup", // 安装引导页
|
||||||
|
"/api/setup", // 安装相关 API
|
||||||
|
"/health", // 部署探针要能识别未安装状态
|
||||||
|
"/metrics", // Prometheus 拉取
|
||||||
|
"/static/", // 引导页静态资源(留口子)
|
||||||
|
}
|
||||||
|
allow := append(defaults, allowPrefixes...)
|
||||||
|
|
||||||
|
return func(next http.Handler) http.Handler {
|
||||||
|
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if currentMode() != installer.ModeSetup {
|
||||||
|
next.ServeHTTP(w, r)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
// 安装模式:仅放行白名单
|
||||||
|
path := r.URL.Path
|
||||||
|
for _, p := range allow {
|
||||||
|
if strings.HasPrefix(path, p) {
|
||||||
|
next.ServeHTTP(w, r)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
log.Printf("[installguard] 安装模式下拒绝非白名单请求 - 路径=%s 客户端=%s accept=%q",
|
||||||
|
path, GetClientIP(r), r.Header.Get("Accept"))
|
||||||
|
// 内容协商:浏览器自动跳 /setup,API 客户端拿 JSON。
|
||||||
|
// / 不在白名单里,所以这里同时覆盖"敲域名根路径"和"敲其他路径"两种场景。
|
||||||
|
if acceptsHTML(r.Header.Get("Accept")) {
|
||||||
|
w.Header().Set("Location", "/setup")
|
||||||
|
w.WriteHeader(http.StatusFound) // 302
|
||||||
|
return
|
||||||
|
}
|
||||||
|
w.Header().Set("Content-Type", "application/json; charset=utf-8")
|
||||||
|
w.WriteHeader(http.StatusServiceUnavailable)
|
||||||
|
_, _ = w.Write([]byte(`{"error":"not installed","code":"install_required","redirect":"/setup"}`))
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// acceptsHTML 判断客户端是否接受 HTML 响应。
|
||||||
|
// 严格匹配:Accept 必须显式包含 text/html 或 text/*,避免通配 */*(curl/API 默认)
|
||||||
|
// 走 302 路径影响 API 行为。
|
||||||
|
func acceptsHTML(accept string) bool {
|
||||||
|
if accept == "" {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
for _, part := range strings.Split(accept, ",") {
|
||||||
|
mt := strings.TrimSpace(part)
|
||||||
|
if mt == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
// 去掉 q= 等参数
|
||||||
|
if idx := strings.Index(mt, ";"); idx >= 0 {
|
||||||
|
mt = strings.TrimSpace(mt[:idx])
|
||||||
|
}
|
||||||
|
mt = strings.ToLower(mt)
|
||||||
|
if mt == "text/html" || mt == "text/*" {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
@@ -3,6 +3,7 @@ package middleware
|
|||||||
import (
|
import (
|
||||||
"log"
|
"log"
|
||||||
"net/http"
|
"net/http"
|
||||||
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -23,6 +24,9 @@ func Logger(next http.Handler) http.Handler {
|
|||||||
next.ServeHTTP(rec, r)
|
next.ServeHTTP(rec, r)
|
||||||
duration := time.Since(start)
|
duration := time.Since(start)
|
||||||
|
|
||||||
log.Printf("%s %s %s %d %v", r.Method, r.RequestURI, r.RemoteAddr, rec.statusCode, duration)
|
// r.RequestURI 是未经解析的原始请求行,攻击者可在 URL 中注入
|
||||||
|
// \n / \r 伪造日志行。转义为可见字符后再记录。
|
||||||
|
uri := strings.NewReplacer("\n", "\\n", "\r", "\\r").Replace(r.RequestURI)
|
||||||
|
log.Printf("%s %s %s %d %v", r.Method, uri, r.RemoteAddr, rec.statusCode, duration)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|||||||
+73
-1
@@ -4,12 +4,15 @@ import (
|
|||||||
"log"
|
"log"
|
||||||
"net"
|
"net"
|
||||||
"net/http"
|
"net/http"
|
||||||
|
"os"
|
||||||
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
"sync"
|
"sync"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/volcano-tts/tts-api/common"
|
"github.com/volcano-tts/tts-api/common"
|
||||||
"github.com/volcano-tts/tts-api/metrics"
|
"github.com/volcano-tts/tts-api/metrics"
|
||||||
|
"github.com/volcano-tts/tts-api/setting"
|
||||||
)
|
)
|
||||||
|
|
||||||
type RateLimiter struct {
|
type RateLimiter struct {
|
||||||
@@ -23,15 +26,57 @@ type RateLimiter struct {
|
|||||||
var (
|
var (
|
||||||
GlobalRateLimiter *RateLimiter
|
GlobalRateLimiter *RateLimiter
|
||||||
ConcurrencySem chan struct{}
|
ConcurrencySem chan struct{}
|
||||||
|
// trustedProxyHops controls how X-Forwarded-For (XFF) is parsed when the
|
||||||
|
// direct connection comes from a private IP (i.e., we're behind a reverse
|
||||||
|
// proxy). Two modes are supported, switched by this single value:
|
||||||
|
//
|
||||||
|
// HEURISTIC MODE (trustedProxyHops == 0, the default):
|
||||||
|
// Walk XFF from the end, return the first PUBLIC IP. Skips private
|
||||||
|
// and loopback hops automatically. Works for ~90% of deployments
|
||||||
|
// without the operator needing to know the exact number of proxy
|
||||||
|
// hops. Trade-off in multi-hop: rate limiting is per-CDN-edge rather
|
||||||
|
// than per-real-client, which is "good enough" for abuse protection
|
||||||
|
// but not for fine-grained per-user quotas.
|
||||||
|
//
|
||||||
|
// PRECISE MODE (trustedProxyHops > 0):
|
||||||
|
// Count back N hops from the end of XFF and return that value. Gives
|
||||||
|
// precise per-real-client rate limiting even in multi-hop setups
|
||||||
|
// (e.g., Cloudflare + nginx). Operator MUST set this to the number
|
||||||
|
// of trusted reverse proxies between this service and the client.
|
||||||
|
//
|
||||||
|
// Both modes walk from the END of the XFF chain. The first value is
|
||||||
|
// client-controllable; trusting it would let attackers bypass IP rate
|
||||||
|
// limiting by sending a forged X-Forwarded-For header.
|
||||||
|
trustedProxyHops = 0
|
||||||
)
|
)
|
||||||
|
|
||||||
func InitRateLimiter() {
|
func InitRateLimiter() {
|
||||||
|
switch v := os.Getenv("TRUSTED_PROXY_HOPS"); {
|
||||||
|
case v == "":
|
||||||
|
log.Printf("TRUSTED_PROXY_HOPS 未设置,使用默认启发式模式(XFF 链尾第一个公网 IP)")
|
||||||
|
default:
|
||||||
|
n, err := strconv.Atoi(v)
|
||||||
|
switch {
|
||||||
|
case err != nil || n < 0 || n > 10:
|
||||||
|
log.Printf("警告: TRUSTED_PROXY_HOPS=%q 无效(需 0-10 的整数),回退到默认启发式模式", v)
|
||||||
|
case n == 0:
|
||||||
|
// "0" 或 "00" 等被 Atoi 解析为 0 的形式都归到启发式模式,
|
||||||
|
// 避免日志出现"精确模式, 信任 0 跳"这种自相矛盾的输出。
|
||||||
|
log.Printf("已配置 TRUSTED_PROXY_HOPS=%d(启发式模式,等同默认)", n)
|
||||||
|
default:
|
||||||
|
trustedProxyHops = n
|
||||||
|
log.Printf("已配置 TRUSTED_PROXY_HOPS=%d(精确模式,信任 %d 跳反代)", n, n)
|
||||||
|
}
|
||||||
|
}
|
||||||
GlobalRateLimiter = &RateLimiter{
|
GlobalRateLimiter = &RateLimiter{
|
||||||
requests: make(map[string][]time.Time),
|
requests: make(map[string][]time.Time),
|
||||||
limit: common.RateLimitRequests,
|
limit: common.RateLimitRequests,
|
||||||
window: common.RateLimitWindow,
|
window: common.RateLimitWindow,
|
||||||
}
|
}
|
||||||
ConcurrencySem = make(chan struct{}, common.MaxConcurrentRequests)
|
ConcurrencySem = make(chan struct{}, common.MaxConcurrentRequests)
|
||||||
|
|
||||||
|
// 同步到 setting 包,供 LogStartupSummary 展示
|
||||||
|
setting.TrustedProxyHops = trustedProxyHops
|
||||||
}
|
}
|
||||||
|
|
||||||
func (rl *RateLimiter) Allow(key string) bool {
|
func (rl *RateLimiter) Allow(key string) bool {
|
||||||
@@ -133,12 +178,39 @@ func GetClientIP(r *http.Request) string {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if isPrivateIP(directIP) {
|
if isPrivateIP(directIP) {
|
||||||
|
// Parse X-Forwarded-For when there's a reverse proxy in front (direct
|
||||||
|
// connection is from a private IP). Both modes walk from the END of
|
||||||
|
// the chain so that the client-controllable first value cannot be
|
||||||
|
// used to spoof a different client IP for rate limit bypass.
|
||||||
if xff := r.Header.Get("X-Forwarded-For"); xff != "" {
|
if xff := r.Header.Get("X-Forwarded-For"); xff != "" {
|
||||||
ip := strings.TrimSpace(strings.Split(xff, ",")[0])
|
parts := strings.Split(xff, ",")
|
||||||
|
if trustedProxyHops > 0 {
|
||||||
|
// PRECISE MODE: count back N hops from end. Real client IP
|
||||||
|
// sits at index (len(parts) - N). Walk backwards to skip
|
||||||
|
// any malformed values; if chain is shorter than expected,
|
||||||
|
// fall through to the first valid IP in the chain.
|
||||||
|
target := len(parts) - trustedProxyHops
|
||||||
|
if target < 0 {
|
||||||
|
target = 0
|
||||||
|
}
|
||||||
|
for i := target; i >= 0; i-- {
|
||||||
|
ip := strings.TrimSpace(parts[i])
|
||||||
if net.ParseIP(ip) != nil {
|
if net.ParseIP(ip) != nil {
|
||||||
return ip
|
return ip
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
} else {
|
||||||
|
// HEURISTIC MODE (default): walk from end, return first
|
||||||
|
// PUBLIC IP. Skips private/loopback hops that come from
|
||||||
|
// internal proxies between the public-facing proxy and us.
|
||||||
|
for i := len(parts) - 1; i >= 0; i-- {
|
||||||
|
ip := strings.TrimSpace(parts[i])
|
||||||
|
if parsed := net.ParseIP(ip); parsed != nil && !isPrivateIP(ip) {
|
||||||
|
return ip
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
if xri := strings.TrimSpace(r.Header.Get("X-Real-IP")); xri != "" {
|
if xri := strings.TrimSpace(r.Header.Get("X-Real-IP")); xri != "" {
|
||||||
if net.ParseIP(xri) != nil {
|
if net.ParseIP(xri) != nil {
|
||||||
return xri
|
return xri
|
||||||
|
|||||||
@@ -1,10 +1,9 @@
|
|||||||
package middleware
|
package middleware
|
||||||
|
|
||||||
// 本文件提供带 metrics 埋点的限流 / 并发中间件版本;
|
// 本文件提供带 metrics 埋点的限流 / 并发中间件版本。
|
||||||
// 由于原 ratelimit_middleware.go 在本仓库的云盘同步下被永久占用,
|
// 相比 router 实际使用的实现,本版本额外做了:
|
||||||
// 这里用独立实现覆盖路由使用入口,旧实现保留为未引用代码。
|
// - 加 metrics 埋点(限流拒绝 / 并发拒绝计数)
|
||||||
//
|
// - 仅对 /v1/ 下的业务请求生效,监控路径(/health /metrics /dashboard)不消耗配额
|
||||||
// 行为与原 ratelimit_middleware.go 完全一致,只是多了 metrics 调用。
|
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"log"
|
"log"
|
||||||
@@ -14,7 +13,7 @@ import (
|
|||||||
"github.com/volcano-tts/tts-api/metrics"
|
"github.com/volcano-tts/tts-api/metrics"
|
||||||
)
|
)
|
||||||
|
|
||||||
// RateLimitWithMetrics 是 middleware.RateLimit 的可埋点版本。
|
// RateLimitWithMetrics 是限流中间件,带埋点 + 路径过滤。
|
||||||
func RateLimitWithMetrics(next http.Handler) http.Handler {
|
func RateLimitWithMetrics(next http.Handler) http.Handler {
|
||||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
// 仅对 /v1/ 下的业务请求限流,/health /metrics /dashboard 等监控路径不限流
|
// 仅对 /v1/ 下的业务请求限流,/health /metrics /dashboard 等监控路径不限流
|
||||||
@@ -32,7 +31,7 @@ func RateLimitWithMetrics(next http.Handler) http.Handler {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// ConcurrencyLimitWithMetrics 是 middleware.ConcurrencyLimit 的可埋点版本。
|
// ConcurrencyLimitWithMetrics 是并发控制中间件,带埋点 + 路径过滤。
|
||||||
func ConcurrencyLimitWithMetrics(next http.Handler) http.Handler {
|
func ConcurrencyLimitWithMetrics(next http.Handler) http.Handler {
|
||||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
// 仅对 /v1/ 下的业务请求统计并发和加锁,监控路径不占用并发槽位
|
// 仅对 /v1/ 下的业务请求统计并发和加锁,监控路径不占用并发槽位
|
||||||
|
|||||||
@@ -1,32 +0,0 @@
|
|||||||
package middleware
|
|
||||||
|
|
||||||
import (
|
|
||||||
"log"
|
|
||||||
"net/http"
|
|
||||||
)
|
|
||||||
|
|
||||||
func RateLimit(next http.Handler) http.Handler {
|
|
||||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
clientIP := GetClientIP(r)
|
|
||||||
if !GlobalRateLimiter.Allow(clientIP) {
|
|
||||||
log.Printf("警告: 已超过IP速率限制,拒绝请求 - 客户端IP: %s", clientIP)
|
|
||||||
SendJSONError(w, http.StatusTooManyRequests, "Rate limit exceeded. Please try again later.", "rate_limit_error", "rate_limit_exceeded")
|
|
||||||
return
|
|
||||||
}
|
|
||||||
next.ServeHTTP(w, r)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
func ConcurrencyLimit(next http.Handler) http.Handler {
|
|
||||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
select {
|
|
||||||
case ConcurrencySem <- struct{}{}:
|
|
||||||
defer func() { <-ConcurrencySem }()
|
|
||||||
next.ServeHTTP(w, r)
|
|
||||||
default:
|
|
||||||
log.Printf("警告: 已达到最大并发请求数限制,拒绝请求 - 客户端IP: %s", GetClientIP(r))
|
|
||||||
SendJSONError(w, http.StatusServiceUnavailable, "Server is busy, maximum concurrent requests reached. Please try again later.", "concurrency_limit_error", "max_concurrent_requests")
|
|
||||||
return
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
@@ -1,32 +0,0 @@
|
|||||||
package middleware
|
|
||||||
|
|
||||||
import (
|
|
||||||
"log"
|
|
||||||
"net/http"
|
|
||||||
)
|
|
||||||
|
|
||||||
func RateLimit(next http.Handler) http.Handler {
|
|
||||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
clientIP := GetClientIP(r)
|
|
||||||
if !GlobalRateLimiter.Allow(clientIP) {
|
|
||||||
log.Printf("警告: 已超过IP速率限制,拒绝请求 - 客户端IP: %s", clientIP)
|
|
||||||
SendJSONError(w, http.StatusTooManyRequests, "Rate limit exceeded. Please try again later.", "rate_limit_error", "rate_limit_exceeded")
|
|
||||||
return
|
|
||||||
}
|
|
||||||
next.ServeHTTP(w, r)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
func ConcurrencyLimit(next http.Handler) http.Handler {
|
|
||||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
select {
|
|
||||||
case ConcurrencySem <- struct{}{}:
|
|
||||||
defer func() { <-ConcurrencySem }()
|
|
||||||
next.ServeHTTP(w, r)
|
|
||||||
default:
|
|
||||||
log.Printf("警告: 已达到最大并发请求数限制,拒绝请求 - 客户端IP: %s", GetClientIP(r))
|
|
||||||
SendJSONError(w, http.StatusServiceUnavailable, "Server is busy, maximum concurrent requests reached. Please try again later.", "concurrency_limit_error", "max_concurrent_requests")
|
|
||||||
return
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
+1075
File diff suppressed because it is too large
Load Diff
+104
-4
@@ -1,29 +1,107 @@
|
|||||||
package router
|
package router
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
_ "embed"
|
||||||
"net/http"
|
"net/http"
|
||||||
|
"strings"
|
||||||
|
|
||||||
"github.com/gorilla/mux"
|
"github.com/gorilla/mux"
|
||||||
"github.com/volcano-tts/tts-api/controller"
|
"github.com/volcano-tts/tts-api/controller"
|
||||||
|
"github.com/volcano-tts/tts-api/installer"
|
||||||
"github.com/volcano-tts/tts-api/metrics"
|
"github.com/volcano-tts/tts-api/metrics"
|
||||||
"github.com/volcano-tts/tts-api/middleware"
|
"github.com/volcano-tts/tts-api/middleware"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
//go:embed health.html
|
||||||
|
var dashboardHTML []byte
|
||||||
|
|
||||||
|
//go:embed setup.html
|
||||||
|
var setupHTML []byte
|
||||||
|
|
||||||
|
//go:embed admin.html
|
||||||
|
var adminHTML []byte
|
||||||
|
|
||||||
|
// Setup 返回主路由。
|
||||||
|
// 中间件顺序(由外向内):
|
||||||
|
// SecurityHeaders → InstallGuard → RateLimit → ConcurrencyLimit → Logger → handler
|
||||||
|
// 关键: InstallGuard 必须在 RateLimit 之前,避免安装模式被限流计数污染。
|
||||||
|
//
|
||||||
|
// /admin 和 /api/admin/* 都加 RequireAdmin;InstallGuard 不预先放行(让安装模式下
|
||||||
|
// 自动 302 跳 /setup,体验一致)。
|
||||||
func Setup() *mux.Router {
|
func Setup() *mux.Router {
|
||||||
r := mux.NewRouter()
|
r := mux.NewRouter()
|
||||||
|
|
||||||
r.Use(middleware.SecurityHeaders)
|
r.Use(middleware.SecurityHeaders)
|
||||||
|
r.Use(middleware.InstallGuard(installer.GetMode))
|
||||||
r.Use(middleware.RateLimitWithMetrics)
|
r.Use(middleware.RateLimitWithMetrics)
|
||||||
r.Use(middleware.ConcurrencyLimitWithMetrics)
|
r.Use(middleware.ConcurrencyLimitWithMetrics)
|
||||||
r.Use(middleware.Logger)
|
r.Use(middleware.Logger)
|
||||||
|
|
||||||
|
// mux 路由未匹配时 NotFoundHandler 单独处理(不走 r.Use() 中间件链);
|
||||||
|
// 安装模式 + 浏览器访问任意未注册路径 → 302 跳 /setup。
|
||||||
|
r.NotFoundHandler = http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
|
||||||
|
if installer.GetMode() == installer.ModeSetup && acceptsHTML(req.Header.Get("Accept")) {
|
||||||
|
http.Redirect(w, req, "/setup", http.StatusFound)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
http.NotFound(w, req)
|
||||||
|
})
|
||||||
|
|
||||||
|
// 安装相关路由(InstallGuard 已在 setup 模式放行;完成后由 controller 二次校验 404)
|
||||||
|
// /setup 页面本身:装完后必须不可用,否则用户敲 /setup 还会看到安装表单,容易误以为要重装。
|
||||||
|
r.HandleFunc("/setup", func(w http.ResponseWriter, req *http.Request) {
|
||||||
|
if installer.GetMode() == installer.ModeNormal {
|
||||||
|
http.Redirect(w, req, "/admin", http.StatusFound)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
w.Header().Set("Content-Type", "text/html; charset=utf-8")
|
||||||
|
_, _ = w.Write(setupHTML)
|
||||||
|
}).Methods("GET")
|
||||||
|
r.HandleFunc("/api/setup/status", controller.SetupStatusHandler).Methods("GET")
|
||||||
|
r.HandleFunc("/api/setup/prefill", controller.SetupPrefillHandler).Methods("GET")
|
||||||
|
r.HandleFunc("/api/setup", controller.SetupSubmitHandler).Methods("POST")
|
||||||
|
|
||||||
|
// /admin 管理后台(M2);HTML 本身公开,鉴权由前端 JS 拦截
|
||||||
|
// (sessionStorage 没 key 就显示登录页;有 key 调 /api/admin/overview 触发 401 跳登录)
|
||||||
|
// API 端点(/api/admin/* /api/voices*)才需要 RequireAdmin。
|
||||||
|
r.HandleFunc("/admin", func(w http.ResponseWriter, req *http.Request) {
|
||||||
|
w.Header().Set("Content-Type", "text/html; charset=utf-8")
|
||||||
|
_, _ = w.Write(adminHTML)
|
||||||
|
}).Methods("GET")
|
||||||
|
|
||||||
|
// /api/admin/overview (鉴权)
|
||||||
|
r.Handle("/api/admin/overview", middleware.RequireAdmin(http.HandlerFunc(controller.AdminOverviewHandler))).Methods("GET")
|
||||||
|
// /api/admin/metrics (鉴权);返 Prometheus 文本
|
||||||
|
r.Handle("/api/admin/metrics", middleware.RequireAdmin(http.HandlerFunc(controller.AdminMetricsHandler))).Methods("GET")
|
||||||
|
|
||||||
|
// /api/voices 音色 CRUD (鉴权)
|
||||||
|
r.Handle("/api/voices", middleware.RequireAdmin(http.HandlerFunc(controller.AdminVoicesListHandler))).Methods("GET")
|
||||||
|
r.Handle("/api/voices", middleware.RequireAdmin(http.HandlerFunc(controller.AdminVoiceCreateHandler))).Methods("POST")
|
||||||
|
r.Handle("/api/voices/{name}", middleware.RequireAdmin(http.HandlerFunc(controller.AdminVoiceDeleteHandler))).Methods("DELETE")
|
||||||
|
r.Handle("/api/voices/{name}/toggle", middleware.RequireAdmin(http.HandlerFunc(controller.AdminVoiceToggleHandler))).Methods("PATCH")
|
||||||
|
|
||||||
|
// /api/settings 全局设置 (鉴权) — M3
|
||||||
|
r.Handle("/api/settings", middleware.RequireAdmin(http.HandlerFunc(controller.SettingsGetHandler))).Methods("GET")
|
||||||
|
r.Handle("/api/settings", middleware.RequireAdmin(http.HandlerFunc(controller.SettingsUpdateHandler))).Methods("PUT")
|
||||||
|
r.Handle("/api/settings/api-key", middleware.RequireAdmin(http.HandlerFunc(controller.SettingsAPIKeyHandler))).Methods("PUT")
|
||||||
|
r.Handle("/api/settings/auth-key", middleware.RequireAdmin(http.HandlerFunc(controller.SettingsAuthKeyHandler))).Methods("PUT")
|
||||||
|
r.Handle("/api/settings/cors", middleware.RequireAdmin(http.HandlerFunc(controller.SettingsCORSHandler))).Methods("PUT")
|
||||||
|
|
||||||
|
// 业务路由
|
||||||
r.HandleFunc("/v1/audio/speech", controller.OpenaiTTSHandler).Methods("POST", "OPTIONS")
|
r.HandleFunc("/v1/audio/speech", controller.OpenaiTTSHandler).Methods("POST", "OPTIONS")
|
||||||
r.HandleFunc("/health", controller.HealthHandler).Methods("GET")
|
r.HandleFunc("/health", controller.HealthHandler).Methods("GET")
|
||||||
r.HandleFunc("/dashboard", func(w http.ResponseWriter, r *http.Request) {
|
r.HandleFunc("/dashboard", func(w http.ResponseWriter, req *http.Request) {
|
||||||
http.ServeFile(w, r, "health.html")
|
w.Header().Set("Content-Type", "text/html; charset=utf-8")
|
||||||
|
_, _ = w.Write(dashboardHTML)
|
||||||
}).Methods("GET")
|
}).Methods("GET")
|
||||||
r.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
|
r.HandleFunc("/", func(w http.ResponseWriter, req *http.Request) {
|
||||||
http.Redirect(w, r, "/dashboard", http.StatusFound)
|
// 安装模式下,根路径跳 /setup
|
||||||
|
if installer.GetMode() == installer.ModeSetup {
|
||||||
|
http.Redirect(w, req, "/setup", http.StatusFound)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
// 正常模式:跳 /admin(M2 之后优先于 /dashboard)
|
||||||
|
http.Redirect(w, req, "/admin", http.StatusFound)
|
||||||
}).Methods("GET")
|
}).Methods("GET")
|
||||||
|
|
||||||
// /metrics 不做鉴权(对齐 /health 策略),但仍然走 RateLimit / ConcurrencyLimit。
|
// /metrics 不做鉴权(对齐 /health 策略),但仍然走 RateLimit / ConcurrencyLimit。
|
||||||
@@ -32,3 +110,25 @@ func Setup() *mux.Router {
|
|||||||
|
|
||||||
return r
|
return r
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// acceptsHTML 在 router 包内复刻,middleware 包的版本未导出。
|
||||||
|
// 用途:NotFoundHandler 判断浏览器 Accept。
|
||||||
|
func acceptsHTML(accept string) bool {
|
||||||
|
if accept == "" {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
for _, part := range strings.Split(accept, ",") {
|
||||||
|
mt := strings.TrimSpace(part)
|
||||||
|
if mt == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if idx := strings.Index(mt, ";"); idx >= 0 {
|
||||||
|
mt = strings.TrimSpace(mt[:idx])
|
||||||
|
}
|
||||||
|
mt = strings.ToLower(mt)
|
||||||
|
if mt == "text/html" || mt == "text/*" {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|||||||
@@ -0,0 +1,428 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="zh-CN">
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
<title>火山 TTS · 安装引导</title>
|
||||||
|
<script src="https://cdn.bootcdn.net/ajax/libs/vue/3.4.21/vue.global.prod.js"></script>
|
||||||
|
<script src="https://cdn.bootcdn.net/ajax/libs/axios/1.6.7/axios.min.js"></script>
|
||||||
|
<style>
|
||||||
|
:root {
|
||||||
|
--bg: #0a0e1a;
|
||||||
|
--bg-card: #131826;
|
||||||
|
--bg-elev: #1a2138;
|
||||||
|
--bg-hover: #1f2740;
|
||||||
|
--border: #232b42;
|
||||||
|
--border-strong: #2e3754;
|
||||||
|
--text: #e4e7ee;
|
||||||
|
--text-dim: #94a3b8;
|
||||||
|
--text-mute: #64748b;
|
||||||
|
--accent: #00d4ff;
|
||||||
|
--accent-hover: #33ddff;
|
||||||
|
--accent-2: #7b2ff7;
|
||||||
|
--accent-soft: rgba(0, 212, 255, 0.10);
|
||||||
|
--accent-glow: rgba(0, 212, 255, 0.35);
|
||||||
|
--success: #22c55e;
|
||||||
|
--success-soft: rgba(34, 197, 94, 0.12);
|
||||||
|
--warning: #f59e0b;
|
||||||
|
--warning-soft: rgba(245, 158, 11, 0.12);
|
||||||
|
--danger: #ef4444;
|
||||||
|
--danger-soft: rgba(239, 68, 68, 0.12);
|
||||||
|
--radius: 8px;
|
||||||
|
--radius-lg: 12px;
|
||||||
|
--radius-xl: 16px;
|
||||||
|
--shadow: 0 4px 16px rgba(0,0,0,0.25);
|
||||||
|
--shadow-lg: 0 20px 50px rgba(0,0,0,0.5);
|
||||||
|
}
|
||||||
|
* { margin: 0; padding: 0; box-sizing: border-box; }
|
||||||
|
body {
|
||||||
|
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "PingFang SC", "Microsoft YaHei", sans-serif;
|
||||||
|
background: var(--bg); color: var(--text);
|
||||||
|
min-height: 100vh; padding: 40px 24px; font-size: 14px; line-height: 1.5;
|
||||||
|
-webkit-font-smoothing: antialiased;
|
||||||
|
background-image:
|
||||||
|
radial-gradient(ellipse 70% 50% at 30% 0%, rgba(0,212,255,0.07), transparent),
|
||||||
|
radial-gradient(ellipse 50% 40% at 100% 100%, rgba(123,47,247,0.05), transparent);
|
||||||
|
background-attachment: fixed;
|
||||||
|
}
|
||||||
|
#app { max-width: 760px; margin: 0 auto; }
|
||||||
|
|
||||||
|
/* === Header === */
|
||||||
|
.header { display: flex; align-items: center; gap: 16px; margin-bottom: 28px; }
|
||||||
|
.logo {
|
||||||
|
width: 52px; height: 52px; border-radius: 14px;
|
||||||
|
background: linear-gradient(135deg, var(--accent), var(--accent-2));
|
||||||
|
display: flex; align-items: center; justify-content: center;
|
||||||
|
font-weight: 700; font-size: 20px; color: #fff;
|
||||||
|
box-shadow: 0 6px 24px var(--accent-glow);
|
||||||
|
}
|
||||||
|
.header-text h1 { font-size: 22px; font-weight: 600; letter-spacing: -0.01em; }
|
||||||
|
.header-text .sub { font-size: 13px; color: var(--text-dim); margin-top: 4px; }
|
||||||
|
|
||||||
|
/* === Steps === */
|
||||||
|
.steps { display: flex; align-items: center; gap: 0; margin-bottom: 28px; padding: 16px 20px; background: var(--bg-card); border: 1px solid var(--border); border-radius: var(--radius-lg); }
|
||||||
|
.step { display: flex; align-items: center; gap: 10px; flex: 1; min-width: 0; }
|
||||||
|
.step-num {
|
||||||
|
width: 28px; height: 28px; border-radius: 50%;
|
||||||
|
display: flex; align-items: center; justify-content: center;
|
||||||
|
font-size: 12px; font-weight: 600; flex-shrink: 0;
|
||||||
|
background: var(--bg-elev); color: var(--text-mute);
|
||||||
|
border: 1px solid var(--border);
|
||||||
|
}
|
||||||
|
.step.active .step-num { background: var(--accent); color: #00121a; border-color: var(--accent); box-shadow: 0 0 0 4px var(--accent-soft); }
|
||||||
|
.step.done .step-num { background: var(--success-soft); color: var(--success); border-color: rgba(34,197,94,0.3); }
|
||||||
|
.step-label { font-size: 13px; color: var(--text-dim); white-space: nowrap; overflow: hidden; text-overflow: ellipsis; }
|
||||||
|
.step.active .step-label, .step.done .step-label { color: var(--text); }
|
||||||
|
.step-line { flex: 1; height: 1px; background: var(--border); margin: 0 12px; min-width: 16px; }
|
||||||
|
.step.done + .step-line { background: var(--accent); opacity: 0.4; }
|
||||||
|
|
||||||
|
/* === Card === */
|
||||||
|
.card { background: var(--bg-card); border: 1px solid var(--border); border-radius: var(--radius-lg); padding: 24px; margin-bottom: 16px; }
|
||||||
|
.card-head { display: flex; justify-content: space-between; align-items: flex-start; margin-bottom: 18px; gap: 12px; }
|
||||||
|
.card-title { font-size: 16px; font-weight: 600; }
|
||||||
|
.card-sub { font-size: 12px; color: var(--text-dim); margin-top: 4px; line-height: 1.6; }
|
||||||
|
.step-badge { font-size: 11px; padding: 3px 8px; border-radius: 999px; background: var(--accent-soft); color: var(--accent); border: 1px solid rgba(0,212,255,0.3); font-weight: 500; }
|
||||||
|
|
||||||
|
/* === Form === */
|
||||||
|
.field { margin-bottom: 16px; }
|
||||||
|
.field label { display: block; font-size: 12px; color: var(--text-dim); margin-bottom: 6px; font-weight: 500; }
|
||||||
|
.field label .req { color: var(--danger); margin-left: 2px; }
|
||||||
|
.field input, .field select {
|
||||||
|
width: 100%; background: var(--bg-elev); border: 1px solid var(--border);
|
||||||
|
color: var(--text); padding: 10px 12px; border-radius: var(--radius); font-size: 13px;
|
||||||
|
font-family: inherit; transition: border-color 0.15s, box-shadow 0.15s;
|
||||||
|
}
|
||||||
|
.field input:focus, .field select:focus { outline: none; border-color: var(--accent); box-shadow: 0 0 0 3px var(--accent-soft); }
|
||||||
|
.field input::placeholder { color: var(--text-mute); }
|
||||||
|
.field select {
|
||||||
|
appearance: none;
|
||||||
|
background-image: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' width='12' height='12' viewBox='0 0 12 12'><path fill='%238a92a6' d='M6 8L1 3h10z'/></svg>");
|
||||||
|
background-repeat: no-repeat; background-position: right 10px center; padding-right: 30px;
|
||||||
|
}
|
||||||
|
.field .hint { font-size: 11px; color: var(--text-mute); margin-top: 5px; line-height: 1.5; }
|
||||||
|
.field-row { display: grid; grid-template-columns: 1fr 1fr; gap: 14px; }
|
||||||
|
.field-row .field { margin-bottom: 0; }
|
||||||
|
code { font-family: ui-monospace, SFMono-Regular, monospace; font-size: 0.9em; background: var(--bg-elev); padding: 1px 5px; border-radius: 4px; color: var(--accent); }
|
||||||
|
|
||||||
|
/* === Voice list === */
|
||||||
|
.voice-row {
|
||||||
|
display: grid; grid-template-columns: 1fr 1fr 1.4fr 1.2fr 36px;
|
||||||
|
gap: 10px; align-items: center; margin-bottom: 8px;
|
||||||
|
}
|
||||||
|
.voice-row input { font-size: 12px; padding: 8px 10px; font-family: ui-monospace, SFMono-Regular, monospace; }
|
||||||
|
.voice-row .rm {
|
||||||
|
background: transparent; border: 1px solid var(--border);
|
||||||
|
color: var(--text-mute); cursor: pointer; padding: 7px 0;
|
||||||
|
border-radius: var(--radius); font-size: 15px;
|
||||||
|
transition: all 0.12s;
|
||||||
|
}
|
||||||
|
.voice-row .rm:hover:not(:disabled) { border-color: var(--danger); color: var(--danger); background: var(--danger-soft); }
|
||||||
|
.voice-row .rm:disabled { opacity: 0.3; cursor: not-allowed; }
|
||||||
|
.voice-row-head {
|
||||||
|
display: grid; grid-template-columns: 1fr 1fr 1.4fr 1.2fr 36px;
|
||||||
|
gap: 10px; font-size: 11px; color: var(--text-mute);
|
||||||
|
text-transform: uppercase; letter-spacing: 0.5px; font-weight: 600;
|
||||||
|
padding: 0 2px 6px;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* === Buttons === */
|
||||||
|
.btn {
|
||||||
|
display: inline-flex; align-items: center; justify-content: center; gap: 6px;
|
||||||
|
background: var(--bg-elev); border: 1px solid var(--border); color: var(--text);
|
||||||
|
padding: 10px 18px; border-radius: var(--radius); cursor: pointer; font-size: 13px; font-weight: 500;
|
||||||
|
font-family: inherit; transition: all 0.12s;
|
||||||
|
}
|
||||||
|
.btn:hover:not(:disabled) { border-color: var(--border-strong); background: var(--bg-hover); }
|
||||||
|
.btn:disabled { opacity: 0.5; cursor: not-allowed; }
|
||||||
|
.btn-primary { background: var(--accent); color: #00121a; border-color: var(--accent); }
|
||||||
|
.btn-primary:hover:not(:disabled) { background: var(--accent-hover); border-color: var(--accent-hover); }
|
||||||
|
.btn-add { background: transparent; border: 1px dashed var(--border); color: var(--text-dim); width: 100%; justify-content: center; padding: 10px; }
|
||||||
|
.btn-add:hover:not(:disabled) { border-color: var(--accent); color: var(--accent); border-style: solid; }
|
||||||
|
|
||||||
|
/* === Actions === */
|
||||||
|
.actions { display: flex; justify-content: space-between; align-items: center; margin-top: 24px; padding: 20px 24px; background: var(--bg-card); border: 1px solid var(--border); border-radius: var(--radius-lg); }
|
||||||
|
.actions .hint-text { color: var(--text-mute); font-size: 12px; }
|
||||||
|
|
||||||
|
/* === Alerts === */
|
||||||
|
.alert { display: flex; align-items: flex-start; gap: 10px; padding: 10px 14px; border-radius: var(--radius); margin-bottom: 16px; font-size: 13px; }
|
||||||
|
.alert-icon { font-size: 15px; flex-shrink: 0; }
|
||||||
|
.alert-body { flex: 1; }
|
||||||
|
.alert-danger { background: var(--danger-soft); border: 1px solid rgba(239,68,68,0.3); color: var(--danger); }
|
||||||
|
.alert-warning { background: var(--warning-soft); border: 1px solid rgba(245,158,11,0.3); color: var(--warning); }
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="app">
|
||||||
|
|
||||||
|
<div class="header">
|
||||||
|
<div class="logo">TTS</div>
|
||||||
|
<div class="header-text">
|
||||||
|
<h1>火山 TTS 聚合平台 · 首次安装</h1>
|
||||||
|
<div class="sub">填写以下信息完成初始化。token 来自启动日志或环境变量 <code>TTS_ADMIN_KEY</code>。</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Steps -->
|
||||||
|
<div class="steps">
|
||||||
|
<div class="step" :class="{active: step===1, done: step>1}">
|
||||||
|
<div class="step-num">1</div>
|
||||||
|
<div class="step-label">上游凭证</div>
|
||||||
|
</div>
|
||||||
|
<div class="step-line"></div>
|
||||||
|
<div class="step" :class="{active: step===2, done: step>2}">
|
||||||
|
<div class="step-num">2</div>
|
||||||
|
<div class="step-label">默认路由</div>
|
||||||
|
</div>
|
||||||
|
<div class="step-line"></div>
|
||||||
|
<div class="step" :class="{active: step===3, done: step>3}">
|
||||||
|
<div class="step-num">3</div>
|
||||||
|
<div class="step-label">音色列表</div>
|
||||||
|
</div>
|
||||||
|
<div class="step-line"></div>
|
||||||
|
<div class="step" :class="{active: step===4}">
|
||||||
|
<div class="step-num">4</div>
|
||||||
|
<div class="step-label">完成安装</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div v-if="errorMsg" class="alert alert-danger">
|
||||||
|
<span class="alert-icon">⚠</span>
|
||||||
|
<div class="alert-body">{{ errorMsg }}</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Step 1: 上游凭证 -->
|
||||||
|
<div v-show="step===1" class="card">
|
||||||
|
<div class="card-head">
|
||||||
|
<div>
|
||||||
|
<div class="card-title">OpenAI 鉴权 + 火山引擎凭证</div>
|
||||||
|
<div class="card-sub">两个 Key 仅在此页面输入,不会回显,装完不用再碰 env。</div>
|
||||||
|
</div>
|
||||||
|
<span class="step-badge">第 1 步</span>
|
||||||
|
</div>
|
||||||
|
<div class="field">
|
||||||
|
<label>OpenAI 鉴权 Key <span class="req">*</span></label>
|
||||||
|
<input type="password" v-model="form.auth_key" placeholder="自定,例如 my-secret-key-2024" autocomplete="off">
|
||||||
|
<div class="hint">客户端用这个 Key 调 <code>/v1/audio/speech</code>,也是登录 <code>/admin</code> 的密码。装完可在 <code>/admin → 设置</code> 改。</div>
|
||||||
|
</div>
|
||||||
|
<div class="field">
|
||||||
|
<label>火山 TTS API Key <span class="req">*</span></label>
|
||||||
|
<input type="password" v-model="form.api_key" placeholder="例如: 5b4d7c2a-..." autocomplete="off">
|
||||||
|
<div class="hint">调火山 v3 上游用的凭证,从 <a href="https://console.volcengine.com/" target="_blank" style="color: var(--accent);">火山控制台</a> 获取。</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Step 2: 默认路由 -->
|
||||||
|
<div v-show="step===2" class="card">
|
||||||
|
<div class="card-head">
|
||||||
|
<div>
|
||||||
|
<div class="card-title">默认路由与格式</div>
|
||||||
|
<div class="card-sub">未传 voice/format 时使用。装完可在 <code>/admin → 设置</code> 改。</div>
|
||||||
|
</div>
|
||||||
|
<span class="step-badge">第 2 步</span>
|
||||||
|
</div>
|
||||||
|
<div class="field-row">
|
||||||
|
<div class="field">
|
||||||
|
<label>默认资源 ID <span class="req">*</span></label>
|
||||||
|
<input v-model="form.default_resource_id" placeholder="seed-icl-2.0">
|
||||||
|
<div class="hint">音色所属的计费资源 ID;本项目为豆包声音复刻大模型 2.0,固定使用 <code>seed-icl-2.0</code>。</div>
|
||||||
|
</div>
|
||||||
|
<div class="field">
|
||||||
|
<label>默认音色 <span class="req">*</span></label>
|
||||||
|
<input v-model="form.default_speaker" placeholder="zh_female_qingxin">
|
||||||
|
<div class="hint">未传 voice 字段时使用。</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="field-row">
|
||||||
|
<div class="field">
|
||||||
|
<label>默认输出格式</label>
|
||||||
|
<select v-model="form.default_format">
|
||||||
|
<option value="mp3">mp3</option>
|
||||||
|
<option value="wav">wav</option>
|
||||||
|
<option value="opus">opus (ogg_opus)</option>
|
||||||
|
<option value="pcm">pcm</option>
|
||||||
|
<option value="aac">aac</option>
|
||||||
|
<option value="flac">flac</option>
|
||||||
|
</select>
|
||||||
|
</div>
|
||||||
|
<div class="field">
|
||||||
|
<label>采样率 (Hz)</label>
|
||||||
|
<input type="number" v-model.number="form.sample_rate" placeholder="24000">
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="field">
|
||||||
|
<label>初始化 Token <span class="req">*</span></label>
|
||||||
|
<input type="password" v-model="form.token" placeholder="启动日志里打印的一次性 token,或 TTS_ADMIN_KEY" autocomplete="off">
|
||||||
|
<div class="hint">公网部署建议设置 TTS_ADMIN_KEY;否则每次启动会重新生成。</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Step 3: 音色列表 -->
|
||||||
|
<div v-show="step===3" class="card">
|
||||||
|
<div class="card-head">
|
||||||
|
<div>
|
||||||
|
<div class="card-title">音色列表 <span style="font-weight: 400; color: var(--text-dim); font-size: 12px;">(至少 1 条)</span></div>
|
||||||
|
<div class="card-sub">填入火山 TTS 音色 ID(S_ 开头的为复刻音色)。可后续在 /admin 中增删。</div>
|
||||||
|
</div>
|
||||||
|
<span class="step-badge">第 3 步</span>
|
||||||
|
</div>
|
||||||
|
<div class="voice-row-head">
|
||||||
|
<div>对外名 (voice)</div>
|
||||||
|
<div>Speaker</div>
|
||||||
|
<div>资源 ID</div>
|
||||||
|
<div>Model</div>
|
||||||
|
<div></div>
|
||||||
|
</div>
|
||||||
|
<div v-for="(v, i) in form.voices" :key="i" class="voice-row">
|
||||||
|
<input v-model="v.name" placeholder="qian">
|
||||||
|
<input v-model="v.speaker" placeholder="S_xxx">
|
||||||
|
<input v-model="v.resource_id" placeholder="seed-icl-2.0">
|
||||||
|
<input v-model="v.model" placeholder="seed-tts-2.0-standard">
|
||||||
|
<button class="rm" @click="removeVoice(i)" :disabled="form.voices.length <= 1" title="删除">×</button>
|
||||||
|
</div>
|
||||||
|
<button class="btn btn-add" @click="addVoice">+ 添加音色</button>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Step 4: 确认 -->
|
||||||
|
<div v-show="step===4" class="card">
|
||||||
|
<div class="card-head">
|
||||||
|
<div>
|
||||||
|
<div class="card-title">确认安装</div>
|
||||||
|
<div class="card-sub">检查以下配置,点击「完成安装」提交。提交后立即进入正常模式。</div>
|
||||||
|
</div>
|
||||||
|
<span class="step-badge">第 4 步</span>
|
||||||
|
</div>
|
||||||
|
<div style="display: grid; grid-template-columns: 1fr 1fr; gap: 14px;">
|
||||||
|
<div>
|
||||||
|
<div style="font-size: 11px; color: var(--text-mute); text-transform: uppercase; letter-spacing: 0.5px; margin-bottom: 4px;">OpenAI Key</div>
|
||||||
|
<div style="font-family: ui-monospace, monospace; color: var(--accent); font-size: 13px;">{{ form.auth_key ? mask(form.auth_key) : '(未填)' }}</div>
|
||||||
|
</div>
|
||||||
|
<div>
|
||||||
|
<div style="font-size: 11px; color: var(--text-mute); text-transform: uppercase; letter-spacing: 0.5px; margin-bottom: 4px;">火山 API Key</div>
|
||||||
|
<div style="font-family: ui-monospace, monospace; color: var(--accent); font-size: 13px;">{{ form.api_key ? mask(form.api_key) : '(未填)' }}</div>
|
||||||
|
</div>
|
||||||
|
<div>
|
||||||
|
<div style="font-size: 11px; color: var(--text-mute); text-transform: uppercase; letter-spacing: 0.5px; margin-bottom: 4px;">默认资源 ID</div>
|
||||||
|
<div style="font-family: ui-monospace, monospace; font-size: 13px;">{{ form.default_resource_id || '—' }}</div>
|
||||||
|
</div>
|
||||||
|
<div>
|
||||||
|
<div style="font-size: 11px; color: var(--text-mute); text-transform: uppercase; letter-spacing: 0.5px; margin-bottom: 4px;">默认音色</div>
|
||||||
|
<div style="font-family: ui-monospace, monospace; font-size: 13px;">{{ form.default_speaker || '—' }}</div>
|
||||||
|
</div>
|
||||||
|
<div>
|
||||||
|
<div style="font-size: 11px; color: var(--text-mute); text-transform: uppercase; letter-spacing: 0.5px; margin-bottom: 4px;">输出格式 / 采样率</div>
|
||||||
|
<div style="font-size: 13px;">{{ form.default_format }} · {{ form.sample_rate }} Hz</div>
|
||||||
|
</div>
|
||||||
|
<div>
|
||||||
|
<div style="font-size: 11px; color: var(--text-mute); text-transform: uppercase; letter-spacing: 0.5px; margin-bottom: 4px;">音色数</div>
|
||||||
|
<div style="font-size: 13px;">{{ form.voices.length }} 条 <span class="text-dim" style="font-size: 12px;">({{ form.voices.filter(v => v.name).length }} 已填名)</span></div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Nav -->
|
||||||
|
<div class="actions">
|
||||||
|
<button class="btn" @click="prev" :disabled="step===1 || submitting">← 上一步</button>
|
||||||
|
<div class="hint-text">提交后立即进入正常模式;后续管理请访问 <code>/admin</code>。</div>
|
||||||
|
<div style="display: flex; gap: 8px;">
|
||||||
|
<button v-if="step < 4" class="btn btn-primary" @click="next">下一步 →</button>
|
||||||
|
<button v-else class="btn btn-primary" @click="submit" :disabled="submitting">
|
||||||
|
{{ submitting ? '安装中...' : '完成安装' }}
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<script>
|
||||||
|
const { createApp, ref, onMounted } = Vue;
|
||||||
|
createApp({
|
||||||
|
setup() {
|
||||||
|
const step = ref(1);
|
||||||
|
const form = ref({
|
||||||
|
auth_key: '',
|
||||||
|
api_key: '',
|
||||||
|
default_resource_id: 'seed-icl-2.0',
|
||||||
|
default_speaker: '',
|
||||||
|
default_format: 'mp3',
|
||||||
|
sample_rate: 24000,
|
||||||
|
token: '',
|
||||||
|
voices: [{ name: '', speaker: '', resource_id: 'seed-icl-2.0', model: 'seed-tts-2.0-standard' }],
|
||||||
|
});
|
||||||
|
const errorMsg = ref('');
|
||||||
|
const submitting = ref(false);
|
||||||
|
|
||||||
|
const addVoice = () => {
|
||||||
|
form.value.voices.push({ name: '', speaker: '', resource_id: 'seed-icl-2.0', model: 'seed-tts-2.0-standard' });
|
||||||
|
};
|
||||||
|
const removeVoice = (i) => {
|
||||||
|
if (form.value.voices.length > 1) form.value.voices.splice(i, 1);
|
||||||
|
};
|
||||||
|
const next = () => {
|
||||||
|
errorMsg.value = '';
|
||||||
|
if (step.value === 1) {
|
||||||
|
if (!form.value.auth_key || !form.value.api_key) {
|
||||||
|
errorMsg.value = '请填写 OpenAI 鉴权 Key 和火山 API Key';
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
} else if (step.value === 2) {
|
||||||
|
if (!form.value.default_resource_id || !form.value.default_speaker || !form.value.token) {
|
||||||
|
errorMsg.value = '请填写默认资源 ID、默认音色和初始化 Token';
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
} else if (step.value === 3) {
|
||||||
|
if (!form.value.voices.length || form.value.voices.some(v => !v.name || !v.speaker || !v.resource_id)) {
|
||||||
|
errorMsg.value = '音色列表不完整(每条都需要 name + speaker + resource_id)';
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
step.value = Math.min(4, step.value + 1);
|
||||||
|
};
|
||||||
|
const prev = () => { errorMsg.value = ''; step.value = Math.max(1, step.value - 1); };
|
||||||
|
const mask = (s) => {
|
||||||
|
if (!s) return '';
|
||||||
|
if (s.length <= 8) return '****';
|
||||||
|
return s.slice(0, 4) + '****' + s.slice(-4);
|
||||||
|
};
|
||||||
|
|
||||||
|
onMounted(async () => {
|
||||||
|
try {
|
||||||
|
const r = await axios.get('/api/setup/prefill');
|
||||||
|
const s = r.data.settings || {};
|
||||||
|
if (s.default_resource_id) form.value.default_resource_id = s.default_resource_id;
|
||||||
|
if (s.default_speaker) form.value.default_speaker = s.default_speaker;
|
||||||
|
if (s.default_format) form.value.default_format = s.default_format;
|
||||||
|
if (s.sample_rate) form.value.sample_rate = parseInt(s.sample_rate, 10) || 24000;
|
||||||
|
} catch (e) {
|
||||||
|
console.log('prefill skipped:', e.message);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
const submit = async () => {
|
||||||
|
errorMsg.value = '';
|
||||||
|
submitting.value = true;
|
||||||
|
try {
|
||||||
|
const r = await axios.post('/api/setup', {
|
||||||
|
token: form.value.token,
|
||||||
|
settings: {
|
||||||
|
auth_key: form.value.auth_key,
|
||||||
|
api_key: form.value.api_key,
|
||||||
|
default_resource_id: form.value.default_resource_id,
|
||||||
|
default_speaker: form.value.default_speaker,
|
||||||
|
default_format: form.value.default_format,
|
||||||
|
sample_rate: String(form.value.sample_rate || 24000),
|
||||||
|
},
|
||||||
|
voices: form.value.voices,
|
||||||
|
});
|
||||||
|
window.location.href = r.data.redirect || '/admin';
|
||||||
|
} catch (e) {
|
||||||
|
const msg = e.response?.data?.error?.message || e.message;
|
||||||
|
errorMsg.value = '安装失败: ' + msg;
|
||||||
|
submitting.value = false;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
return { step, form, errorMsg, submitting, addVoice, removeVoice, next, prev, mask, submit };
|
||||||
|
},
|
||||||
|
}).mount('#app');
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
+222
-48
@@ -1,6 +1,8 @@
|
|||||||
package setting
|
package setting
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"crypto/rand"
|
||||||
|
"encoding/hex"
|
||||||
"fmt"
|
"fmt"
|
||||||
"log"
|
"log"
|
||||||
"os"
|
"os"
|
||||||
@@ -10,12 +12,12 @@ import (
|
|||||||
|
|
||||||
"github.com/volcano-tts/tts-api/adapter/volcano"
|
"github.com/volcano-tts/tts-api/adapter/volcano"
|
||||||
"github.com/volcano-tts/tts-api/common"
|
"github.com/volcano-tts/tts-api/common"
|
||||||
"github.com/volcano-tts/tts-api/dto"
|
"github.com/volcano-tts/tts-api/telemetry"
|
||||||
)
|
)
|
||||||
|
|
||||||
// 全部环境变量读取的单一入口:其它包不允许直接 os.Getenv,只读这里的全局 Config。
|
// 全部环境变量读取的单一入口:其它包不允许直接 os.Getenv,只读这里的全局 Config。
|
||||||
|
|
||||||
// TTSOptions 是火山 v3 TTS 调用的完整参数集合,启动期由 InitTTSConfig 填充。
|
// TTSOptions 是火山 v3 TTS 调用的完整参数集合,启动期由 LoadRuntimeConfig 从 store 填充。
|
||||||
// 业务侧(controller)直接读取并传入 volcano.Synthesis。
|
// 业务侧(controller)直接读取并传入 volcano.Synthesis。
|
||||||
var (
|
var (
|
||||||
TTSOptions volcano.Options
|
TTSOptions volcano.Options
|
||||||
@@ -46,12 +48,33 @@ type ServerConfig struct {
|
|||||||
|
|
||||||
var Server ServerConfig
|
var Server ServerConfig
|
||||||
|
|
||||||
|
// TrustedProxyHops 由 middleware.InitRateLimiter 在启动期写入,
|
||||||
|
// 表示当前 XFF 解析模式:0=启发式,N>0=精确 N 跳。
|
||||||
|
// setting.LogStartupSummary 读这个字段以展示运行期配置,
|
||||||
|
// 不直接调用 middleware(避免循环 import)。
|
||||||
|
var TrustedProxyHops int
|
||||||
|
|
||||||
|
// SetupToken 是安装模式下的初始化凭证。
|
||||||
|
// - 若 TTS_ADMIN_KEY 环境变量非空,用其值(用户可复现,便于脚本化安装)
|
||||||
|
// - 若 TTS_ADMIN_KEY 为空,启动时随机生成 32 字节十六进制,
|
||||||
|
// 打印到日志(/api/setup 提交时必须带这个 token)
|
||||||
|
//
|
||||||
|
// 安装完成后,/api/setup 端点永久关闭,SetupToken 失去意义但保留在内存。
|
||||||
|
var SetupToken string
|
||||||
|
|
||||||
|
// SetupTokenSource 标记 SetupToken 的来源,便于日志区分。
|
||||||
|
// "env" = 来自 TTS_ADMIN_KEY
|
||||||
|
// "ephemeral"= 启动时随机生成(每次启动变)
|
||||||
|
// "" = 未设置
|
||||||
|
var SetupTokenSource string
|
||||||
|
|
||||||
// InitAllConfigs 集中初始化所有配置,启动期调用一次。
|
// InitAllConfigs 集中初始化所有配置,启动期调用一次。
|
||||||
func InitAllConfigs() {
|
func InitAllConfigs() {
|
||||||
InitServerConfig()
|
InitServerConfig()
|
||||||
InitAuthConfig()
|
InitAuthConfig()
|
||||||
InitCORSConfig()
|
InitCORSConfig()
|
||||||
TTSConfigErr = InitTTSConfig()
|
InitSetupToken()
|
||||||
|
// InitTTSConfig 不再这里调 — 改为启动期从 store 加载(LoadRuntimeConfig)。
|
||||||
}
|
}
|
||||||
|
|
||||||
func InitServerConfig() {
|
func InitServerConfig() {
|
||||||
@@ -104,33 +127,114 @@ func normalizeOrigin(origin string) string {
|
|||||||
return strings.ToLower(origin)
|
return strings.ToLower(origin)
|
||||||
}
|
}
|
||||||
|
|
||||||
// InitTTSConfig 读取火山 TTS 必填和可选配置,填充 TTSOptions 与 TTSTimeout。
|
// SplitOriginsForCORS 解析逗号/换行/空格分隔的 origins 列表,
|
||||||
// 必填项缺失时返回 error,/v1/audio/speech 路由会拒绝请求。
|
// 全部小写、trim 末尾 / 后面统一比较。导出供 controller 复用
|
||||||
func InitTTSConfig() error {
|
// (PUT /api/settings/cors 写完立即刷新 setting.CORS 用)。
|
||||||
apiKey := os.Getenv("BYTEDANCE_TTS_API_KEY")
|
func SplitOriginsForCORS(s string) []string {
|
||||||
resourceId := os.Getenv("BYTEDANCE_TTS_RESOURCE_ID")
|
return splitAndLowerOrigins(s)
|
||||||
speaker := os.Getenv("BYTEDANCE_TTS_SPEAKER")
|
}
|
||||||
missing := []string{}
|
|
||||||
if apiKey == "" {
|
// splitAndLowerOrigins 解析逗号/换行/空格分隔的 origins 列表,
|
||||||
missing = append(missing, "BYTEDANCE_TTS_API_KEY")
|
// 全部小写、trim 末尾 / 后面统一比较(只在本包内用,外部用 SplitOriginsForCORS)。
|
||||||
|
// 实现细节:用 strings.FieldsFunc 切分,首尾 trim,末尾去 /。
|
||||||
|
func splitAndLowerOrigins(s string) []string {
|
||||||
|
parts := strings.FieldsFunc(s, func(r rune) bool {
|
||||||
|
return r == ',' || r == '\n' || r == ' ' || r == '\t'
|
||||||
|
})
|
||||||
|
out := make([]string, 0, len(parts))
|
||||||
|
for _, p := range parts {
|
||||||
|
p = strings.ToLower(strings.TrimRight(strings.TrimSpace(p), "/"))
|
||||||
|
if p != "" {
|
||||||
|
out = append(out, p)
|
||||||
}
|
}
|
||||||
if resourceId == "" {
|
|
||||||
missing = append(missing, "BYTEDANCE_TTS_RESOURCE_ID")
|
|
||||||
}
|
}
|
||||||
if speaker == "" {
|
return out
|
||||||
missing = append(missing, "BYTEDANCE_TTS_SPEAKER")
|
}
|
||||||
}
|
|
||||||
if len(missing) > 0 {
|
// LoadRuntimeConfig 从 store 加载 TTS 全局配置到 TTSOptions / TTSTimeout / Auth.APIKeys 内存。
|
||||||
return fmt.Errorf("缺少必需的环境变量: %v", missing)
|
// 启动期(master 模式)调一次,或 PUT /api/settings 后调一次(改完立即生效)。
|
||||||
|
////
|
||||||
|
// 与原 InitTTSConfig 的区别:
|
||||||
|
// - 不再读 BYTEDANCE_TTS_* env;全部从 store.Settings 读
|
||||||
|
// - 必填项(api_key / default_resource_id / default_speaker)缺失时返 error
|
||||||
|
// - 失败时 TTSConfigErr 被设置,/v1/audio/speech 路由会返 503
|
||||||
|
// - 成功时清空 TTSConfigErr
|
||||||
|
//
|
||||||
|
// 字段映射(原 env → store key):
|
||||||
|
// BYTEDANCE_TTS_API_KEY → api_key
|
||||||
|
// BYTEDANCE_TTS_RESOURCE_ID → default_resource_id
|
||||||
|
// BYTEDANCE_TTS_SPEAKER → default_speaker
|
||||||
|
// BYTEDANCE_TTS_MODEL → model
|
||||||
|
// BYTEDANCE_TTS_FORMAT → default_format (默认 mp3)
|
||||||
|
// BYTEDANCE_TTS_SAMPLE_RATE → sample_rate (默认 24000)
|
||||||
|
// BYTEDANCE_TTS_BIT_RATE → bit_rate (默认 0)
|
||||||
|
// BYTEDANCE_TTS_MODEL_TYPE → model_type (默认 0)
|
||||||
|
// BYTEDANCE_TTS_EXPLICIT_LANGUAGE → explicit_language
|
||||||
|
// BYTEDANCE_TTS_ENABLE_SUBTITLE → enable_subtitle (默认 false)
|
||||||
|
// BYTEDANCE_TTS_TIMEOUT → TTSTimeout (默认 30s)
|
||||||
|
//
|
||||||
|
// 鉴权 key(auth_key)优先级:DB > env OPENAI_TTS_API_KEY
|
||||||
|
// - 首次启动(无 DB 数据):用 env,保证向后兼容
|
||||||
|
// - 已 install:用 DB,env 不再读
|
||||||
|
// - DB 没 auth_key 但 env 有(env fallback):仍用 env
|
||||||
|
func LoadRuntimeConfig(s Store) error {
|
||||||
|
all, err := s.SettingsGetAll()
|
||||||
|
if err != nil {
|
||||||
|
TTSConfigErr = fmt.Errorf("read settings failed: %w", err)
|
||||||
|
return TTSConfigErr
|
||||||
}
|
}
|
||||||
|
|
||||||
model := os.Getenv("BYTEDANCE_TTS_MODEL")
|
apiKey := all["api_key"]
|
||||||
format := getEnvDefault("BYTEDANCE_TTS_FORMAT", "mp3")
|
resourceId := all["default_resource_id"]
|
||||||
sampleRate := getEnvInt("BYTEDANCE_TTS_SAMPLE_RATE", 24000)
|
speaker := all["default_speaker"]
|
||||||
bitRate := getEnvInt("BYTEDANCE_TTS_BIT_RATE", 0)
|
missing := []string{}
|
||||||
modelType := getEnvInt("BYTEDANCE_TTS_MODEL_TYPE", 0)
|
if apiKey == "" {
|
||||||
explicitLanguage := os.Getenv("BYTEDANCE_TTS_EXPLICIT_LANGUAGE")
|
missing = append(missing, "api_key")
|
||||||
enableSubtitle := getEnvBool("BYTEDANCE_TTS_ENABLE_SUBTITLE", false)
|
}
|
||||||
|
if resourceId == "" {
|
||||||
|
missing = append(missing, "default_resource_id")
|
||||||
|
}
|
||||||
|
if speaker == "" {
|
||||||
|
missing = append(missing, "default_speaker")
|
||||||
|
}
|
||||||
|
if len(missing) > 0 {
|
||||||
|
TTSConfigErr = fmt.Errorf("missing required settings: %v", missing)
|
||||||
|
return TTSConfigErr
|
||||||
|
}
|
||||||
|
|
||||||
|
// 【BUG 修复 · 第二轮】default_speaker 是 voice **名字**(如 "chun"),
|
||||||
|
// 不是火山 speaker ID (如 "S_G8tEKnaJ1")。原代码直接把 voice 名当
|
||||||
|
// speaker ID 用,导致调 /v1/audio/speech 不传 voice 时火山 55000000。
|
||||||
|
//
|
||||||
|
// 字段优先级:
|
||||||
|
// - speaker ← 从 default_speaker 这个 voice 查表拿真 ID (必查)
|
||||||
|
// - resource_id ← settings 里的(用户偏好,不被 voice 行覆盖)
|
||||||
|
// - model ← voice 行的优先,settings 里的次之
|
||||||
|
//
|
||||||
|
// 之前 f5563e6 把 resourceId 也覆盖了,导致用户在 setup 设的
|
||||||
|
// default_resource_id 永远没机会生效。这次只覆盖 speaker,不动 resourceId。
|
||||||
|
var voiceModel string
|
||||||
|
if vSpeaker, _, vModel, found, vErr := s.GetVoiceForTTS(speaker); vErr == nil && found {
|
||||||
|
speaker = vSpeaker
|
||||||
|
if vModel != "" {
|
||||||
|
voiceModel = vModel
|
||||||
|
}
|
||||||
|
// 找不到 voice 时不报错 — 保持原值(向后兼容)
|
||||||
|
}
|
||||||
|
|
||||||
|
model := all["model"]
|
||||||
|
if voiceModel != "" {
|
||||||
|
model = voiceModel // voice 行有 model 时优先用 voice 的
|
||||||
|
}
|
||||||
|
format := all["default_format"]
|
||||||
|
if format == "" {
|
||||||
|
format = "mp3"
|
||||||
|
}
|
||||||
|
sampleRate, _ := s.SettingsGetInt("sample_rate", 24000)
|
||||||
|
bitRate, _ := s.SettingsGetInt("bit_rate", 0)
|
||||||
|
modelType, _ := s.SettingsGetInt("model_type", 0)
|
||||||
|
explicitLanguage := all["explicit_language"]
|
||||||
|
enableSubtitle, _ := s.SettingsGetBool("enable_subtitle", false)
|
||||||
|
|
||||||
var adds *volcano.Additions
|
var adds *volcano.Additions
|
||||||
if modelType != 0 || explicitLanguage != "" {
|
if modelType != 0 || explicitLanguage != "" {
|
||||||
@@ -145,17 +249,10 @@ func InitTTSConfig() error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
TTSTimeout = common.DefaultTimeout
|
TTSTimeout = common.DefaultTimeout
|
||||||
if ts := os.Getenv("BYTEDANCE_TTS_TIMEOUT"); ts != "" {
|
if v, err := s.SettingsGetDuration("timeout", common.DefaultTimeout); err == nil {
|
||||||
if d, err := time.ParseDuration(ts); err == nil {
|
TTSTimeout = v
|
||||||
TTSTimeout = d
|
|
||||||
} else {
|
} else {
|
||||||
log.Printf("无效的超时设置 %q,使用默认值 %v", ts, TTSTimeout)
|
TTSTimeout = common.DefaultTimeout
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
common.DebugLog = getEnvBool("BYTEDANCE_TTS_DEBUG", false)
|
|
||||||
if common.DebugLog {
|
|
||||||
log.Println("调试日志已启用 BYTEDANCE_TTS_DEBUG")
|
|
||||||
}
|
}
|
||||||
|
|
||||||
TTSOptions = volcano.Options{
|
TTSOptions = volcano.Options{
|
||||||
@@ -172,9 +269,66 @@ func InitTTSConfig() error {
|
|||||||
EnableSubtitle: enableSubtitle,
|
EnableSubtitle: enableSubtitle,
|
||||||
Additions: adds,
|
Additions: adds,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// 鉴权 key:DB > env(向后兼容)
|
||||||
|
authKey := all["auth_key"]
|
||||||
|
if authKey == "" {
|
||||||
|
authKey = os.Getenv("OPENAI_TTS_API_KEY")
|
||||||
|
}
|
||||||
|
// 用临时 slice 避免和 InitAuthConfig 抢同一个 Auth.APIKeys 底层
|
||||||
|
if authKey != "" {
|
||||||
|
Auth.APIKeys = []string{authKey}
|
||||||
|
} else {
|
||||||
|
Auth.APIKeys = nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// CORS 配置:DB > env
|
||||||
|
// cors_allow_all (bool): 允许所有来源(*)
|
||||||
|
// cors_origins (string): 逗号分隔白名单
|
||||||
|
// 同源豁免由 middleware/cors.go 的 isSameOrigin 负责,DB 这里只管跨域名单
|
||||||
|
corsAllowAll, _ := s.SettingsGetBool("cors_allow_all", false)
|
||||||
|
if !corsAllowAll {
|
||||||
|
// env 兜底
|
||||||
|
if v := strings.ToLower(strings.TrimSpace(os.Getenv("CORS_ALLOW_ALL"))); v == "1" || v == "true" || v == "yes" {
|
||||||
|
corsAllowAll = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
originsStr := strings.TrimSpace(all["cors_origins"])
|
||||||
|
if originsStr == "" {
|
||||||
|
originsStr = os.Getenv("ALLOWED_ORIGINS")
|
||||||
|
}
|
||||||
|
if corsAllowAll {
|
||||||
|
CORS.AllowAll = true
|
||||||
|
CORS.Origins = nil
|
||||||
|
} else if originsStr != "" {
|
||||||
|
CORS.AllowAll = false
|
||||||
|
CORS.Origins = SplitOriginsForCORS(originsStr)
|
||||||
|
} else {
|
||||||
|
CORS.AllowAll = false
|
||||||
|
CORS.Origins = nil
|
||||||
|
}
|
||||||
|
|
||||||
|
TTSConfigErr = nil
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Store 是 LoadRuntimeConfig 需要的最小接口(避免 setting 包 import store 产生 cycle)。
|
||||||
|
//
|
||||||
|
// 重要:VoiceGetByName 用 4 个返回值(speaker/resourceID/model/found/err)
|
||||||
|
// 而非 (VoiceRef, error),这样 store 包不需要 import setting 包
|
||||||
|
// 就能实现这个接口(避免循环 import)。
|
||||||
|
type Store interface {
|
||||||
|
SettingsGetAll() (map[string]string, error)
|
||||||
|
SettingsGetInt(key string, def int) (int, error)
|
||||||
|
SettingsGetBool(key string, def bool) (bool, error)
|
||||||
|
SettingsGetDuration(key string, def time.Duration) (time.Duration, error)
|
||||||
|
// GetVoiceForTTS 给定 voice 名字,返 (speaker_id, resource_id, model, found, err)。
|
||||||
|
// - found=false 表示 voice 不存在(此时 err=nil,返回值是空串)
|
||||||
|
// - err!=nil 是真错误(db 失败等)
|
||||||
|
// - 找到时返 voice 行的真实字段值
|
||||||
|
GetVoiceForTTS(name string) (speaker, resourceID, model string, found bool, err error)
|
||||||
|
}
|
||||||
|
|
||||||
func getEnvDefault(name, def string) string {
|
func getEnvDefault(name, def string) string {
|
||||||
if v := os.Getenv(name); v != "" {
|
if v := os.Getenv(name); v != "" {
|
||||||
return v
|
return v
|
||||||
@@ -208,6 +362,30 @@ func getEnvBool(name string, def bool) bool {
|
|||||||
return b
|
return b
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// InitSetupToken 加载或生成安装模式下的初始化凭证。
|
||||||
|
// - TTS_ADMIN_KEY 存在:用其值,SetupTokenSource="env"
|
||||||
|
// - TTS_ADMIN_KEY 空:随机生成 16 字节 = 32 字符 hex,SetupTokenSource="ephemeral",打印到日志
|
||||||
|
func InitSetupToken() {
|
||||||
|
v := os.Getenv("TTS_ADMIN_KEY")
|
||||||
|
if v != "" {
|
||||||
|
SetupToken = v
|
||||||
|
SetupTokenSource = "env"
|
||||||
|
return
|
||||||
|
}
|
||||||
|
// 临时 token:16 字节随机 = 32 字符 hex,够用且短
|
||||||
|
b := make([]byte, 16)
|
||||||
|
if _, err := rand.Read(b); err != nil {
|
||||||
|
// 极端情况:随机源失败,降级为时间戳(不应发生)
|
||||||
|
log.Printf("[setup] 生成一次性 token 失败,使用时间戳: %v", err)
|
||||||
|
SetupToken = fmt.Sprintf("dev-%d", time.Now().UnixNano())
|
||||||
|
SetupTokenSource = "ephemeral"
|
||||||
|
return
|
||||||
|
}
|
||||||
|
SetupToken = hex.EncodeToString(b)
|
||||||
|
SetupTokenSource = "ephemeral"
|
||||||
|
log.Printf("[setup] 一次性安装 token(仅打印一次,公网部署请设置 TTS_ADMIN_KEY): %s", SetupToken)
|
||||||
|
}
|
||||||
|
|
||||||
// CheckEnvironmentVariables 返回 /health 用的环境变量状态快照。
|
// CheckEnvironmentVariables 返回 /health 用的环境变量状态快照。
|
||||||
func CheckEnvironmentVariables() map[string]interface{} {
|
func CheckEnvironmentVariables() map[string]interface{} {
|
||||||
required := map[string]bool{
|
required := map[string]bool{
|
||||||
@@ -257,6 +435,12 @@ func LogStartupSummary() {
|
|||||||
log.Printf("ALLOWED_ORIGINS: 已配置 %d 个允许的跨域来源白名单", len(CORS.Origins))
|
log.Printf("ALLOWED_ORIGINS: 已配置 %d 个允许的跨域来源白名单", len(CORS.Origins))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if h := TrustedProxyHops; h == 0 {
|
||||||
|
log.Printf("TRUSTED_PROXY_HOPS: 启发式模式(默认,XFF 链尾第一个公网 IP)")
|
||||||
|
} else {
|
||||||
|
log.Printf("TRUSTED_PROXY_HOPS: 精确模式,信任 %d 跳反代", h)
|
||||||
|
}
|
||||||
|
|
||||||
log.Printf("火山 TTS 必填项状态:")
|
log.Printf("火山 TTS 必填项状态:")
|
||||||
type ttsCheck struct {
|
type ttsCheck struct {
|
||||||
name string
|
name string
|
||||||
@@ -266,7 +450,8 @@ func LogStartupSummary() {
|
|||||||
checks := []ttsCheck{
|
checks := []ttsCheck{
|
||||||
{"BYTEDANCE_TTS_API_KEY", maskAPIKey(TTSOptions.APIKey), TTSOptions.APIKey != ""},
|
{"BYTEDANCE_TTS_API_KEY", maskAPIKey(TTSOptions.APIKey), TTSOptions.APIKey != ""},
|
||||||
{"BYTEDANCE_TTS_RESOURCE_ID", TTSOptions.ResourceID, TTSOptions.ResourceID != ""},
|
{"BYTEDANCE_TTS_RESOURCE_ID", TTSOptions.ResourceID, TTSOptions.ResourceID != ""},
|
||||||
{"BYTEDANCE_TTS_SPEAKER", TTSOptions.Speaker, TTSOptions.Speaker != ""},
|
// speaker 是火山复刻音色 ID(用户付费资产),日志里打码,避免明文落盘
|
||||||
|
{"BYTEDANCE_TTS_SPEAKER", telemetry.MaskSpeaker(TTSOptions.Speaker), TTSOptions.Speaker != ""},
|
||||||
}
|
}
|
||||||
missingCount := 0
|
missingCount := 0
|
||||||
for _, c := range checks {
|
for _, c := range checks {
|
||||||
@@ -298,14 +483,3 @@ func maskAPIKey(key string) string {
|
|||||||
}
|
}
|
||||||
return key[:4] + "****" + key[len(key)-4:]
|
return key[:4] + "****" + key[len(key)-4:]
|
||||||
}
|
}
|
||||||
|
|
||||||
// CheckStaticFiles 检查 /dashboard 路由依赖的 health.html 是否存在。
|
|
||||||
func CheckStaticFiles() {
|
|
||||||
if _, err := os.Stat("health.html"); os.IsNotExist(err) {
|
|
||||||
log.Println("警告: health.html 不存在,/dashboard 路由将返回 404")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// 保留 dto.ByteDanceTTSConfig 引用避免 import 警告;
|
|
||||||
// 新代码不应再使用这个类型,设置已在 TTSOptions 中。
|
|
||||||
var _ = dto.ByteDanceTTSConfig{}
|
|
||||||
|
|||||||
+153
@@ -0,0 +1,153 @@
|
|||||||
|
// Package store 负责 SQLite 访问层:打开/建表/迁移、settings/voices CRUD、
|
||||||
|
// 完整性校验。所有运行时可变配置(全局参数 + 音色库)统一落 SQLite,
|
||||||
|
// 环境变量仅作引导参数(TTS_DB_PATH 等)。
|
||||||
|
//
|
||||||
|
// 设计约束:
|
||||||
|
// - 单二进制分发,纯 Go SQLite(modernc.org/sqlite),CGO_ENABLED=0
|
||||||
|
// - 单用户自用,SetMaxOpenConns(1) 避免并发写竞争
|
||||||
|
// - 所有 SQL 参数化,严禁字符串拼接
|
||||||
|
// - schema_version 表保留未来升级钩子
|
||||||
|
package store
|
||||||
|
|
||||||
|
import (
|
||||||
|
"database/sql"
|
||||||
|
"fmt"
|
||||||
|
|
||||||
|
_ "modernc.org/sqlite" // 注册 sqlite driver
|
||||||
|
)
|
||||||
|
|
||||||
|
// schemaVersion 是当前 schema 版本号;每次结构性变更 +1。
|
||||||
|
// migrate.go 负责在 Open 时按版本号增量应用。
|
||||||
|
const schemaVersion = 1
|
||||||
|
|
||||||
|
// Store 是 SQLite 访问层的统一入口;所有 settings/voices 操作都通过它。
|
||||||
|
type Store struct {
|
||||||
|
db *sql.DB
|
||||||
|
}
|
||||||
|
|
||||||
|
// Open 打开或创建 SQLite 数据库,自动应用建表与迁移。
|
||||||
|
// path 推荐为绝对路径;空字符串会落到临时目录,不应用于生产。
|
||||||
|
func Open(path string) (*Store, error) {
|
||||||
|
// modernc.org/sqlite 注册名:"sqlite" + "sqlite3" 两种
|
||||||
|
// _dsn 参数控制 journal_mode 等;这里先打开,再用 PRAGMA 调整
|
||||||
|
db, err := sql.Open("sqlite", path)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("store: open %q failed: %w", path, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// 单用户自用场景,避免并发写竞争
|
||||||
|
db.SetMaxOpenConns(1)
|
||||||
|
|
||||||
|
// PRAGMA 需要连接,触发一次 Ping 拿连接
|
||||||
|
if _, err := db.Exec(`PRAGMA journal_mode = WAL`); err != nil {
|
||||||
|
_ = db.Close()
|
||||||
|
return nil, fmt.Errorf("store: enable WAL failed: %w", err)
|
||||||
|
}
|
||||||
|
if _, err := db.Exec(`PRAGMA foreign_keys = ON`); err != nil {
|
||||||
|
_ = db.Close()
|
||||||
|
return nil, fmt.Errorf("store: enable foreign_keys failed: %w", err)
|
||||||
|
}
|
||||||
|
if _, err := db.Exec(`PRAGMA synchronous = NORMAL`); err != nil {
|
||||||
|
_ = db.Close()
|
||||||
|
return nil, fmt.Errorf("store: enable synchronous=NORMAL failed: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
s := &Store{db: db}
|
||||||
|
if err := s.migrate(); err != nil {
|
||||||
|
_ = db.Close()
|
||||||
|
return nil, fmt.Errorf("store: migrate failed: %w", err)
|
||||||
|
}
|
||||||
|
return s, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Close 关闭底层连接;调用方应保证只 Close 一次。
|
||||||
|
func (s *Store) Close() error {
|
||||||
|
if s == nil || s.db == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return s.db.Close()
|
||||||
|
}
|
||||||
|
|
||||||
|
// DB 返回底层 *sql.DB,仅供 store 包内或集成测试使用;
|
||||||
|
// 业务代码不应直接拿连接,所有操作走 Store 暴露的方法。
|
||||||
|
func (s *Store) DB() *sql.DB { return s.db }
|
||||||
|
|
||||||
|
// IntegrityCheck 执行 PRAGMA integrity_check;返回 "ok" 即视为库健康。
|
||||||
|
// installer 包据此判定是否触发损坏回退。
|
||||||
|
func (s *Store) IntegrityCheck() (string, error) {
|
||||||
|
row := s.db.QueryRow(`PRAGMA integrity_check`)
|
||||||
|
var result string
|
||||||
|
if err := row.Scan(&result); err != nil {
|
||||||
|
return "", fmt.Errorf("store: integrity_check scan failed: %w", err)
|
||||||
|
}
|
||||||
|
return result, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Path 返回当前 db 的 SQLite 报告路径(用于日志)。
|
||||||
|
// 通过 PRAGMA database_list 拿权威值,避免和入参 path 不一致时的混淆。
|
||||||
|
func (s *Store) Path() (string, error) {
|
||||||
|
rows, err := s.db.Query(`PRAGMA database_list`)
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("store: database_list query failed: %w", err)
|
||||||
|
}
|
||||||
|
defer rows.Close()
|
||||||
|
if !rows.Next() {
|
||||||
|
return "", fmt.Errorf("store: database_list returned no rows")
|
||||||
|
}
|
||||||
|
var seq int
|
||||||
|
var name, file string
|
||||||
|
if err := rows.Scan(&seq, &name, &file); err != nil {
|
||||||
|
return "", fmt.Errorf("store: database_list scan failed: %w", err)
|
||||||
|
}
|
||||||
|
return file, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// migrate 应用 schema 迁移。当前 schema_version=1,只做基础建表。
|
||||||
|
// 未来升级:写 applyMigration(n) 函数,n 为目标版本号。
|
||||||
|
func (s *Store) migrate() error {
|
||||||
|
// schema_version 表记录当前版本
|
||||||
|
if _, err := s.db.Exec(`
|
||||||
|
CREATE TABLE IF NOT EXISTS schema_version (
|
||||||
|
version INTEGER PRIMARY KEY,
|
||||||
|
applied_at TEXT NOT NULL DEFAULT (datetime('now'))
|
||||||
|
)`); err != nil {
|
||||||
|
return fmt.Errorf("create schema_version: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// settings 表(全局配置)
|
||||||
|
if _, err := s.db.Exec(`
|
||||||
|
CREATE TABLE IF NOT EXISTS settings (
|
||||||
|
key TEXT PRIMARY KEY,
|
||||||
|
value TEXT NOT NULL,
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now'))
|
||||||
|
)`); err != nil {
|
||||||
|
return fmt.Errorf("create settings: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// voices 表(音色库)
|
||||||
|
if _, err := s.db.Exec(`
|
||||||
|
CREATE TABLE IF NOT EXISTS voices (
|
||||||
|
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
||||||
|
name TEXT NOT NULL UNIQUE,
|
||||||
|
speaker TEXT NOT NULL,
|
||||||
|
resource_id TEXT NOT NULL,
|
||||||
|
model TEXT DEFAULT '',
|
||||||
|
language TEXT DEFAULT '',
|
||||||
|
description TEXT DEFAULT '',
|
||||||
|
enabled INTEGER NOT NULL DEFAULT 1,
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now'))
|
||||||
|
)`); err != nil {
|
||||||
|
return fmt.Errorf("create voices: %w", err)
|
||||||
|
}
|
||||||
|
if _, err := s.db.Exec(`CREATE UNIQUE INDEX IF NOT EXISTS idx_voices_name ON voices(name)`); err != nil {
|
||||||
|
return fmt.Errorf("create idx_voices_name: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// 当前版本
|
||||||
|
if _, err := s.db.Exec(`
|
||||||
|
INSERT OR IGNORE INTO schema_version (version) VALUES (?)`, schemaVersion); err != nil {
|
||||||
|
return fmt.Errorf("insert schema_version: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,27 @@
|
|||||||
|
package store
|
||||||
|
|
||||||
|
// schema 版本号演进与迁移函数注册表。
|
||||||
|
//
|
||||||
|
// 用法:每次结构性变更时 +1 schemaVersion 常量,并在 migrations 切片中追加 applyV<n>。
|
||||||
|
// migrate.go 会在 Open 时按版本号顺序应用。
|
||||||
|
//
|
||||||
|
// 注意:本文件留作未来扩展,本期 M0 阶段 schemaVersion=1,migrate() 在 db.go
|
||||||
|
// 内做基础建表,未触发 migrations 调度。切到 v2 时再启用。
|
||||||
|
|
||||||
|
// Migration 是从 version N-1 升级到 N 的迁移函数。
|
||||||
|
type Migration struct {
|
||||||
|
From int
|
||||||
|
To int
|
||||||
|
Fn func(tx interface{ Exec(query string, args ...any) (any, error) }) error
|
||||||
|
}
|
||||||
|
|
||||||
|
// migrations 是按 From 升序排列的迁移列表;首条 From 必须等于 1。
|
||||||
|
// 留作占位,本期为空。
|
||||||
|
var migrations = []Migration{}
|
||||||
|
|
||||||
|
// schemaVersionRequested 是期望的 schema 版本号;db.go 里直接写常量。
|
||||||
|
// 这里留个常量引用便于未来从 db.go 解耦。
|
||||||
|
const schemaVersionRequested = 1
|
||||||
|
|
||||||
|
// CurrentVersion 返回当前代码期望的 schema 版本。
|
||||||
|
func CurrentVersion() int { return schemaVersionRequested }
|
||||||
@@ -0,0 +1,175 @@
|
|||||||
|
package store
|
||||||
|
|
||||||
|
import (
|
||||||
|
"database/sql"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"strconv"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// SettingsKey 是 settings 表的合法键白名单;防止上游拼写错误静默落库。
|
||||||
|
// 留空 hash 表示允许任意键;严格模式时把允许的键填进来。
|
||||||
|
//
|
||||||
|
// 本期(M0)使用宽松模式:任何非空字符串键都可以写入。
|
||||||
|
// 收紧时把对应键填入 allowedSettingsKeys 即可。
|
||||||
|
var allowedSettingsKeys = map[string]struct{}{}
|
||||||
|
|
||||||
|
// SettingsAccess 返回单条配置;键不存在返回 ("", false, nil)。
|
||||||
|
// 第二返回值表示键是否存在,便于上层区分"未设置"和"值为空串"。
|
||||||
|
func (s *Store) SettingsGet(key string) (string, bool, error) {
|
||||||
|
if key == "" {
|
||||||
|
return "", false, fmt.Errorf("store: settings key is empty")
|
||||||
|
}
|
||||||
|
row := s.db.QueryRow(`SELECT value FROM settings WHERE key = ?`, key)
|
||||||
|
var v string
|
||||||
|
err := row.Scan(&v)
|
||||||
|
if errors.Is(err, sql.ErrNoRows) {
|
||||||
|
return "", false, nil
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return "", false, fmt.Errorf("store: settings get %q: %w", key, err)
|
||||||
|
}
|
||||||
|
return v, true, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// SettingsSet 写入单条配置;空值会删除该键(SQLite 没 NULL 写法更直观)。
|
||||||
|
func (s *Store) SettingsSet(key, value string) error {
|
||||||
|
if key == "" {
|
||||||
|
return fmt.Errorf("store: settings key is empty")
|
||||||
|
}
|
||||||
|
if !isAllowedSettingsKey(key) {
|
||||||
|
return fmt.Errorf("store: settings key %q not in whitelist", key)
|
||||||
|
}
|
||||||
|
_, err := s.db.Exec(`
|
||||||
|
INSERT INTO settings (key, value, updated_at) VALUES (?, ?, datetime('now'))
|
||||||
|
ON CONFLICT(key) DO UPDATE SET value = excluded.value, updated_at = excluded.updated_at`,
|
||||||
|
key, value)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("store: settings set %q: %w", key, err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// SettingsDelete 显式删除单条键;键不存在不报错。
|
||||||
|
func (s *Store) SettingsDelete(key string) error {
|
||||||
|
if key == "" {
|
||||||
|
return fmt.Errorf("store: settings key is empty")
|
||||||
|
}
|
||||||
|
_, err := s.db.Exec(`DELETE FROM settings WHERE key = ?`, key)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("store: settings delete %q: %w", key, err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// SettingsGetAll 返回所有配置;按 key 升序。
|
||||||
|
func (s *Store) SettingsGetAll() (map[string]string, error) {
|
||||||
|
rows, err := s.db.Query(`SELECT key, value FROM settings ORDER BY key`)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("store: settings getall: %w", err)
|
||||||
|
}
|
||||||
|
defer rows.Close()
|
||||||
|
out := make(map[string]string)
|
||||||
|
for rows.Next() {
|
||||||
|
var k, v string
|
||||||
|
if err := rows.Scan(&k, &v); err != nil {
|
||||||
|
return nil, fmt.Errorf("store: settings getall scan: %w", err)
|
||||||
|
}
|
||||||
|
out[k] = v
|
||||||
|
}
|
||||||
|
if err := rows.Err(); err != nil {
|
||||||
|
return nil, fmt.Errorf("store: settings getall rows: %w", err)
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// SettingsSetBatch 一次性写入多对;保留单事务原子性,失败整体回滚。
|
||||||
|
// 适合 /api/setup 一次性写入全局配置。
|
||||||
|
func (s *Store) SettingsSetBatch(kv map[string]string) error {
|
||||||
|
if len(kv) == 0 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
tx, err := s.db.Begin()
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("store: settings setbatch begin: %w", err)
|
||||||
|
}
|
||||||
|
stmt, err := tx.Prepare(`
|
||||||
|
INSERT INTO settings (key, value, updated_at) VALUES (?, ?, datetime('now'))
|
||||||
|
ON CONFLICT(key) DO UPDATE SET value = excluded.value, updated_at = excluded.updated_at`)
|
||||||
|
if err != nil {
|
||||||
|
_ = tx.Rollback()
|
||||||
|
return fmt.Errorf("store: settings setbatch prepare: %w", err)
|
||||||
|
}
|
||||||
|
for k, v := range kv {
|
||||||
|
if k == "" {
|
||||||
|
_ = tx.Rollback()
|
||||||
|
return fmt.Errorf("store: settings setbatch: empty key")
|
||||||
|
}
|
||||||
|
if !isAllowedSettingsKey(k) {
|
||||||
|
_ = tx.Rollback()
|
||||||
|
return fmt.Errorf("store: settings setbatch: key %q not in whitelist", k)
|
||||||
|
}
|
||||||
|
if _, err := stmt.Exec(k, v); err != nil {
|
||||||
|
_ = stmt.Close()
|
||||||
|
_ = tx.Rollback()
|
||||||
|
return fmt.Errorf("store: settings setbatch exec %q: %w", k, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if err := stmt.Close(); err != nil {
|
||||||
|
_ = tx.Rollback()
|
||||||
|
return fmt.Errorf("store: settings setbatch close stmt: %w", err)
|
||||||
|
}
|
||||||
|
if err := tx.Commit(); err != nil {
|
||||||
|
return fmt.Errorf("store: settings setbatch commit: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// SettingsGetInt 返回整型配置,带默认值;键不存在或解析失败时回退到 def。
|
||||||
|
func (s *Store) SettingsGetInt(key string, def int) (int, error) {
|
||||||
|
v, ok, err := s.SettingsGet(key)
|
||||||
|
if err != nil || !ok {
|
||||||
|
return def, err
|
||||||
|
}
|
||||||
|
n, err := strconv.Atoi(v)
|
||||||
|
if err != nil {
|
||||||
|
return def, nil // 解析失败静默回退,不污染调用方
|
||||||
|
}
|
||||||
|
return n, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// SettingsGetBool 返回 bool 配置,接受 "1"/"true"/"t"/"TRUE" 等;
|
||||||
|
func (s *Store) SettingsGetBool(key string, def bool) (bool, error) {
|
||||||
|
v, ok, err := s.SettingsGet(key)
|
||||||
|
if err != nil || !ok {
|
||||||
|
return def, err
|
||||||
|
}
|
||||||
|
b, err := strconv.ParseBool(v)
|
||||||
|
if err != nil {
|
||||||
|
return def, nil
|
||||||
|
}
|
||||||
|
return b, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// SettingsGetDuration 返回 duration 配置;支持 "30s" "5m" "1h" 等。
|
||||||
|
func (s *Store) SettingsGetDuration(key string, def time.Duration) (time.Duration, error) {
|
||||||
|
v, ok, err := s.SettingsGet(key)
|
||||||
|
if err != nil || !ok {
|
||||||
|
return def, err
|
||||||
|
}
|
||||||
|
d, err := time.ParseDuration(v)
|
||||||
|
if err != nil {
|
||||||
|
return def, nil
|
||||||
|
}
|
||||||
|
return d, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// isAllowedSettingsKey 检查 key 是否在白名单;白名单空时全放行。
|
||||||
|
func isAllowedSettingsKey(key string) bool {
|
||||||
|
if len(allowedSettingsKeys) == 0 {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
_, ok := allowedSettingsKeys[key]
|
||||||
|
return ok
|
||||||
|
}
|
||||||
+297
@@ -0,0 +1,297 @@
|
|||||||
|
package store
|
||||||
|
|
||||||
|
import (
|
||||||
|
"database/sql"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"regexp"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Voice 是一行音色记录;时间字段保持 ISO8601 字符串(SQLite TEXT 默认)。
|
||||||
|
//
|
||||||
|
// JSON tag 是为了前端(admin.html)能直接读取 — 之前没加 tag 时 Go 的
|
||||||
|
// "Name" / "Speaker" 等大写字段会原样输出,前端用 v.name 拿到 undefined,
|
||||||
|
// 整张表看起来"空"但其实有数据。补 tag 后前端能正常显示。
|
||||||
|
type Voice struct {
|
||||||
|
ID int64 `json:"id"`
|
||||||
|
Name string `json:"name"`
|
||||||
|
Speaker string `json:"speaker"`
|
||||||
|
ResourceID string `json:"resource_id"`
|
||||||
|
Model string `json:"model"`
|
||||||
|
Language string `json:"language"`
|
||||||
|
Description string `json:"description"`
|
||||||
|
Enabled bool `json:"enabled"`
|
||||||
|
CreatedAt string `json:"created_at"`
|
||||||
|
UpdatedAt string `json:"updated_at"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ErrDuplicate 表示 name 唯一冲突;controller 翻译为 409。
|
||||||
|
var ErrDuplicate = errors.New("store: voice name already exists")
|
||||||
|
|
||||||
|
// ErrInUse 表示试图删除被 default_speaker 引用的音色;controller 翻译为 409。
|
||||||
|
var ErrInUse = errors.New("store: voice is referenced by default_speaker")
|
||||||
|
|
||||||
|
// ErrNotFound 表示按 id/name 找不到;controller 翻译为 404。
|
||||||
|
var ErrNotFound = errors.New("store: voice not found")
|
||||||
|
|
||||||
|
// voiceNameRe 限制 voice 名为 [a-zA-Z0-9_-]{1,64};SQL 注入 + 路径穿越防护。
|
||||||
|
var voiceNameRe = regexp.MustCompile(`^[a-zA-Z0-9_-]{1,64}$`)
|
||||||
|
|
||||||
|
// VoiceList 列出所有音色;includeDisabled=false 时只返回 enabled=1。
|
||||||
|
// 按 id 升序,稳定顺序便于前端展示。
|
||||||
|
func (s *Store) VoiceList(includeDisabled bool) ([]Voice, error) {
|
||||||
|
q := `SELECT id, name, speaker, resource_id, model, language, description, enabled, created_at, updated_at
|
||||||
|
FROM voices`
|
||||||
|
if !includeDisabled {
|
||||||
|
q += ` WHERE enabled = 1`
|
||||||
|
}
|
||||||
|
q += ` ORDER BY id ASC`
|
||||||
|
|
||||||
|
rows, err := s.db.Query(q)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("store: voice list: %w", err)
|
||||||
|
}
|
||||||
|
defer rows.Close()
|
||||||
|
|
||||||
|
out := make([]Voice, 0, 8)
|
||||||
|
for rows.Next() {
|
||||||
|
v, err := scanVoice(rows)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
out = append(out, v)
|
||||||
|
}
|
||||||
|
if err := rows.Err(); err != nil {
|
||||||
|
return nil, fmt.Errorf("store: voice list rows: %w", err)
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// VoiceGet 按 id 查;未命中返回 ErrNotFound。
|
||||||
|
func (s *Store) VoiceGet(id int64) (*Voice, error) {
|
||||||
|
row := s.db.QueryRow(`SELECT id, name, speaker, resource_id, model, language, description, enabled, created_at, updated_at
|
||||||
|
FROM voices WHERE id = ?`, id)
|
||||||
|
v, err := scanVoice(row)
|
||||||
|
if errors.Is(err, sql.ErrNoRows) {
|
||||||
|
return nil, ErrNotFound
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("store: voice get id=%d: %w", id, err)
|
||||||
|
}
|
||||||
|
return &v, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// VoiceGetByName 按 name 查;未命中返回 ErrNotFound。
|
||||||
|
// tts.go 路由用这个,要求 name 走参数化查询。
|
||||||
|
func (s *Store) VoiceGetByName(name string) (*Voice, error) {
|
||||||
|
row := s.db.QueryRow(`SELECT id, name, speaker, resource_id, model, language, description, enabled, created_at, updated_at
|
||||||
|
FROM voices WHERE name = ?`, name)
|
||||||
|
v, err := scanVoice(row)
|
||||||
|
if errors.Is(err, sql.ErrNoRows) {
|
||||||
|
return nil, ErrNotFound
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("store: voice getbyname %q: %w", name, err)
|
||||||
|
}
|
||||||
|
return &v, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetVoiceForTTS 实现 setting.Store 接口,返 voice 行的 TTS 关键字段。
|
||||||
|
// - found=false: voice 不存在(ErrNotFound 翻译为 found=false)
|
||||||
|
// - err != nil: 真错误(db 失败等)
|
||||||
|
// 这个方法存在是为了让 *Store 满足 setting.Store 接口,且不引起
|
||||||
|
// setting → store → setting 循环 import。
|
||||||
|
func (s *Store) GetVoiceForTTS(name string) (speaker, resourceID, model string, found bool, err error) {
|
||||||
|
v, err := s.VoiceGetByName(name)
|
||||||
|
if err != nil {
|
||||||
|
if errors.Is(err, ErrNotFound) {
|
||||||
|
return "", "", "", false, nil
|
||||||
|
}
|
||||||
|
return "", "", "", false, err
|
||||||
|
}
|
||||||
|
return v.Speaker, v.ResourceID, v.Model, true, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// VoiceInsert 新增音色;name 冲突返回 ErrDuplicate。
|
||||||
|
// 空字符串/格式不合法返回 error;不依赖 SQLite 约束作为唯一校验。
|
||||||
|
func (s *Store) VoiceInsert(v Voice) (int64, error) {
|
||||||
|
v.Name = strings.TrimSpace(v.Name)
|
||||||
|
v.Speaker = strings.TrimSpace(v.Speaker)
|
||||||
|
v.ResourceID = strings.TrimSpace(v.ResourceID)
|
||||||
|
v.Model = strings.TrimSpace(v.Model)
|
||||||
|
v.Language = strings.TrimSpace(v.Language)
|
||||||
|
v.Description = strings.TrimSpace(v.Description)
|
||||||
|
|
||||||
|
if err := validateVoiceName(v.Name); err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
if v.Speaker == "" {
|
||||||
|
return 0, fmt.Errorf("store: voice insert: speaker is required")
|
||||||
|
}
|
||||||
|
if v.ResourceID == "" {
|
||||||
|
return 0, fmt.Errorf("store: voice insert: resource_id is required")
|
||||||
|
}
|
||||||
|
|
||||||
|
res, err := s.db.Exec(`
|
||||||
|
INSERT INTO voices (name, speaker, resource_id, model, language, description, enabled, created_at, updated_at)
|
||||||
|
VALUES (?, ?, ?, ?, ?, ?, ?, datetime('now'), datetime('now'))`,
|
||||||
|
v.Name, v.Speaker, v.ResourceID, v.Model, v.Language, v.Description, boolToInt(v.Enabled))
|
||||||
|
if err != nil {
|
||||||
|
if isUniqueViolation(err) {
|
||||||
|
return 0, ErrDuplicate
|
||||||
|
}
|
||||||
|
return 0, fmt.Errorf("store: voice insert: %w", err)
|
||||||
|
}
|
||||||
|
id, err := res.LastInsertId()
|
||||||
|
if err != nil {
|
||||||
|
return 0, fmt.Errorf("store: voice insert lastid: %w", err)
|
||||||
|
}
|
||||||
|
return id, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// VoiceUpdate 整行替换;name 仍需保持唯一。
|
||||||
|
// 不允许把 name 改成空/不合法。
|
||||||
|
func (s *Store) VoiceUpdate(v Voice) error {
|
||||||
|
v.Name = strings.TrimSpace(v.Name)
|
||||||
|
v.Speaker = strings.TrimSpace(v.Speaker)
|
||||||
|
v.ResourceID = strings.TrimSpace(v.ResourceID)
|
||||||
|
v.Model = strings.TrimSpace(v.Model)
|
||||||
|
v.Language = strings.TrimSpace(v.Language)
|
||||||
|
v.Description = strings.TrimSpace(v.Description)
|
||||||
|
|
||||||
|
if err := validateVoiceName(v.Name); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if v.Speaker == "" {
|
||||||
|
return fmt.Errorf("store: voice update: speaker is required")
|
||||||
|
}
|
||||||
|
if v.ResourceID == "" {
|
||||||
|
return fmt.Errorf("store: voice update: resource_id is required")
|
||||||
|
}
|
||||||
|
|
||||||
|
res, err := s.db.Exec(`
|
||||||
|
UPDATE voices SET name=?, speaker=?, resource_id=?, model=?, language=?, description=?, enabled=?, updated_at=datetime('now')
|
||||||
|
WHERE id = ?`,
|
||||||
|
v.Name, v.Speaker, v.ResourceID, v.Model, v.Language, v.Description, boolToInt(v.Enabled), v.ID)
|
||||||
|
if err != nil {
|
||||||
|
if isUniqueViolation(err) {
|
||||||
|
return ErrDuplicate
|
||||||
|
}
|
||||||
|
return fmt.Errorf("store: voice update id=%d: %w", v.ID, err)
|
||||||
|
}
|
||||||
|
n, _ := res.RowsAffected()
|
||||||
|
if n == 0 {
|
||||||
|
return ErrNotFound
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// VoiceDelete 按 id 删;若被 settings.default_speaker 引用则返回 ErrInUse。
|
||||||
|
func (s *Store) VoiceDelete(id int64) error {
|
||||||
|
v, err := s.VoiceGet(id)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// 检查 default_speaker 引用
|
||||||
|
defVal, defOK, err := s.SettingsGet("default_speaker")
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if defOK && defVal == v.Name {
|
||||||
|
return ErrInUse
|
||||||
|
}
|
||||||
|
|
||||||
|
res, err := s.db.Exec(`DELETE FROM voices WHERE id = ?`, id)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("store: voice delete id=%d: %w", id, err)
|
||||||
|
}
|
||||||
|
n, _ := res.RowsAffected()
|
||||||
|
if n == 0 {
|
||||||
|
return ErrNotFound
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// VoiceToggleEnabled 翻转启用状态;返回更新后的值。
|
||||||
|
func (s *Store) VoiceToggleEnabled(id int64, enabled bool) error {
|
||||||
|
res, err := s.db.Exec(`UPDATE voices SET enabled=?, updated_at=datetime('now') WHERE id = ?`,
|
||||||
|
boolToInt(enabled), id)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("store: voice toggle id=%d: %w", id, err)
|
||||||
|
}
|
||||||
|
n, _ := res.RowsAffected()
|
||||||
|
if n == 0 {
|
||||||
|
return ErrNotFound
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// VoiceCount 统计行数;M2 仪表盘用。
|
||||||
|
func (s *Store) VoiceCount() (int, error) {
|
||||||
|
var n int
|
||||||
|
err := s.db.QueryRow(`SELECT COUNT(*) FROM voices`).Scan(&n)
|
||||||
|
if err != nil {
|
||||||
|
return 0, fmt.Errorf("store: voice count: %w", err)
|
||||||
|
}
|
||||||
|
return n, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// VoiceCountEnabled 统计 enabled=1 的行数;仪表盘用。
|
||||||
|
func (s *Store) VoiceCountEnabled() (int, error) {
|
||||||
|
var n int
|
||||||
|
err := s.db.QueryRow(`SELECT COUNT(*) FROM voices WHERE enabled = 1`).Scan(&n)
|
||||||
|
if err != nil {
|
||||||
|
return 0, fmt.Errorf("store: voice count enabled: %w", err)
|
||||||
|
}
|
||||||
|
return n, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// scanVoice 把 row 扫描成 Voice;接受 *sql.Row 或 *sql.Rows(都实现 Scan)。
|
||||||
|
type scanner interface {
|
||||||
|
Scan(dest ...any) error
|
||||||
|
}
|
||||||
|
|
||||||
|
func scanVoice(r scanner) (Voice, error) {
|
||||||
|
var v Voice
|
||||||
|
var enabled int
|
||||||
|
err := r.Scan(&v.ID, &v.Name, &v.Speaker, &v.ResourceID, &v.Model, &v.Language, &v.Description, &enabled, &v.CreatedAt, &v.UpdatedAt)
|
||||||
|
if err != nil {
|
||||||
|
return v, err
|
||||||
|
}
|
||||||
|
v.Enabled = enabled != 0
|
||||||
|
return v, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func validateVoiceName(name string) error {
|
||||||
|
if name == "" {
|
||||||
|
return fmt.Errorf("store: voice name is required")
|
||||||
|
}
|
||||||
|
if !voiceNameRe.MatchString(name) {
|
||||||
|
return fmt.Errorf("store: voice name %q invalid (must match [a-zA-Z0-9_-]{1,64})", name)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func boolToInt(b bool) int {
|
||||||
|
if b {
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
// isUniqueViolation 判定 SQLite 唯一约束错误。
|
||||||
|
// modernc.org/sqlite 错误信息中包含 "UNIQUE constraint failed: <table>.<col>";做大小写不敏感包含判定。
|
||||||
|
func isUniqueViolation(err error) bool {
|
||||||
|
if err == nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
msg := strings.ToLower(err.Error())
|
||||||
|
return strings.Contains(msg, "unique constraint failed")
|
||||||
|
}
|
||||||
|
|
||||||
|
// VoiceInsertedAt 返回当前时间字符串(UTC, RFC3339);留作未来 Voice 构造时使用,
|
||||||
|
// 暂不导出。
|
||||||
|
func voiceNow() string { return time.Now().UTC().Format(time.RFC3339) }
|
||||||
+42
-1
@@ -8,11 +8,52 @@
|
|||||||
// - Meter 是高层入口,NoopMeter 用于测试。
|
// - Meter 是高层入口,NoopMeter 用于测试。
|
||||||
package telemetry
|
package telemetry
|
||||||
|
|
||||||
import "sort"
|
import (
|
||||||
|
"crypto/sha1"
|
||||||
|
"encoding/hex"
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
// Labels 是指标附加的标签集合。Value 在序列化时会按 Prometheus 规范转义。
|
// Labels 是指标附加的标签集合。Value 在序列化时会按 Prometheus 规范转义。
|
||||||
type Labels map[string]string
|
type Labels map[string]string
|
||||||
|
|
||||||
|
// SpeakerLabel 把 speaker ID 转成不可逆的稳定短哈希,作为指标 label。
|
||||||
|
// 目的:保护火山复刻音色资产(speaker ID 是用户付费 / 隐私敏感);
|
||||||
|
// 同时仍能按 voice 聚合观测(同 speaker → 同 label)。
|
||||||
|
//
|
||||||
|
// 算法: sha1(s)[:8] = 32 bits 空间;典型 <100 个 voice 场景无碰撞风险。
|
||||||
|
// 空串返回 "unknown",避免 /metrics label 出现空值 (Prometheus 禁止空 label)。
|
||||||
|
//
|
||||||
|
// 注意: 这是**不可逆**哈希,不是加密;不可用于需要还原原始 speaker 的场景。
|
||||||
|
// Admin UI 想要看原名时,通过 /api/voices 拿 name 字段对照。
|
||||||
|
func SpeakerLabel(s string) string {
|
||||||
|
if s == "" {
|
||||||
|
return "unknown"
|
||||||
|
}
|
||||||
|
sum := sha1.Sum([]byte(s))
|
||||||
|
return hex.EncodeToString(sum[:])[:8]
|
||||||
|
}
|
||||||
|
|
||||||
|
// MaskSpeaker 把 speaker ID 部分打码用于日志输出。
|
||||||
|
// - 空 → "***"
|
||||||
|
// - 长度 ≤ 4 → 全打码
|
||||||
|
// - 其它 → 前 4 + **** + 后 4 (保留前缀便于肉眼区分 "S_xx 开头" vs "BV001_...")
|
||||||
|
// 例子: "S_G8tEKnaJ1" → "S_G8****naJ1"
|
||||||
|
func MaskSpeaker(s string) string {
|
||||||
|
if s == "" {
|
||||||
|
return "(未设置)"
|
||||||
|
}
|
||||||
|
if len(s) <= 4 {
|
||||||
|
return strings.Repeat("*", len(s))
|
||||||
|
}
|
||||||
|
// 找前 4 字符中第一个非 [A-Za-z0-9_] 字符做截断,避免截到奇怪位置
|
||||||
|
// (虽然火山 ID 实际都是 S_xxx 字母数字组合,这里保险)
|
||||||
|
prefix := s[:4]
|
||||||
|
suffix := s[len(s)-4:]
|
||||||
|
return prefix + "****" + suffix
|
||||||
|
}
|
||||||
|
|
||||||
// labelKey 计算一组标签的稳定 key,用于在内部 map 中唯一定位 child。
|
// labelKey 计算一组标签的稳定 key,用于在内部 map 中唯一定位 child。
|
||||||
// 缺失或多余的 label 一律视为空串,以保证 child 数量与 label 名集合一致。
|
// 缺失或多余的 label 一律视为空串,以保证 child 数量与 label 名集合一致。
|
||||||
func labelKey(names []string, labels Labels) string {
|
func labelKey(names []string, labels Labels) string {
|
||||||
|
|||||||
@@ -0,0 +1,18 @@
|
|||||||
|
// Package version 提供构建时注入的版本信息。
|
||||||
|
//
|
||||||
|
// Version 和 Commit 在编译时通过 -ldflags 注入:
|
||||||
|
//
|
||||||
|
// go build -ldflags "-X github.com/volcano-tts/tts-api/version.Version=$VERSION \
|
||||||
|
// -X github.com/volcano-tts/tts-api/version.Commit=$COMMIT"
|
||||||
|
//
|
||||||
|
// 开发时默认 "dev",CI/CD 时通常由 git describe 自动算出:
|
||||||
|
// VERSION=$(git describe --tags --always --dirty)
|
||||||
|
// COMMIT=$(git rev-parse --short HEAD)
|
||||||
|
//
|
||||||
|
// /health 端点会暴露这两个值,方便运维确认"跑的到底是哪个 commit"。
|
||||||
|
package version
|
||||||
|
|
||||||
|
var (
|
||||||
|
Version = "dev"
|
||||||
|
Commit = "dev"
|
||||||
|
)
|
||||||
Reference in New Issue
Block a user