mirror of
https://github.com/J3vb/OwnCord.git
synced 2026-09-03 03:50:00 +03:00
* refactor(ws): split handleVoiceJoin into cohesive join-stage helpers handleVoiceJoin was 130 statements / cyclomatic 59 / nestif 11, breaking all three complexity budgets at once. Split along the stage boundaries the doc comment already described: precheck, leave-current, persist, restore moderator flags, grant token, complete. The publish-permission derivation becomes its own helper because it is the one branch-heavy block inside the token grant. Pure move: every statement is preserved verbatim. The only edits are bare `return`s becoming the typed returns of their new helper, `c.userID` becoming the `userID` parameter inside voiceJoinPublishPerms, and voiceJoinComplete re-reading `ch.VoiceMaxUsers` instead of receiving it — `ch` is never mutated, so the value is identical. Verified by normalising both revisions of the region to sorted, comment- and whitespace-stripped statements and diffing: the only deltas are the ones listed above. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> * refactor: collapse the three duplicated sibling pairs dupl flagged three pairs of adjacent near-identical functions. Each pair is now one parameterised implementation plus two thin, still-greppable wrappers. - ws/voice_controls.go: handleVoiceMuteV2 / handleVoiceDeafenV2 share voiceSelfToggleV2; handleVoiceCameraV2 / handleVoiceScreenshareV2 share voiceStreamToggleV2. Camera and screenshare drawing from one voice_max_video budget (OC-0023) was a bug caused by exactly this duplication drifting, so one body is the point, not a side effect. - db/mention_queries.go: ListMentionTargetsByRoles / ListMentionTargetsByUserIDs share listMentionTargets. The matched column is a closed named type (mentionTargetColumn) rather than a bare string, so the value interpolated into the SELECT cannot become caller-supplied. Behaviour is unchanged: every rate-limit key, error code, error string, slog message and slog key is preserved verbatim, including the two "failed to update <kind> state" messages, which are now assembled the same way enableVideoSlot already assembled them. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> * refactor(api): extract readEmojiUpload from handleCreateEmoji handleCreateEmoji was 101 lines against a 100-line budget. The upload-bytes stage — pull the file out of the parsed form, cap its size, sniff its MIME type and sniff its dimensions — is the one self-contained block in it, and it already wrote its own refusals, so it moves out whole as readEmojiUpload. The permission-before-parse ordering the doc comment calls out is unchanged; so is every error string. file.Close() now runs when the helper returns rather than when the handler does, which is strictly earlier and unobservable: the bytes are already copied into raw and nothing else touches the handle. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> * refactor: extract one cohesive block from three single-budget offenders Each of these was over exactly one budget, so each gets exactly one extraction rather than a restructure: - api/totp_handler.go handleVerifyTOTP (102 lines / 100): the block that resolves the user behind the partial-auth challenge and decrypts their TOTP secret becomes totpChallengeSecret. The ban-inside-the-partial-window check moves with it. - service/message_reactions.go handleReaction (cyclop 21 / 20): the whole authorisation chain — channel lookup, archived gate, DM participant and block checks, non-DM permission check — becomes reactionAudience, which also returns the DM fan-out audience it already resolved. Check order is unchanged and load-bearing. - db/admin_queries.go BackupToSafe (cyclop 21 / 20): the character allowlist loop and the SQL-comment rejection become validateBackupPathChars. That loop alone was most of the branch count. No error string, no check and no ordering changed. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> * refactor(plugin): split InstallFromZip into staged install helpers 104 statements / cyclomatic 44 / nestif 12. Split along the stages the code already had: installZipExtract (the per-entry write loop, with installZipEntryDest holding the mode/symlink/zip-slip guard chain and installZipWriteEntry the size-capped copy), installZipStagedManifest, installZipPromote, and installZipReactivate for the :399 nested block. Every zip-slip, symlink, entry-mode and uncompressed-size check is preserved in the same order relative to the writes it guards. The 19 inline `cleanup(); return` sites collapse to 4 in the orchestrator, one per stage, because each helper now returns an error instead of unwinding itself — the staging directory is still removed on exactly the same set of failures. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> * refactor(api): split newWAFMiddleware into engine build and per-phase helpers 184 lines / cyclomatic 38, and the request-body block at :382 was the worst nested site in the tree at nestif 17. Engine construction moves out of the closure (wafInlineEngine, wafCRSEngine — the Coraza directive string is lifted verbatim), and each request phase becomes its own helper: wafInlineRequestHeaders, wafCRSRequestHeaders (including the Host/Transfer-Encoding re-add for CRS 920280), wafFeedCRSBody and wafInspectRequestBody, which is the old :382 block. The three `handleWAFInterruption(w, it); return` sites inside the body block become one: the helper now returns the interruption and the orchestrator handles it. No statement runs between the two points on either side, so the verdict is honoured identically — in particular a CRS body interruption still returns without replacing r.Body. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> * refactor(service): split SendMessage and lift EditMessage's access check SendMessage was 79 statements / cyclomatic 35 with an 11-deep nested attachment block at :101; EditMessage was one point over cyclop. SendMessage becomes sendMessagePrecheck (permission and DM-block gates, content sanitisation), sendMessageLinkAttachments (the :101 block: attachment ownership, claim and link) and sendMessageDMSideEffects. EditMessage gets editMessageCheckAccess and nothing else — one budget over earns one extraction. The sanitizeContent fixpoint and the attachment ownership check are unchanged, as is the order of every gate. The DM side effects run behind `isDM && !s.sendMessageDMSideEffects(...)`, so a non-DM never enters them; inside, only the GetDMParticipantIDs failure returns false, matching the one error the original early-returned on. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> * refactor(admin): split handlePatchUser into per-field apply helpers 106 lines / cyclomatic 29, with the ban block at :154 nested 9 deep. Each optional field of the partial edit becomes its own helper — patchUserPrecheck, patchUserAuthorizeRole, patchUserApplyBan (the :154 block, including the session disconnect and the broadcast) and patchUserApplyRole. Each returns a bool meaning "keep going"; none of them writes a success response, so the single response site in the orchestrator is unchanged. Field application order, the permission-cache invalidation on a role change and the disconnect-and-broadcast on a ban are all preserved, as are the three fail-closed `mod == nil` guards, which now sit at the top of their own helper and still fire on exactly the same conditions. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> * refactor(admin): split handleSetup into first-run setup stages 143 lines / cyclomatic 30, with the optional-wizard block at :219 sitting exactly on the nestif threshold. Split into the stages the endpoint already had: request gating (rate limit and origin check, which run before any auth exists on a fresh server), owner account creation, and the wizard application that was the :219 block. Every gate in front of the handler is a security control on an unauthenticated endpoint; none moved relative to the work it protects. setup_wizard.go is untouched. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> * refactor: split run() into named bootstrap and shutdown steps 131 statements / cyclomatic 57, with the executable-path fallback at :126 nested 9 deep. The five anonymous `defer func(){...}()` blocks become named functions — telemetryStop, runClosePlugins, runStopEventPersistence, runStopAuditWriter, maintenanceStop — and the bootstrap stages move out likewise. Every defer is still registered in run() itself, at the same point in the sequence, so the LIFO teardown order is unchanged; that order is documented in the surrounding comments and is load-bearing (the audit-writer stop must follow database.Close's registration, the event-persistence stop must precede it). runStopEventPersistence is now registered unconditionally with a nil persister meaning "disabled", where the old code registered its defer inside the enabled branch — a no-op occupying that slot cannot change the relative order of the others. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> * refactor(ws): split handleReconnect into resume stages 77 statements / cyclomatic 41, plus the replay block at :199 and, in handleFreshConnect, the voice-state restore at :622. handleReconnect becomes reconnectPrecheck, reconnectSelectReplay (with reconnectVetColdTail for the cold-tier gap check), reconnectRegister and reconnectWriteReplay. handleFreshConnect's stale-voice cleanup moves to its own helper, where the `if h.livekit != nil` wrapper becomes a guard clause — that block was the tail of its scope, so returning early and falling off the end are the same. The parts that carry the invariants are moved verbatim: reconnectRegister still takes h.seqMu, still calls registerNow inside that same critical section (BUG-123 / OC-0206), still unlocks on every exit, and still emits the "full" tier counter and telemetry on each of its three re-check failures. handleReconnect's two-boolean contract is unchanged — the collapsed `return false, false` sites are all fall-through-to-full-ready, and the single `return true, false` is still the handshake-write-failure path whose teardown already ran (OC-0051). Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> * docs(server): fold in the adversarial review of the complexity refactors Eleven skeptic passes over the refactor commits on this branch found no blocker and no major — behaviour is preserved throughout. They did find comment and accuracy defects worth correcting: - db/mention_queries.go: the mentionTargetColumn rationale claimed the named type made the interpolated column "only ever one of the two constants". A Go named type is not closed, so that is a convention the type makes visible, not one it enforces. Reworded, gosec justification included. - ws/voice_controls.go: the dupl collapse generalised away three specifics — that a server deafen is the moderator's to lift (now on the serverDeafen field), the concrete voice_states.camera / voice_states.screenshare column names, and the half of the OC-0023 rationale about neither stream kind hiding from the other's count. All three restored. - ws/voice_join.go: `maxUsers := ch.VoiceMaxUsers` had been hoisted to the top of voiceJoinComplete, moving a read across the tail supersession guard. The read is inert, but it was the one statement in that commit whose position relative to a security guard changed; it now sits at its use, as before. - ws/*_test.go: three test comments cited voice_join.go line numbers that the split invalidated. They now cite the helper by name instead. - service/message_reactions.go: reactionAudience's doc claimed to enforce "every gate on reacting"; it enforces the channel-scoped ones, and the doc now says which gates stay with the caller. - api/emoji_handler.go: the readEmojiUpload call reused the outer `ok` from the auth check by assignment; it gets its own readOK. - admin/setup_handler.go: a moved comment kept a "the response above" deictic that no longer had a response above it. No behaviour change. Build, vet, full tests and -race on five packages green. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> * refactor(ws): clear the remaining complexity budgets across the hub Eight files, thirteen findings. Each function is split at the stages it already had; no branch is reordered, merged or inverted. - handlers.go handleMessage (cyclop 28, 88 stmts): session re-check, frame decode and result application become handleMessageSessionRecheck, handleMessageDecode and handleMessageApply. The V2 constructor lookup -> DispatchV2 -> Result resolution order is untouched. - serve_ready.go buildReady (cyclop 26, 61 stmts): the per-section fetches split out, readyChannelPayloads among them. Every visibility predicate is preserved verbatim — this is the payload that decides what a client may see. - serve_pumps.go writePump (cyclop 31): writePumpWrite, writePumpDeliver, writePumpDrainChannel and writePumpDrainAndClose. Every channel receive stays in the same select statement, so scheduling is unchanged. - hub_sweep.go sweepStaleVoiceStates (cyclop 22, 56 stmts): the staleness predicate, the hub-lock ordering and the position of the race hook are all as they were — handleVoiceJoin's BUG-088 ordering depends on them. - hub_broadcast.go channelReadAudienceImpl and RefreshChannelVisibility (cyclop 22 each, 57 stmts): channelReadAudienceDM and refreshChannelVisibilityCanSend. The audience predicate is the OC-0090 group-DM leak surface, so it is extracted, never simplified. - livekit_webhook.go (nestif 13 and 14): webhookJoinedEnforceVoiceState, webhookLeftCleanupClient and webhookLeftFinishLeave. DB delete still precedes broadcast on every path. - livekit_download.go EnsureLiveKitBinary (52 stmts): one extraction, ensureLiveKitStageBinary, keeping every archive path check intact. - voice_moderation.go (nestif 8): voiceModDeafenRollback. The persisted server_muted flag remains the authority. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> * refactor(api): clear the remaining complexity budgets across the HTTP layer - router.go NewRouter (cyclop 28, 84 stmts): split by wiring concern into routerTOTPKey, routerHealthDeps, routerMiddleware, routerUploadRoutes, routerPluginWiring, routerVoiceRoutes and routerMetricsRoutes. Middleware ORDER is a security property (auth before handler, WAF before body parse, rate limit before work) and is unchanged; the returned cleanup func still closes over and releases everything it did before. - auth_handler.go handleRegister (133 lines) and handleLogin (cyclop 21, 152 lines): registerPolicyGate, registerReadRequest, loginReadRequest and loginAuthenticate. The always-compare posture, every rate-limit key, every counter reset and the ban-check-versus-password-compare order are all preserved — including loginUserFailureThreshold staying unscaled by scaledAuthLimit, which is deliberate and commented. - upload_handler.go handleServeFile (cyclop 31, 128 lines): serveFileResolve and serveFileAuthorize. Every header this sets — Content-Disposition included, which is what stops a stored file being served as active content — is still set with the same value in the same circumstances. - profile_handler.go handleUploadAvatar (120 lines): avatarUploadReadImage, mirroring readEmojiUpload in shape but with the avatar caps and MIME set. The two deliberately do not share a helper. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> * refactor: clear the last complexity budgets in db and admin - db/account.go DeleteAccount (cyclop 28, 55 stmts): grouped by subsystem into deleteAccountAdminGuard, deleteAccountDMChannels and deleteAccountCloseDMChannels, each taking the same transaction. The transaction boundary, the delete ORDER (which foreign keys depend on) and the rollback path are unchanged. - admin/logstream.go handleLogStream (cyclop 24): logStreamAuthorize. Flush cadence, heartbeat and disconnect detection untouched. - admin/setup_wizard.go validateWizard (cyclop 23): grouped by section into wizardValidateIdentity, wizardValidateNetwork and wizardValidateMedia. Every message and bound is unchanged — this is the first input-validation boundary on a fresh server, before any auth exists. With this the tree is at zero: golangci-lint run reports 0 issues against the budgets set in #1384 (funlen 100/50, cyclop 20, nestif 8, dupl 150), with no //nolint and no exclusion added anywhere. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
476 lines
18 KiB
Go
476 lines
18 KiB
Go
package db
|
|
|
|
import (
|
|
"context"
|
|
"database/sql"
|
|
"errors"
|
|
"fmt"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
|
|
"github.com/owncord/server/db/dbgen"
|
|
)
|
|
|
|
// ─── Setup ───────────────────────────────────────────────────────────────────
|
|
|
|
// UserCount returns the total number of registered users.
|
|
func (d *DB) UserCount(ctx context.Context) (int64, error) {
|
|
count, err := d.q.UserCount(ctx)
|
|
if err != nil {
|
|
return 0, fmt.Errorf("UserCount: %w", err)
|
|
}
|
|
return count, nil
|
|
}
|
|
|
|
// ─── 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).
|
|
func (d *DB) GetServerStats(ctx context.Context) (*ServerStats, error) {
|
|
stats := &ServerStats{}
|
|
var err error
|
|
|
|
if stats.UserCount, err = d.q.CountUsers(ctx); err != nil {
|
|
return nil, fmt.Errorf("GetServerStats users: %w", err)
|
|
}
|
|
if stats.MessageCount, err = d.q.CountActiveMessages(ctx); err != nil {
|
|
return nil, fmt.Errorf("GetServerStats messages: %w", err)
|
|
}
|
|
if stats.ChannelCount, err = d.q.CountChannels(ctx); err != nil {
|
|
return nil, fmt.Errorf("GetServerStats channels: %w", err)
|
|
}
|
|
if stats.InviteCount, err = d.q.CountActiveInvites(ctx); err != nil {
|
|
return nil, fmt.Errorf("GetServerStats invites: %w", err)
|
|
}
|
|
|
|
// page_count * page_size gives the database size in bytes. PRAGMAs are not
|
|
// expressible as sqlc queries, so they stay on the raw connection.
|
|
// For :memory: databases this still works (returns the in-memory size).
|
|
// Both values are DB-wide, so reading them on the reader pool is fine.
|
|
var pageCount, pageSize int64
|
|
if err := d.reader.QueryRowContext(ctx, `PRAGMA page_count`).Scan(&pageCount); err != nil {
|
|
return nil, fmt.Errorf("GetServerStats page_count: %w", err)
|
|
}
|
|
if err := d.reader.QueryRowContext(ctx, `PRAGMA page_size`).Scan(&pageSize); err != nil {
|
|
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.
|
|
func (d *DB) ListAllUsers(ctx context.Context, limit, offset int) ([]UserWithRole, error) {
|
|
rows, err := d.q.ListAllUsers(ctx, dbgen.ListAllUsersParams{
|
|
Limit: int64(limit),
|
|
Offset: int64(offset),
|
|
})
|
|
if err != nil {
|
|
return nil, fmt.Errorf("ListAllUsers: %w", err)
|
|
}
|
|
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,
|
|
})
|
|
}
|
|
return result, nil
|
|
}
|
|
|
|
// UpdateUserRole changes the role_id of a user.
|
|
func (d *DB) UpdateUserRole(ctx context.Context, userID, roleID int64) error {
|
|
if err := d.q.UpdateUserRole(ctx, dbgen.UpdateUserRoleParams{
|
|
RoleID: roleID,
|
|
ID: userID,
|
|
}); err != nil {
|
|
return fmt.Errorf("UpdateUserRole: %w", err)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// ForceLogoutUser deletes all sessions for the given user ID.
|
|
func (d *DB) ForceLogoutUser(ctx context.Context, userID int64) error {
|
|
if err := d.q.ForceLogoutUser(ctx, userID); err != nil {
|
|
return fmt.Errorf("ForceLogoutUser: %w", err)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// GetUserSessions returns all active sessions for the given user ID.
|
|
func (d *DB) GetUserSessions(ctx context.Context, userID int64) ([]Session, error) {
|
|
rows, err := d.q.GetUserSessions(ctx, userID)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("GetUserSessions: %w", err)
|
|
}
|
|
sessions := make([]Session, 0, len(rows))
|
|
for _, s := range rows {
|
|
sessions = append(sessions, sessionFromGen(s))
|
|
}
|
|
return sessions, nil
|
|
}
|
|
|
|
// ─── Channel Management (admin) ───────────────────────────────────────────────
|
|
|
|
// AdminCreateChannel creates a channel with full field control including position.
|
|
// No sqlc query covers this exact INSERT shape, so it stays on raw SQL.
|
|
func (d *DB) AdminCreateChannel(ctx context.Context, name, chanType, category, topic string, position int) (int64, error) {
|
|
res, err := d.writer.ExecContext(ctx,
|
|
`INSERT INTO channels (name, type, category, topic, position)
|
|
VALUES (?, ?, ?, ?, ?)`,
|
|
name, chanType, strToNullPtr(category), strToNullPtr(topic), position,
|
|
)
|
|
if err != nil {
|
|
return 0, fmt.Errorf("AdminCreateChannel: %w", err)
|
|
}
|
|
return res.LastInsertId()
|
|
}
|
|
|
|
// 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 {
|
|
if err := d.q.AdminUpdateChannel(ctx, dbgen.AdminUpdateChannelParams{
|
|
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,
|
|
}); err != nil {
|
|
return fmt.Errorf("AdminUpdateChannel: %w", err)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// AdminDeleteChannel removes a channel by ID (cascades to messages, etc.).
|
|
func (d *DB) AdminDeleteChannel(ctx context.Context, id int64) error {
|
|
if err := d.q.DeleteChannel(ctx, id); err != nil {
|
|
return fmt.Errorf("AdminDeleteChannel: %w", err)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// ─── Audit Log ────────────────────────────────────────────────────────────────
|
|
|
|
// LogAudit inserts an audit log entry.
|
|
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{
|
|
ActorID: actorID,
|
|
Action: action,
|
|
TargetType: targetType,
|
|
TargetID: targetID,
|
|
Detail: detail,
|
|
}); err != nil {
|
|
return fmt.Errorf("LogAudit: %w", err)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// 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
|
|
}
|
|
|
|
// GetAuditLog returns audit log entries ordered newest-first with pagination.
|
|
func (d *DB) GetAuditLog(ctx context.Context, limit, offset int) ([]AuditEntry, error) {
|
|
rows, err := d.q.GetAuditLog(ctx, dbgen.GetAuditLogParams{
|
|
Limit: int64(limit),
|
|
Offset: int64(offset),
|
|
})
|
|
if err != nil {
|
|
return nil, fmt.Errorf("GetAuditLog: %w", err)
|
|
}
|
|
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,
|
|
})
|
|
}
|
|
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.
|
|
func (d *DB) GetSetting(ctx context.Context, key string) (string, error) {
|
|
value, err := d.q.GetSetting(ctx, key)
|
|
if errors.Is(err, sql.ErrNoRows) {
|
|
return "", fmt.Errorf("GetSetting: key %q: %w", key, ErrNotFound)
|
|
}
|
|
if err != nil {
|
|
return "", fmt.Errorf("GetSetting: %w", err)
|
|
}
|
|
return value, nil
|
|
}
|
|
|
|
// SetSetting upserts a setting value for the given key.
|
|
func (d *DB) SetSetting(ctx context.Context, key, value string) error {
|
|
if err := d.q.SetSetting(ctx, dbgen.SetSettingParams{
|
|
Key: key,
|
|
Value: value,
|
|
}); err != nil {
|
|
return fmt.Errorf("SetSetting: %w", err)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// GetAllSettings returns all settings as a key→value map.
|
|
func (d *DB) GetAllSettings(ctx context.Context) (map[string]string, error) {
|
|
rows, err := d.q.GetAllSettings(ctx)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("GetAllSettings: %w", err)
|
|
}
|
|
result := make(map[string]string, len(rows))
|
|
for _, s := range rows {
|
|
result[s.Key] = s.Value
|
|
}
|
|
return result, nil
|
|
}
|
|
|
|
// CountUsersWithoutTOTP returns the number of non-banned users that do not
|
|
// currently have a confirmed TOTP secret.
|
|
func (d *DB) CountUsersWithoutTOTP(ctx context.Context) (int, error) {
|
|
count, err := d.q.CountUsersWithoutTOTP(ctx)
|
|
if err != nil {
|
|
return 0, fmt.Errorf("CountUsersWithoutTOTP: %w", err)
|
|
}
|
|
return int(count), nil
|
|
}
|
|
|
|
// ─── Backup ───────────────────────────────────────────────────────────────────
|
|
|
|
// 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.
|
|
func (d *DB) BackupTo(ctx context.Context, path string) error {
|
|
return d.BackupToSafe(ctx, path, filepath.Join("data", "backups"))
|
|
}
|
|
|
|
// BackupToSafe is the internal implementation that accepts an explicit safe
|
|
// root directory. Exported for testing with isolated directories.
|
|
func (d *DB) BackupToSafe(ctx context.Context, path, safeRoot string) error {
|
|
clean := filepath.Clean(path)
|
|
|
|
absRoot, err := filepath.Abs(safeRoot)
|
|
if err != nil {
|
|
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)
|
|
}
|
|
|
|
if err := validateBackupPathChars(absClean); err != nil {
|
|
return err
|
|
}
|
|
|
|
// 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)
|
|
}
|
|
|
|
_, err = d.writer.ExecContext(ctx, fmt.Sprintf("VACUUM INTO '%s'", absClean))
|
|
if err != nil {
|
|
// 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)
|
|
return fmt.Errorf("BackupToSafe: %w", err)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// validateBackupPathChars is the strict character gate BackupToSafe applies to
|
|
// the destination before it is interpolated into VACUUM INTO. It is a separate
|
|
// function only so the allowlist loop's branch count does not dominate its
|
|
// caller; the rules and the messages are unchanged.
|
|
func validateBackupPathChars(absClean string) error {
|
|
// 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.
|
|
for _, ch := range absClean {
|
|
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))
|
|
}
|
|
}
|
|
|
|
// Reject SQL comment sequences that could break the VACUUM INTO statement,
|
|
// even though individual hyphens are allowed for filenames.
|
|
if strings.Contains(absClean, "--") {
|
|
return fmt.Errorf("BackupToSafe: path contains forbidden sequence %q", "--")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// 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
|
|
}
|