## 日志(用户要求:分级 + 每个拦截都要有指出代码行的调试日志 + 两类文件)
- 新增 internal/logging:拦截点捕获(file:line + 函数名,相对路径)、两类文件轮转、
按级别/类别分流。httpapi 与 middleware 各自薄封装,无循环依赖。
- 两类目录(数据目录下):
operations/ 放行类(INFO「操作已放行」+ 常规运行日志,按 log.level)
interceptions/ 拦截类(WARN 中文原因 + 拦截点 + method/path/actor/role/requestId、
DEBUG 上下文、ERROR 服务端异常)—— **固定 debug 采集**,
否则默认 info 下"每次拦截的调试日志"根本看不见
- 命名 operations-YYYYMMDD[.N].log,按天+按大小轮转,每类保留 keepFiles 份;写盘失败
降级只写控制台且只 Warn 一次。
- 所有业务错误统一走 newAPIError 捕获拦截点(11 处内联 &apiError{} 已收进构造函数,
防止绕过);中间件层拦截(401/403/CSRF/未改初始密码/429)也留痕,响应体与状态码一字未变。
- config.yaml 的 log 段新增 dir / maxSizeMB / keepFiles(留空即默认)。
- 服务端包数 12 → 13(新增 internal/logging)。
## 成绩录入(用户实机踩坑)
- 真因一:成绩格 placeholder 是光秃秃的 `1:06.33`,而全仓库没有任何 ::placeholder 样式,
示例文本与真实输入长得一样 → 用户把灰字当成已填内容,那 13 格其实是空的。
- 真因二:2 条报错是秒位 ≥ 60(1:70)或全角冒号(1:06);1:06 与 1:06.00 在解析器里
本来就等价(都 = 66),格式不是问题。
- 真因三:成绩格没有宽度定义(旁边名次 72px、状态 110px 都有),被挤到第 4 位数字看不见。
修复:parseSecondsDetail 区分 empty/seconds-overflow/unrecognized;新增 entryGuards.ts
纯函数(录入页与审核页共用),报错**打出那一格的实际内容**并说明原因;解析器新认全角
冒号/全角数字/1分06秒 等写法;成绩格 min-width 112px(按 fontTools 实测文本宽度定);
示例文本改 `例 1:06.33` 等并给录入表格内的 ::placeholder 加淡色斜体;新增
onBeforeRouteLeave 离开守卫(原来切菜单会静默丢未保存成绩)。
测试:服务端 13 包全绿(372 个测试函数);前端 vue-tsc 通过、205 例全过;Console 18 文件。
docs/ 与 devdocs/ 同步(FAQ 到 Q76,部署指南新增第 10 节「服务端日志与拦截复盘」)。
317 lines
11 KiB
Go
317 lines
11 KiB
Go
// Command scoreboard 是赛事积分榜系统的服务端。
|
||
package main
|
||
|
||
import (
|
||
"context"
|
||
"database/sql"
|
||
"errors"
|
||
"flag"
|
||
"fmt"
|
||
"log/slog"
|
||
"net/http"
|
||
"os"
|
||
"os/signal"
|
||
"path/filepath"
|
||
"strings"
|
||
"syscall"
|
||
"time"
|
||
|
||
_ "modernc.org/sqlite"
|
||
|
||
"git.yeij.top/AskaEth/Scoreboard/server/internal/auth"
|
||
"git.yeij.top/AskaEth/Scoreboard/server/internal/config"
|
||
"git.yeij.top/AskaEth/Scoreboard/server/internal/export"
|
||
"git.yeij.top/AskaEth/Scoreboard/server/internal/httpapi"
|
||
"git.yeij.top/AskaEth/Scoreboard/server/internal/logging"
|
||
"git.yeij.top/AskaEth/Scoreboard/server/internal/middleware"
|
||
"git.yeij.top/AskaEth/Scoreboard/server/internal/realtime"
|
||
"git.yeij.top/AskaEth/Scoreboard/server/internal/store"
|
||
)
|
||
|
||
// version 由构建时注入:-ldflags "-X main.version=..."
|
||
var version = "dev_0.1.0"
|
||
|
||
func main() {
|
||
if len(os.Args) > 1 && os.Args[1] == "backup" {
|
||
if err := runBackup(os.Args[2:]); err != nil {
|
||
fmt.Fprintf(os.Stderr, "备份失败: %v\n", err)
|
||
os.Exit(1)
|
||
}
|
||
return
|
||
}
|
||
if len(os.Args) > 1 && os.Args[1] == "passwd" {
|
||
if err := runPasswd(os.Args[2:]); err != nil {
|
||
fmt.Fprintf(os.Stderr, "重置密码失败: %v\n", err)
|
||
os.Exit(1)
|
||
}
|
||
return
|
||
}
|
||
|
||
configPath := flag.String("config", "config.yaml", "配置文件路径")
|
||
// 留空表示「按记忆文件里记住的上一次赛事」:Console 拉起服务端时不传 -project,
|
||
// 管理端切换赛事后靠这里读回新项目,否则导入的赛事包永远不会被打开。
|
||
project := flag.String("project", "", "赛事项目名(data/event_projs/<项目名>/event.db);留空则用记住的上一次赛事,再没有就用 default")
|
||
dataDir := flag.String("data", "", "数据目录;非空时覆盖配置文件里的 dataDir")
|
||
flag.Parse()
|
||
|
||
cfg, err := config.Load(*configPath)
|
||
if err != nil {
|
||
fmt.Fprintf(os.Stderr, "加载配置失败: %v\n", err)
|
||
os.Exit(1)
|
||
}
|
||
|
||
// 必须在 store.Open 等所有使用 cfg.DataDir 的地方之前覆盖:Console 靠它把数据放到安装目录之外。
|
||
// 不传(或传空串)时保持配置文件里的相对 data,便携与手工运行的行为不变。
|
||
dataDirFromFlag := cfg.ApplyDataDir(*dataDir)
|
||
|
||
// 控制台输出保持原样;文件按「放行 / 拦截」两类分流落盘(见 internal/logging)。
|
||
// 日志写不进去也不能影响服务:装配阶段不返回错误,运行期由 logging 降级为只写控制台。
|
||
logHandler, closeLogs := logging.New(logging.Options{
|
||
Dir: cfg.Log.DirPath(cfg.DataDir),
|
||
Level: cfg.Log.SlogLevel(),
|
||
MaxSizeMB: cfg.Log.MaxSizeMB,
|
||
KeepFiles: cfg.Log.KeepFiles,
|
||
})
|
||
defer func() { _ = closeLogs.Close() }()
|
||
|
||
logger := slog.New(logHandler)
|
||
slog.SetDefault(logger)
|
||
if dataDirFromFlag {
|
||
logger.Info("数据目录来自命令行 -data", "dataDir", cfg.DataDir)
|
||
}
|
||
|
||
projectName, projectSource, err := resolveProjectName(cfg.DataDir, *project)
|
||
if err != nil {
|
||
logger.Error("解析赛事项目失败", "err", err)
|
||
os.Exit(1)
|
||
}
|
||
// 显式指定过就写回记忆文件:下次不带 -project 启动(Console 就是这样拉起的)仍打开同一个赛事。
|
||
if projectSource == projectSourceFlag {
|
||
if err := httpapi.WriteActiveProject(cfg.DataDir, projectName); err != nil {
|
||
logger.Warn("写回赛事项目记忆失败,本次仍按 -project 打开", "err", err)
|
||
}
|
||
}
|
||
logger.Info("当前赛事项目", "project", projectName, "source", projectSource)
|
||
|
||
st, err := store.Open(cfg.DataDir)
|
||
if err != nil {
|
||
logger.Error("打开系统库失败", "err", err)
|
||
os.Exit(1)
|
||
}
|
||
defer func() { _ = st.Close() }()
|
||
|
||
if err := st.Migrate(); err != nil {
|
||
logger.Error("系统库迁移失败", "err", err)
|
||
os.Exit(1)
|
||
}
|
||
|
||
eventDB, err := openEventDB(cfg.DataDir, projectName)
|
||
if err != nil {
|
||
logger.Error("打开赛事库失败", "err", err)
|
||
os.Exit(1)
|
||
}
|
||
defer func() { _ = eventDB.Close() }()
|
||
if err := store.MigrateEvent(eventDB); err != nil {
|
||
logger.Error("赛事库迁移失败", "err", err)
|
||
os.Exit(1)
|
||
}
|
||
logger.Info("数据库就绪", "dataDir", cfg.DataDir, "project", projectName)
|
||
|
||
authSvc := auth.New(st.DB(), auth.Options{Logger: logger})
|
||
hub := realtime.NewHub(eventDB, logger)
|
||
hub.SetAllowedOrigins(cfg.Server.AllowedOrigins)
|
||
defer func() { _ = hub.Close() }()
|
||
|
||
// 可信代理:默认空,表示不采信任何代理头(见 devdocs/08 第 1 节)。
|
||
// 反向代理部署时用 SCOREBOARD_TRUSTED_PROXIES 指定代理 IP/CIDR,逗号分隔。
|
||
if raw := strings.TrimSpace(os.Getenv("SCOREBOARD_TRUSTED_PROXIES")); raw != "" {
|
||
if err := middleware.SetTrustedProxies(strings.Split(raw, ",")); err != nil {
|
||
logger.Error("可信代理配置非法", "err", err)
|
||
os.Exit(1)
|
||
}
|
||
}
|
||
|
||
ctx, stop := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGTERM)
|
||
defer stop()
|
||
|
||
if username, password, created, err := authSvc.EnsureDefaultAdmin(ctx); err != nil {
|
||
logger.Error("初始化默认管理员失败", "err", err)
|
||
os.Exit(1)
|
||
} else if created {
|
||
fmt.Print(initialAdminBanner(username, password))
|
||
logger.Warn("已创建默认管理员,初始密码仅在上方一次性输出,不写入日志", "username", username)
|
||
}
|
||
|
||
backupSvc := export.NewService(st.DB(), eventDB, filepath.Join(cfg.DataDir, "backups"), cfg.Backup.Keep, logger)
|
||
|
||
srv := &http.Server{
|
||
Addr: cfg.Server.Addr(),
|
||
Handler: httpapi.New(httpapi.Options{
|
||
Logger: logger,
|
||
Version: version,
|
||
System: st.DB(),
|
||
Event: eventDB,
|
||
Auth: authSvc,
|
||
DataDir: cfg.DataDir,
|
||
Backup: backupSvc,
|
||
// POST /api/shutdown 复用同一个关闭信号:取消 ctx 后走下面的 Shutdown + 关库。
|
||
Shutdown: stop,
|
||
ProjectDir: filepath.Join(cfg.DataDir, "event_projs", projectName),
|
||
Display: displaySender{hub: hub},
|
||
Realtime: hub,
|
||
WS: hub.Handler(),
|
||
}),
|
||
ReadHeaderTimeout: 10 * time.Second,
|
||
}
|
||
|
||
// 定时备份跟随服务端生命周期:收到退出信号(ctx 取消)即停止。
|
||
backupSvc.StartAuto(ctx, time.Duration(cfg.Backup.IntervalMinutes)*time.Minute)
|
||
|
||
go func() {
|
||
logger.Info("服务启动", "addr", srv.Addr, "version", version)
|
||
if err := srv.ListenAndServe(); err != nil && !errors.Is(err, http.ErrServerClosed) {
|
||
logger.Error("服务异常退出", "err", err)
|
||
os.Exit(1)
|
||
}
|
||
}()
|
||
|
||
<-ctx.Done()
|
||
|
||
logger.Info("正在关闭…")
|
||
// Console 的关闭握手要求 3 秒内完成,超时后仍会关库并退出(defer 顺序保证)。
|
||
shutdownCtx, cancel := context.WithTimeout(context.Background(), 3*time.Second)
|
||
defer cancel()
|
||
if err := srv.Shutdown(shutdownCtx); err != nil {
|
||
logger.Error("关闭超时", "err", err)
|
||
}
|
||
}
|
||
|
||
// initialAdminBanner 组装初始管理员提示块:初始密码只在这里一次性输出,不写入结构化日志。
|
||
// 末尾的纯 ASCII 锚供现场在 logs\console.log 里检索——中文 findstr 在 chcp 936/65001 下不可靠。
|
||
func initialAdminBanner(username, password string) string {
|
||
return fmt.Sprintf("\n========================================\n"+
|
||
" 已创建默认管理员\n 用户名: %s\n 初始密码: %s\n 首次登录后请立即修改密码\n"+
|
||
"=== INITIAL ADMIN CREATED (password above) ===\n"+
|
||
"========================================\n\n", username, password)
|
||
}
|
||
|
||
// displaySender 把 httpapi 的大屏命令接口适配到实时层。
|
||
type displaySender struct{ hub *realtime.Hub }
|
||
|
||
func (d displaySender) SendDisplayCommand(action string, payload any, targets []string) (int, error) {
|
||
cmd, err := realtime.NewDisplayCommand(action, payload)
|
||
if err != nil {
|
||
return 0, err
|
||
}
|
||
return d.hub.SendCommandToInstances(targets, cmd)
|
||
}
|
||
|
||
// 赛事项目名的来源,只用于启动日志:现场据此确认这次打开的是哪一个赛事。
|
||
const (
|
||
defaultProjectName = "default"
|
||
projectSourceFlag = "命令行 -project"
|
||
projectSourceFile = "记忆文件 " + httpapi.ActiveProjectFile
|
||
projectSourceDefault = "默认"
|
||
)
|
||
|
||
// resolveProjectName 按「显式 -project → 数据目录里的记忆文件 → default」确定当前赛事项目名。
|
||
// 只解析与校验、不落盘:写回记忆文件是服务端启动路径自己的事,backup / passwd 不该顺手改掉它。
|
||
func resolveProjectName(dataDir, flagName string) (name, source string, err error) {
|
||
if v := strings.TrimSpace(flagName); v != "" {
|
||
safe, err := export.SafeProjectName(v)
|
||
if err != nil {
|
||
return "", "", fmt.Errorf("赛事项目名 %q 非法: %w", v, err)
|
||
}
|
||
return safe, projectSourceFlag, nil
|
||
}
|
||
if remembered := httpapi.ReadActiveProject(dataDir); remembered != "" {
|
||
return remembered, projectSourceFile, nil
|
||
}
|
||
return defaultProjectName, projectSourceDefault, nil
|
||
}
|
||
|
||
// runBackup 实现 `scoreboard backup` 子命令:内置 VACUUM INTO,不依赖外部 sqlite3.exe。
|
||
func runBackup(args []string) error {
|
||
fs := flag.NewFlagSet("backup", flag.ExitOnError)
|
||
configPath := fs.String("config", "config.yaml", "配置文件路径")
|
||
project := fs.String("project", "", "赛事项目名;留空则用记住的上一次赛事,再没有就用 default")
|
||
reason := fs.String("reason", "manual", "备份原因:manual / publish / auto")
|
||
dataDir := fs.String("data", "", "数据目录;非空时覆盖配置文件里的 dataDir")
|
||
if err := fs.Parse(args); err != nil {
|
||
return err
|
||
}
|
||
|
||
cfg, err := config.Load(*configPath)
|
||
if err != nil {
|
||
return err
|
||
}
|
||
// 与服务端主命令同一语义:备份的必须是 Console 实际在用的那个数据目录。
|
||
cfg.ApplyDataDir(*dataDir)
|
||
// 项目名也按同一顺序解析:备份的必须是服务端当前打开的那个赛事库。
|
||
projectName, _, err := resolveProjectName(cfg.DataDir, *project)
|
||
if err != nil {
|
||
return err
|
||
}
|
||
dir := filepath.Join(cfg.DataDir, "backups")
|
||
if err := os.MkdirAll(dir, 0o755); err != nil {
|
||
return err
|
||
}
|
||
|
||
sysDB, err := openSQLite(filepath.Join(cfg.DataDir, "system.db"))
|
||
if err != nil {
|
||
return err
|
||
}
|
||
defer func() { _ = sysDB.Close() }()
|
||
if _, err := export.Backup(sysDB, export.BackupOptions{Dir: dir, Prefix: "system", Reason: *reason}); err != nil {
|
||
return err
|
||
}
|
||
|
||
evPath := filepath.Join(cfg.DataDir, "event_projs", projectName, "event.db")
|
||
if _, err := os.Stat(evPath); err == nil {
|
||
evDB, err := openSQLite(evPath)
|
||
if err != nil {
|
||
return err
|
||
}
|
||
defer func() { _ = evDB.Close() }()
|
||
// 前缀必须与 Service 一致:PruneBackups 只清理 <prefix>-*,用项目名会让 CLI 备份只增不减。
|
||
if _, err := export.Backup(evDB, export.BackupOptions{Dir: dir, Prefix: "event", Reason: *reason}); err != nil {
|
||
return err
|
||
}
|
||
}
|
||
|
||
items, err := export.ListBackups(dir, "")
|
||
if err != nil {
|
||
return err
|
||
}
|
||
fmt.Printf("备份完成:%s(现有 %d 份)\n", dir, len(items))
|
||
return nil
|
||
}
|
||
|
||
// openEventDB 打开(必要时创建)赛事库;store 包不持有赛事库连接,
|
||
// 由 main 负责生命周期,再交给 httpapi 与实时层使用。
|
||
func openEventDB(dataDir, project string) (*sql.DB, error) {
|
||
dir := filepath.Join(dataDir, "event_projs", project)
|
||
if err := os.MkdirAll(dir, 0o755); err != nil {
|
||
return nil, fmt.Errorf("创建赛事目录 %s: %w", dir, err)
|
||
}
|
||
return openSQLite(filepath.Join(dir, "event.db"))
|
||
}
|
||
|
||
func openSQLite(path string) (*sql.DB, error) {
|
||
dsn := "file:" + path +
|
||
"?_pragma=journal_mode(WAL)" +
|
||
"&_pragma=foreign_keys(1)" +
|
||
"&_pragma=busy_timeout(5000)"
|
||
|
||
db, err := sql.Open("sqlite", dsn)
|
||
if err != nil {
|
||
return nil, fmt.Errorf("打开数据库 %s: %w", path, err)
|
||
}
|
||
db.SetMaxOpenConns(1)
|
||
if err := db.Ping(); err != nil {
|
||
_ = db.Close()
|
||
return nil, fmt.Errorf("连接数据库 %s: %w", path, err)
|
||
}
|
||
return db, nil
|
||
}
|