2026-03-14 21:31:03 +01:00
|
|
|
package db
|
|
|
|
|
|
|
|
|
|
import (
|
2026-07-23 17:03:52 +02:00
|
|
|
"context"
|
2026-03-14 21:31:03 +01:00
|
|
|
"database/sql"
|
|
|
|
|
"errors"
|
|
|
|
|
"fmt"
|
2026-08-15 16:30:05 +02:00
|
|
|
"os"
|
2026-03-15 07:07:59 +01:00
|
|
|
"path/filepath"
|
|
|
|
|
"strings"
|
2026-07-19 15:43:46 +00:00
|
|
|
|
|
|
|
|
"github.com/owncord/server/db/dbgen"
|
2026-03-14 21:31:03 +01:00
|
|
|
)
|
|
|
|
|
|
2026-03-14 22:36:35 +01:00
|
|
|
// ─── Setup ───────────────────────────────────────────────────────────────────
|
|
|
|
|
|
|
|
|
|
// UserCount returns the total number of registered users.
|
2026-07-23 17:03:52 +02:00
|
|
|
func (d *DB) UserCount(ctx context.Context) (int64, error) {
|
|
|
|
|
count, err := d.q.UserCount(ctx)
|
2026-07-19 15:43:46 +00:00
|
|
|
if err != nil {
|
2026-03-14 22:36:35 +01:00
|
|
|
return 0, fmt.Errorf("UserCount: %w", err)
|
|
|
|
|
}
|
|
|
|
|
return count, nil
|
|
|
|
|
}
|
|
|
|
|
|
2026-03-14 21:31:03 +01:00
|
|
|
// ─── Server Stats ─────────────────────────────────────────────────────────────
|
|
|
|
|
|
|
|
|
|
// GetServerStats returns aggregate counts for the admin dashboard.
|
|
|
|
|
// DBSizeBytes is 0 for in-memory databases (page_count * page_size returns
|
|
|
|
|
// a meaningful value only for file-backed databases).
|
2026-07-23 17:03:52 +02:00
|
|
|
func (d *DB) GetServerStats(ctx context.Context) (*ServerStats, error) {
|
2026-03-14 21:31:03 +01:00
|
|
|
stats := &ServerStats{}
|
2026-07-19 15:43:46 +00:00
|
|
|
var err error
|
2026-03-14 21:31:03 +01:00
|
|
|
|
2026-07-23 17:03:52 +02:00
|
|
|
if stats.UserCount, err = d.q.CountUsers(ctx); err != nil {
|
2026-03-14 21:31:03 +01:00
|
|
|
return nil, fmt.Errorf("GetServerStats users: %w", err)
|
|
|
|
|
}
|
2026-07-23 17:03:52 +02:00
|
|
|
if stats.MessageCount, err = d.q.CountActiveMessages(ctx); err != nil {
|
2026-03-14 21:31:03 +01:00
|
|
|
return nil, fmt.Errorf("GetServerStats messages: %w", err)
|
|
|
|
|
}
|
2026-07-23 17:03:52 +02:00
|
|
|
if stats.ChannelCount, err = d.q.CountChannels(ctx); err != nil {
|
2026-03-14 21:31:03 +01:00
|
|
|
return nil, fmt.Errorf("GetServerStats channels: %w", err)
|
|
|
|
|
}
|
2026-07-23 17:03:52 +02:00
|
|
|
if stats.InviteCount, err = d.q.CountActiveInvites(ctx); err != nil {
|
2026-03-14 21:31:03 +01:00
|
|
|
return nil, fmt.Errorf("GetServerStats invites: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
2026-07-19 15:43:46 +00:00
|
|
|
// page_count * page_size gives the database size in bytes. PRAGMAs are not
|
|
|
|
|
// expressible as sqlc queries, so they stay on the raw connection.
|
2026-03-14 21:31:03 +01:00
|
|
|
// For :memory: databases this still works (returns the in-memory size).
|
2026-07-31 15:41:57 +02:00
|
|
|
// Both values are DB-wide, so reading them on the reader pool is fine.
|
2026-03-14 21:31:03 +01:00
|
|
|
var pageCount, pageSize int64
|
2026-07-31 15:41:57 +02:00
|
|
|
if err := d.reader.QueryRowContext(ctx, `PRAGMA page_count`).Scan(&pageCount); err != nil {
|
2026-03-14 21:31:03 +01:00
|
|
|
return nil, fmt.Errorf("GetServerStats page_count: %w", err)
|
|
|
|
|
}
|
2026-07-31 15:41:57 +02:00
|
|
|
if err := d.reader.QueryRowContext(ctx, `PRAGMA page_size`).Scan(&pageSize); err != nil {
|
2026-03-14 21:31:03 +01:00
|
|
|
return nil, fmt.Errorf("GetServerStats page_size: %w", err)
|
|
|
|
|
}
|
|
|
|
|
stats.DBSizeBytes = pageCount * pageSize
|
|
|
|
|
|
|
|
|
|
return stats, nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// ─── User Management ──────────────────────────────────────────────────────────
|
|
|
|
|
|
|
|
|
|
// ListAllUsers returns users joined with their role name, ordered by ID.
|
|
|
|
|
// limit=0 returns no rows.
|
2026-07-23 17:03:52 +02:00
|
|
|
func (d *DB) ListAllUsers(ctx context.Context, limit, offset int) ([]UserWithRole, error) {
|
|
|
|
|
rows, err := d.q.ListAllUsers(ctx, dbgen.ListAllUsersParams{
|
2026-07-19 15:43:46 +00:00
|
|
|
Limit: int64(limit),
|
|
|
|
|
Offset: int64(offset),
|
|
|
|
|
})
|
2026-03-14 21:31:03 +01:00
|
|
|
if err != nil {
|
|
|
|
|
return nil, fmt.Errorf("ListAllUsers: %w", err)
|
|
|
|
|
}
|
2026-07-19 15:43:46 +00:00
|
|
|
result := make([]UserWithRole, 0, len(rows))
|
|
|
|
|
for _, r := range rows {
|
|
|
|
|
result = append(result, UserWithRole{
|
|
|
|
|
User: User{
|
|
|
|
|
ID: r.ID,
|
|
|
|
|
Username: r.Username,
|
|
|
|
|
Avatar: r.Avatar,
|
|
|
|
|
RoleID: r.RoleID,
|
|
|
|
|
Status: r.Status,
|
|
|
|
|
CreatedAt: r.CreatedAt,
|
|
|
|
|
LastSeen: r.LastSeen,
|
|
|
|
|
Banned: r.Banned != 0,
|
|
|
|
|
BanReason: r.BanReason,
|
|
|
|
|
BanExpires: r.BanExpires,
|
|
|
|
|
},
|
|
|
|
|
RoleName: r.RoleName,
|
|
|
|
|
})
|
2026-03-14 21:31:03 +01:00
|
|
|
}
|
|
|
|
|
return result, nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// UpdateUserRole changes the role_id of a user.
|
2026-07-23 17:03:52 +02:00
|
|
|
func (d *DB) UpdateUserRole(ctx context.Context, userID, roleID int64) error {
|
|
|
|
|
if err := d.q.UpdateUserRole(ctx, dbgen.UpdateUserRoleParams{
|
2026-07-19 15:43:46 +00:00
|
|
|
RoleID: roleID,
|
|
|
|
|
ID: userID,
|
|
|
|
|
}); err != nil {
|
2026-03-14 21:31:03 +01:00
|
|
|
return fmt.Errorf("UpdateUserRole: %w", err)
|
|
|
|
|
}
|
|
|
|
|
return nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// ForceLogoutUser deletes all sessions for the given user ID.
|
2026-07-23 17:03:52 +02:00
|
|
|
func (d *DB) ForceLogoutUser(ctx context.Context, userID int64) error {
|
|
|
|
|
if err := d.q.ForceLogoutUser(ctx, userID); err != nil {
|
2026-03-14 21:31:03 +01:00
|
|
|
return fmt.Errorf("ForceLogoutUser: %w", err)
|
|
|
|
|
}
|
|
|
|
|
return nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// GetUserSessions returns all active sessions for the given user ID.
|
2026-07-23 17:03:52 +02:00
|
|
|
func (d *DB) GetUserSessions(ctx context.Context, userID int64) ([]Session, error) {
|
|
|
|
|
rows, err := d.q.GetUserSessions(ctx, userID)
|
2026-03-14 21:31:03 +01:00
|
|
|
if err != nil {
|
|
|
|
|
return nil, fmt.Errorf("GetUserSessions: %w", err)
|
|
|
|
|
}
|
2026-07-19 15:43:46 +00:00
|
|
|
sessions := make([]Session, 0, len(rows))
|
|
|
|
|
for _, s := range rows {
|
|
|
|
|
sessions = append(sessions, sessionFromGen(s))
|
2026-03-14 21:31:03 +01:00
|
|
|
}
|
|
|
|
|
return sessions, nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// ─── Channel Management (admin) ───────────────────────────────────────────────
|
|
|
|
|
|
|
|
|
|
// AdminCreateChannel creates a channel with full field control including position.
|
2026-07-19 15:43:46 +00:00
|
|
|
// No sqlc query covers this exact INSERT shape, so it stays on raw SQL.
|
2026-07-23 17:03:52 +02:00
|
|
|
func (d *DB) AdminCreateChannel(ctx context.Context, name, chanType, category, topic string, position int) (int64, error) {
|
2026-07-31 15:41:57 +02:00
|
|
|
res, err := d.writer.ExecContext(ctx,
|
2026-03-14 21:31:03 +01:00
|
|
|
`INSERT INTO channels (name, type, category, topic, position)
|
|
|
|
|
VALUES (?, ?, ?, ?, ?)`,
|
2026-07-19 15:43:46 +00:00
|
|
|
name, chanType, strToNullPtr(category), strToNullPtr(topic), position,
|
2026-03-14 21:31:03 +01:00
|
|
|
)
|
|
|
|
|
if err != nil {
|
|
|
|
|
return 0, fmt.Errorf("AdminCreateChannel: %w", err)
|
|
|
|
|
}
|
|
|
|
|
return res.LastInsertId()
|
|
|
|
|
}
|
|
|
|
|
|
2026-08-01 22:06:14 +02:00
|
|
|
// ChannelUpdate is the full set of mutable channel fields an admin edit writes.
|
|
|
|
|
//
|
|
|
|
|
// A struct rather than a positional argument list: the update covers nine
|
|
|
|
|
// fields now, four of them ints, and `AdminUpdateChannel(ctx, id, name, topic,
|
|
|
|
|
// category, slowMode, position, archived, nsfw, maxUsers, maxVideo)` invites
|
|
|
|
|
// exactly the silent transposition (slow mode into user limit) that no test
|
|
|
|
|
// would catch. Every field is written unconditionally, so callers must start
|
|
|
|
|
// from the channel's current values — the handler does, which is what makes a
|
|
|
|
|
// partial PATCH body safe.
|
|
|
|
|
type ChannelUpdate struct {
|
|
|
|
|
Name string
|
|
|
|
|
Topic string
|
|
|
|
|
Category string
|
|
|
|
|
SlowMode int
|
|
|
|
|
Position int
|
|
|
|
|
Archived bool
|
|
|
|
|
// NSFW is stored and broadcast only; it drives no server-side content
|
|
|
|
|
// behaviour (see migration 025).
|
|
|
|
|
NSFW bool
|
|
|
|
|
// VoiceMaxUsers / VoiceMaxVideo are the voice capacity limits the ws
|
|
|
|
|
// voice-join path already enforces (0 = unlimited). They are meaningless
|
|
|
|
|
// on a text channel but are still written there, because refusing them
|
|
|
|
|
// would make the value depend on a type that can never change anyway.
|
|
|
|
|
VoiceMaxUsers int
|
|
|
|
|
VoiceMaxVideo int
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// AdminUpdateChannel updates all mutable channel fields, category included —
|
|
|
|
|
// moving a channel between categories is a rename of free text, not a
|
|
|
|
|
// structural change, so it rides on the ordinary update.
|
|
|
|
|
func (d *DB) AdminUpdateChannel(ctx context.Context, id int64, u ChannelUpdate) error {
|
2026-07-23 17:03:52 +02:00
|
|
|
if err := d.q.AdminUpdateChannel(ctx, dbgen.AdminUpdateChannelParams{
|
2026-08-01 22:06:14 +02:00
|
|
|
Name: u.Name,
|
|
|
|
|
Topic: strToNullPtr(u.Topic),
|
|
|
|
|
Category: strToNullPtr(u.Category),
|
|
|
|
|
SlowMode: int64(u.SlowMode),
|
|
|
|
|
Position: int64(u.Position),
|
|
|
|
|
Archived: b2i64(u.Archived),
|
|
|
|
|
Nsfw: b2i64(u.NSFW),
|
|
|
|
|
VoiceMaxUsers: int64(u.VoiceMaxUsers),
|
|
|
|
|
VoiceMaxVideo: int64(u.VoiceMaxVideo),
|
|
|
|
|
ID: id,
|
2026-07-19 15:43:46 +00:00
|
|
|
}); err != nil {
|
2026-03-14 21:31:03 +01:00
|
|
|
return fmt.Errorf("AdminUpdateChannel: %w", err)
|
|
|
|
|
}
|
|
|
|
|
return nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// AdminDeleteChannel removes a channel by ID (cascades to messages, etc.).
|
2026-07-23 17:03:52 +02:00
|
|
|
func (d *DB) AdminDeleteChannel(ctx context.Context, id int64) error {
|
|
|
|
|
if err := d.q.DeleteChannel(ctx, id); err != nil {
|
2026-03-14 21:31:03 +01:00
|
|
|
return fmt.Errorf("AdminDeleteChannel: %w", err)
|
|
|
|
|
}
|
|
|
|
|
return nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// ─── Audit Log ────────────────────────────────────────────────────────────────
|
|
|
|
|
|
|
|
|
|
// LogAudit inserts an audit log entry.
|
2026-07-23 17:03:52 +02:00
|
|
|
func (d *DB) LogAudit(ctx context.Context, actorID int64, action, targetType string, targetID int64, detail string) error {
|
|
|
|
|
if err := d.q.LogAudit(ctx, dbgen.LogAuditParams{
|
2026-07-19 15:43:46 +00:00
|
|
|
ActorID: actorID,
|
|
|
|
|
Action: action,
|
|
|
|
|
TargetType: targetType,
|
|
|
|
|
TargetID: targetID,
|
|
|
|
|
Detail: detail,
|
|
|
|
|
}); err != nil {
|
2026-03-14 21:31:03 +01:00
|
|
|
return fmt.Errorf("LogAudit: %w", err)
|
|
|
|
|
}
|
|
|
|
|
return nil
|
|
|
|
|
}
|
|
|
|
|
|
2026-07-31 15:41:57 +02:00
|
|
|
// PersistAudits inserts a batch of audit entries in a single transaction with
|
|
|
|
|
// one prepared insert, so the audit writer's flush pays for one fsync instead
|
|
|
|
|
// of one per entry. Only the LogAudit-shaped fields are written — ID, ActorName
|
|
|
|
|
// and CreatedAt on the input rows are ignored (the id autoincrements, the
|
|
|
|
|
// created_at column defaults, and actor_name is a join product).
|
|
|
|
|
//
|
|
|
|
|
// Best-effort semantics mirror PersistEvents: if the batched transaction fails,
|
|
|
|
|
// it falls back to per-row inserts so the good rows still land. Returns the
|
|
|
|
|
// number of rows persisted and, when any row was lost, the first per-row error.
|
|
|
|
|
func (d *DB) PersistAudits(ctx context.Context, entries []AuditEntry) (int, error) {
|
|
|
|
|
if len(entries) == 0 {
|
|
|
|
|
return 0, nil
|
|
|
|
|
}
|
|
|
|
|
if err := d.persistAuditsTx(ctx, entries); err == nil {
|
|
|
|
|
return len(entries), nil
|
|
|
|
|
}
|
|
|
|
|
// Fallback: insert rows individually so one bad row doesn't drop the batch.
|
|
|
|
|
persisted := 0
|
|
|
|
|
var firstErr error
|
|
|
|
|
for _, e := range entries {
|
|
|
|
|
if err := d.LogAudit(ctx, e.ActorID, e.Action, e.TargetType, e.TargetID, e.Detail); err != nil {
|
|
|
|
|
if firstErr == nil {
|
|
|
|
|
firstErr = err
|
|
|
|
|
}
|
|
|
|
|
continue
|
|
|
|
|
}
|
|
|
|
|
persisted++
|
|
|
|
|
}
|
|
|
|
|
return persisted, firstErr
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// persistAuditsTx inserts all entries inside one transaction; any failure
|
|
|
|
|
// rolls the whole batch back.
|
|
|
|
|
func (d *DB) persistAuditsTx(ctx context.Context, entries []AuditEntry) error {
|
|
|
|
|
tx, err := d.writer.BeginTx(ctx, nil)
|
|
|
|
|
if err != nil {
|
|
|
|
|
return fmt.Errorf("PersistAudits begin tx: %w", err)
|
|
|
|
|
}
|
|
|
|
|
stmt, err := tx.PrepareContext(ctx,
|
|
|
|
|
`INSERT INTO audit_log (actor_id, action, target_type, target_id, detail) VALUES (?, ?, ?, ?, ?)`,
|
|
|
|
|
)
|
|
|
|
|
if err != nil {
|
|
|
|
|
_ = tx.Rollback()
|
|
|
|
|
return fmt.Errorf("PersistAudits prepare: %w", err)
|
|
|
|
|
}
|
|
|
|
|
defer func() { _ = stmt.Close() }()
|
|
|
|
|
for _, e := range entries {
|
|
|
|
|
if _, err := stmt.ExecContext(ctx, e.ActorID, e.Action, e.TargetType, e.TargetID, e.Detail); err != nil {
|
|
|
|
|
_ = tx.Rollback()
|
|
|
|
|
return fmt.Errorf("PersistAudits insert action %q: %w", e.Action, err)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
if err := tx.Commit(); err != nil {
|
|
|
|
|
return fmt.Errorf("PersistAudits commit: %w", err)
|
|
|
|
|
}
|
|
|
|
|
return nil
|
|
|
|
|
}
|
|
|
|
|
|
2026-03-14 21:31:03 +01:00
|
|
|
// GetAuditLog returns audit log entries ordered newest-first with pagination.
|
2026-07-23 17:03:52 +02:00
|
|
|
func (d *DB) GetAuditLog(ctx context.Context, limit, offset int) ([]AuditEntry, error) {
|
|
|
|
|
rows, err := d.q.GetAuditLog(ctx, dbgen.GetAuditLogParams{
|
2026-07-19 15:43:46 +00:00
|
|
|
Limit: int64(limit),
|
|
|
|
|
Offset: int64(offset),
|
|
|
|
|
})
|
2026-03-14 21:31:03 +01:00
|
|
|
if err != nil {
|
|
|
|
|
return nil, fmt.Errorf("GetAuditLog: %w", err)
|
|
|
|
|
}
|
2026-07-19 15:43:46 +00:00
|
|
|
entries := make([]AuditEntry, 0, len(rows))
|
|
|
|
|
for _, r := range rows {
|
|
|
|
|
entries = append(entries, AuditEntry{
|
|
|
|
|
ID: r.ID,
|
|
|
|
|
ActorID: r.ActorID,
|
|
|
|
|
ActorName: r.ActorName,
|
|
|
|
|
Action: r.Action,
|
|
|
|
|
TargetType: r.TargetType,
|
|
|
|
|
TargetID: r.TargetID,
|
|
|
|
|
Detail: r.Detail,
|
|
|
|
|
CreatedAt: r.CreatedAt,
|
|
|
|
|
})
|
2026-03-14 21:31:03 +01:00
|
|
|
}
|
|
|
|
|
return entries, nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// ─── Settings ─────────────────────────────────────────────────────────────────
|
|
|
|
|
|
|
|
|
|
// GetSetting returns the value for the given settings key.
|
|
|
|
|
// Returns an error (wrapping sql.ErrNoRows) when the key does not exist.
|
2026-07-23 17:03:52 +02:00
|
|
|
func (d *DB) GetSetting(ctx context.Context, key string) (string, error) {
|
|
|
|
|
value, err := d.q.GetSetting(ctx, key)
|
2026-03-14 21:31:03 +01:00
|
|
|
if errors.Is(err, sql.ErrNoRows) {
|
2026-03-21 10:08:44 +01:00
|
|
|
return "", fmt.Errorf("GetSetting: key %q: %w", key, ErrNotFound)
|
2026-03-14 21:31:03 +01:00
|
|
|
}
|
|
|
|
|
if err != nil {
|
|
|
|
|
return "", fmt.Errorf("GetSetting: %w", err)
|
|
|
|
|
}
|
|
|
|
|
return value, nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// SetSetting upserts a setting value for the given key.
|
2026-07-23 17:03:52 +02:00
|
|
|
func (d *DB) SetSetting(ctx context.Context, key, value string) error {
|
|
|
|
|
if err := d.q.SetSetting(ctx, dbgen.SetSettingParams{
|
2026-07-19 15:43:46 +00:00
|
|
|
Key: key,
|
|
|
|
|
Value: value,
|
|
|
|
|
}); err != nil {
|
2026-03-14 21:31:03 +01:00
|
|
|
return fmt.Errorf("SetSetting: %w", err)
|
|
|
|
|
}
|
|
|
|
|
return nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// GetAllSettings returns all settings as a key→value map.
|
2026-07-23 17:03:52 +02:00
|
|
|
func (d *DB) GetAllSettings(ctx context.Context) (map[string]string, error) {
|
|
|
|
|
rows, err := d.q.GetAllSettings(ctx)
|
2026-03-14 21:31:03 +01:00
|
|
|
if err != nil {
|
|
|
|
|
return nil, fmt.Errorf("GetAllSettings: %w", err)
|
|
|
|
|
}
|
2026-07-19 15:43:46 +00:00
|
|
|
result := make(map[string]string, len(rows))
|
|
|
|
|
for _, s := range rows {
|
|
|
|
|
result[s.Key] = s.Value
|
2026-03-14 21:31:03 +01:00
|
|
|
}
|
|
|
|
|
return result, nil
|
|
|
|
|
}
|
|
|
|
|
|
2026-03-29 21:31:18 +02:00
|
|
|
// CountUsersWithoutTOTP returns the number of non-banned users that do not
|
|
|
|
|
// currently have a confirmed TOTP secret.
|
2026-07-23 17:03:52 +02:00
|
|
|
func (d *DB) CountUsersWithoutTOTP(ctx context.Context) (int, error) {
|
|
|
|
|
count, err := d.q.CountUsersWithoutTOTP(ctx)
|
2026-03-29 21:31:18 +02:00
|
|
|
if err != nil {
|
|
|
|
|
return 0, fmt.Errorf("CountUsersWithoutTOTP: %w", err)
|
|
|
|
|
}
|
2026-07-19 15:43:46 +00:00
|
|
|
return int(count), nil
|
2026-03-29 21:31:18 +02:00
|
|
|
}
|
|
|
|
|
|
2026-03-14 21:31:03 +01:00
|
|
|
// ─── Backup ───────────────────────────────────────────────────────────────────
|
|
|
|
|
|
2026-03-15 07:07:59 +01:00
|
|
|
// BackupTo creates an online backup of the database using SQLite's VACUUM INTO.
|
|
|
|
|
// The destination path must not already exist.
|
|
|
|
|
//
|
|
|
|
|
// Security: VACUUM INTO does not support bind parameters, so the path is
|
|
|
|
|
// interpolated into SQL. To prevent injection we enforce two structural guards:
|
|
|
|
|
// 1. The path must resolve to a location under safeRoot (after filepath.Clean
|
|
|
|
|
// and filepath.Abs).
|
|
|
|
|
// 2. After structural validation, any single-quote, semicolon, double-dash,
|
|
|
|
|
// or null byte in the cleaned path causes rejection as defence-in-depth.
|
|
|
|
|
//
|
|
|
|
|
// The caller in handleBackup constructs the path from a hardcoded directory
|
|
|
|
|
// and a timestamp — no user input reaches this function.
|
2026-07-23 17:03:52 +02:00
|
|
|
func (d *DB) BackupTo(ctx context.Context, path string) error {
|
|
|
|
|
return d.BackupToSafe(ctx, path, filepath.Join("data", "backups"))
|
2026-03-15 07:07:59 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// BackupToSafe is the internal implementation that accepts an explicit safe
|
|
|
|
|
// root directory. Exported for testing with isolated directories.
|
2026-07-23 17:03:52 +02:00
|
|
|
func (d *DB) BackupToSafe(ctx context.Context, path, safeRoot string) error {
|
2026-03-15 07:07:59 +01:00
|
|
|
clean := filepath.Clean(path)
|
|
|
|
|
|
|
|
|
|
absRoot, err := filepath.Abs(safeRoot)
|
2026-03-14 21:31:03 +01:00
|
|
|
if err != nil {
|
2026-03-15 07:07:59 +01:00
|
|
|
return fmt.Errorf("BackupToSafe: resolving safe root: %w", err)
|
|
|
|
|
}
|
|
|
|
|
absClean, err := filepath.Abs(clean)
|
|
|
|
|
if err != nil {
|
|
|
|
|
return fmt.Errorf("BackupToSafe: resolving path: %w", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Structural guard: path must be under the safe root directory.
|
|
|
|
|
if !strings.HasPrefix(absClean, absRoot+string(filepath.Separator)) {
|
|
|
|
|
return fmt.Errorf("BackupToSafe: path %q is not under safe root %q", absClean, absRoot)
|
|
|
|
|
}
|
|
|
|
|
|
2026-03-29 12:35:04 +02:00
|
|
|
// Defence-in-depth: only allow safe characters (alphanumeric, path separators,
|
|
|
|
|
// hyphen, underscore, dot, space, colon, tilde). This is a strict allowlist —
|
|
|
|
|
// anything else is rejected to prevent SQL injection via the interpolated path.
|
2026-04-01 09:23:17 +02:00
|
|
|
for _, ch := range absClean {
|
2026-03-29 12:35:04 +02:00
|
|
|
switch {
|
|
|
|
|
case ch >= 'a' && ch <= 'z',
|
|
|
|
|
ch >= 'A' && ch <= 'Z',
|
|
|
|
|
ch >= '0' && ch <= '9',
|
|
|
|
|
ch == '/' || ch == '\\' || ch == '-' || ch == '_' || ch == '.' || ch == ' ' || ch == ':' || ch == '~':
|
|
|
|
|
// allowed (colon for Windows drive letters, tilde for temp paths)
|
|
|
|
|
default:
|
|
|
|
|
return fmt.Errorf("BackupToSafe: path contains forbidden character %q", string(ch))
|
2026-03-15 07:07:59 +01:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2026-03-29 12:35:04 +02:00
|
|
|
// Reject SQL comment sequences that could break the VACUUM INTO statement,
|
|
|
|
|
// even though individual hyphens are allowed for filenames.
|
2026-04-01 09:23:17 +02:00
|
|
|
if strings.Contains(absClean, "--") {
|
2026-03-29 12:35:04 +02:00
|
|
|
return fmt.Errorf("BackupToSafe: path contains forbidden sequence %q", "--")
|
|
|
|
|
}
|
|
|
|
|
|
2026-08-15 16:30:05 +02:00
|
|
|
// VACUUM INTO refuses to write over an existing destination on its own,
|
|
|
|
|
// but only after it has already created (and, on failure below, would
|
|
|
|
|
// otherwise abandon) the file. Check explicitly and return before the
|
|
|
|
|
// exec so the failure branch below can tell "this call created the file"
|
|
|
|
|
// (safe to remove) from "the file was already there" (a same-second
|
|
|
|
|
// timestamp collision, or an operator-chosen name) without ever deleting
|
|
|
|
|
// something that predates this call.
|
|
|
|
|
if _, statErr := os.Stat(absClean); statErr == nil {
|
|
|
|
|
return fmt.Errorf("BackupToSafe: destination %q already exists", absClean)
|
|
|
|
|
} else if !errors.Is(statErr, os.ErrNotExist) {
|
|
|
|
|
return fmt.Errorf("BackupToSafe: checking destination %q: %w", absClean, statErr)
|
|
|
|
|
}
|
|
|
|
|
|
2026-07-31 15:41:57 +02:00
|
|
|
_, err = d.writer.ExecContext(ctx, fmt.Sprintf("VACUUM INTO '%s'", absClean))
|
2026-03-15 07:07:59 +01:00
|
|
|
if err != nil {
|
2026-08-15 16:30:05 +02:00
|
|
|
// An interrupted VACUUM INTO (ENOSPC, EIO, a canceled/expired ctx, ...)
|
|
|
|
|
// leaves a truncated file at absClean. Since the existence check above
|
|
|
|
|
// already proved nothing was there before this call, whatever exists
|
|
|
|
|
// now was created by this exec and is safe to remove — leaving it
|
|
|
|
|
// behind would let handleListBackups offer a truncated, unrestorable
|
|
|
|
|
// .db as a normal backup (OC-0212).
|
|
|
|
|
_ = os.Remove(absClean)
|
2026-03-15 07:07:59 +01:00
|
|
|
return fmt.Errorf("BackupToSafe: %w", err)
|
2026-03-14 21:31:03 +01:00
|
|
|
}
|
|
|
|
|
return nil
|
|
|
|
|
}
|
2026-08-15 20:50:47 +02:00
|
|
|
|
|
|
|
|
// CheckBackupIntegrity opens the SQLite file at path read-only and runs
|
|
|
|
|
// PRAGMA integrity_check against it. It returns nil only when SQLite reports
|
|
|
|
|
// "ok". Use it to verify a backup right after it is written and again before
|
|
|
|
|
// it is restored over the live database — a truncated or corrupt file must
|
|
|
|
|
// never be presented (or accepted) as restorable.
|
|
|
|
|
//
|
|
|
|
|
// The path travels into a file: URI, so it is restricted with the same
|
|
|
|
|
// character allowlist BackupToSafe enforces; callers always pass paths that
|
|
|
|
|
// already passed that gate.
|
|
|
|
|
func CheckBackupIntegrity(ctx context.Context, path string) error {
|
|
|
|
|
abs, err := filepath.Abs(filepath.Clean(path))
|
|
|
|
|
if err != nil {
|
|
|
|
|
return fmt.Errorf("CheckBackupIntegrity: resolving path: %w", err)
|
|
|
|
|
}
|
|
|
|
|
if _, err := os.Stat(abs); err != nil {
|
|
|
|
|
return fmt.Errorf("CheckBackupIntegrity: %w", err)
|
|
|
|
|
}
|
|
|
|
|
conn, err := sql.Open("sqlite", "file:"+filepath.ToSlash(abs)+"?mode=ro&_pragma=busy_timeout(2000)")
|
|
|
|
|
if err != nil {
|
|
|
|
|
return fmt.Errorf("CheckBackupIntegrity: open: %w", err)
|
|
|
|
|
}
|
|
|
|
|
defer conn.Close() //nolint:errcheck
|
|
|
|
|
var result string
|
|
|
|
|
if err := conn.QueryRowContext(ctx, "PRAGMA integrity_check(10)").Scan(&result); err != nil {
|
|
|
|
|
return fmt.Errorf("CheckBackupIntegrity: %w", err)
|
|
|
|
|
}
|
|
|
|
|
if result != "ok" {
|
|
|
|
|
return fmt.Errorf("CheckBackupIntegrity: integrity_check reported %q", result)
|
|
|
|
|
}
|
|
|
|
|
return nil
|
|
|
|
|
}
|