Files
meshcore-analyzer/internal/users/proposals.go
T
efitenandClaude Opus 5.5 2456762179 feat: account data export and users.db backup (#2141)
A small follow-up to parts A to E of #2128: users can download all data
the instance holds about them, and the server backs up `users.db`.

Stacked on #2140. Review the commits after that branch.

## The situation

- An instance with accounts holds personal data, but a user has no way
to get a copy (GDPR articles 15 and 20). Self-delete already exists.
- `users.db` is the only file the server writes, and nothing backs it
up: `GET /api/backup` snapshots the analyzer database only.

## What this PR adds

**Data export.** `GET /api/account/export` and a "Download my data"
button on the account page give one JSON file with:
- the profile, including activation and a pending email change;
- sessions (times and user agent);
- synced settings, own proposals, notification prefs and watches;
- audit rows where the user is actor or target, with other accounts as
an id only;
- the mail log.

Password hash, session and link tokens and the unsubscribe token are
left out: they are credentials. Each export is audited as `user.export`.

**users.db backup**
- Daily `VACUUM INTO` snapshots through `internal/users`, on by default
when user management is on. They go to `backups/` next to `users.db`,
the 7 newest are kept, the directory is 0700 and the files 0600.
Rotation only touches `users-<timestamp>.db` files and never the
snapshot it just wrote. Config: `userManagement.backup {enabled, dir,
keep}`.
- `GET /api/admin/users-backup`: an admin downloads a fresh snapshot to
keep off the server; audited as `user.backup`.
- `docs/user-guide/accounts.md` gains a restore procedure. It covers
what a restore brings back (accounts deleted after the snapshot, old
passwords, revoked sessions) and how to clean that up afterwards.

Spec:
[`docs/specs/2026-10-08-account-export-and-users-backup-design.md`](https://github.com/efiten/CoreScope/blob/feat/account-export-backup/docs/specs/2026-10-08-account-export-and-users-backup-design.md).

## Verification

- `internal/users` with `-race` and the `cmd/server` suite pass locally,
30 new Go tests. The file-mode tests skip on Windows.
- `sh test-all.sh` exits 0; the XSS gate in diff mode passes.
- User-management E2E: 27 of 27 steps locally.
- On our production instance since 8 October 2026; the first snapshot
there was 143 kB.

## Not in this PR

- Importing an export into another instance.
- Off-site upload of the snapshots. The admin download covers that by
hand.

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-08 22:16:49 +02:00

309 lines
9.3 KiB
Go

package users
import (
"database/sql"
"errors"
"time"
)
// Proposals (docs/specs/2026-10-07-channel-proposals-design.md): one row per
// (kind, subject); a state change updates the row, history is in the audit log.
// KindHashtagChannel is the one proposal kind of this version. Subject is a
// name accepted by channel.ValidateHashtagName.
const KindHashtagChannel = "hashtag_channel"
type ProposalStatus string
const (
ProposalPending ProposalStatus = "pending"
ProposalApproved ProposalStatus = "approved"
ProposalRejected ProposalStatus = "rejected"
ProposalRevoked ProposalStatus = "revoked"
)
// Valid reports whether st is a known status.
func (st ProposalStatus) Valid() bool {
switch st {
case ProposalPending, ProposalApproved, ProposalRejected, ProposalRevoked:
return true
}
return false
}
type ProposalAction string
const (
ProposalApprove ProposalAction = "approve"
ProposalReject ProposalAction = "reject"
ProposalRevoke ProposalAction = "revoke"
)
var (
ErrProposalPending = errors.New("users: already proposed")
ErrProposalApproved = errors.New("users: already approved")
ErrProposalRejected = errors.New("users: proposal was rejected")
ErrProposalTransition = errors.New("users: action not allowed in the proposal's state")
ErrProposalUserLimit = errors.New("users: daily proposal limit reached")
ErrProposalPendingLimit = errors.New("users: pending proposal limit reached")
ErrProposalApprovedLimit = errors.New("users: approved proposal limit reached")
)
// ProposalListMax caps ListProposals and ProposalsByUser.
const ProposalListMax = 500
// Proposal is one row of the proposals table.
type Proposal struct {
ID int64
Kind string
Subject string
Status ProposalStatus
ProposerID *int64 // nil once the proposer's account is deleted
ReviewerID *int64
Note string // the reviewer's reason, shown to the proposer
CreatedAt time.Time
DecidedAt *time.Time
}
// ProposalLimits bound Propose. Zero means no limit.
type ProposalLimits struct {
MaxPending int // pending proposals of every kind
PerUserPerDay int // proposals one user created or re-opened in the last 24 hours
}
// ProposalFilter narrows ListProposals. Zero values mean "any".
type ProposalFilter struct {
Status ProposalStatus
Kind string
}
const proposalCols = `id, kind, subject, status, proposer_id, reviewer_id, note, created_at, decided_at`
func scanProposal(row rowScanner) (*Proposal, error) {
var p Proposal
var status string
var created int64
var proposer, reviewer, decided sql.NullInt64
if err := row.Scan(&p.ID, &p.Kind, &p.Subject, &status, &proposer, &reviewer, &p.Note, &created, &decided); err != nil {
if errors.Is(err, sql.ErrNoRows) {
return nil, ErrNotFound
}
return nil, err
}
p.Status = ProposalStatus(status)
p.ProposerID = nullableID(proposer)
p.ReviewerID = nullableID(reviewer)
p.CreatedAt = fromUnix(created)
p.DecidedAt = fromNullUnix(decided)
return &p, nil
}
func nullableID(v sql.NullInt64) *int64 {
if !v.Valid {
return nil
}
id := v.Int64
return &id
}
// Propose opens a proposal for (kind, subject) in one transaction. A revoked
// row becomes pending again under the new proposer; pending, approved and
// rejected rows refuse. Duplicates are checked before the limits, so a
// duplicate is reported as one.
func (s *Store) Propose(kind, subject string, userID int64, lim ProposalLimits) (*Proposal, error) {
tx, err := s.db.Begin()
if err != nil {
return nil, err
}
defer tx.Rollback()
now := unix(s.now())
cur, err := scanProposal(tx.QueryRow(`SELECT `+proposalCols+` FROM proposals WHERE kind = ? AND subject = ?`, kind, subject))
switch {
case errors.Is(err, ErrNotFound):
cur = nil
case err != nil:
return nil, err
case cur.Status == ProposalPending:
return nil, ErrProposalPending
case cur.Status == ProposalApproved:
return nil, ErrProposalApproved
case cur.Status == ProposalRejected:
return nil, ErrProposalRejected
}
if lim.PerUserPerDay > 0 {
var n int
if err := tx.QueryRow(`SELECT COUNT(*) FROM proposals WHERE proposer_id = ? AND created_at > ?`,
userID, now-secs(24*time.Hour)).Scan(&n); err != nil {
return nil, err
}
if n >= lim.PerUserPerDay {
return nil, ErrProposalUserLimit
}
}
if lim.MaxPending > 0 {
var n int
if err := tx.QueryRow(`SELECT COUNT(*) FROM proposals WHERE status = 'pending'`).Scan(&n); err != nil {
return nil, err
}
if n >= lim.MaxPending {
return nil, ErrProposalPendingLimit
}
}
var id int64
if cur == nil {
res, err := tx.Exec(`INSERT INTO proposals (kind, subject, status, proposer_id, created_at) VALUES (?, ?, 'pending', ?, ?)`,
kind, subject, userID, now)
if err != nil {
return nil, err
}
if id, err = res.LastInsertId(); err != nil {
return nil, err
}
} else {
id = cur.ID
if _, err := tx.Exec(`UPDATE proposals SET status = 'pending', proposer_id = ?, reviewer_id = NULL, note = '',
created_at = ?, decided_at = NULL WHERE id = ?`, userID, now, id); err != nil {
return nil, err
}
}
p, err := scanProposal(tx.QueryRow(`SELECT `+proposalCols+` FROM proposals WHERE id = ?`, id))
if err != nil {
return nil, err
}
return p, tx.Commit()
}
// Decide applies action in one transaction: approve and reject from
// pending, revoke from approved; anything else is ErrProposalTransition.
// Approve refuses with ErrProposalApprovedLimit when maxApproved (> 0)
// proposals of the same kind are approved already.
func (s *Store) Decide(id int64, action ProposalAction, reviewerID int64, note string, maxApproved int) (*Proposal, error) {
tx, err := s.db.Begin()
if err != nil {
return nil, err
}
defer tx.Rollback()
p, err := scanProposal(tx.QueryRow(`SELECT `+proposalCols+` FROM proposals WHERE id = ?`, id))
if err != nil {
return nil, err
}
var to ProposalStatus
switch {
case action == ProposalApprove && p.Status == ProposalPending:
to = ProposalApproved
case action == ProposalReject && p.Status == ProposalPending:
to = ProposalRejected
case action == ProposalRevoke && p.Status == ProposalApproved:
to = ProposalRevoked
default:
return nil, ErrProposalTransition
}
if to == ProposalApproved && maxApproved > 0 {
var n int
if err := tx.QueryRow(`SELECT COUNT(*) FROM proposals WHERE kind = ? AND status = 'approved'`, p.Kind).Scan(&n); err != nil {
return nil, err
}
if n >= maxApproved {
return nil, ErrProposalApprovedLimit
}
}
now := s.now()
if _, err := tx.Exec(`UPDATE proposals SET status = ?, reviewer_id = ?, note = ?, decided_at = ? WHERE id = ?`,
string(to), reviewerID, note, unix(now), id); err != nil {
return nil, err
}
if err := tx.Commit(); err != nil {
return nil, err
}
decided := fromUnix(unix(now))
p.Status, p.ReviewerID, p.Note, p.DecidedAt = to, &reviewerID, note, &decided
return p, nil
}
// ListProposals returns at most ProposalListMax proposals, newest first.
func (s *Store) ListProposals(f ProposalFilter) ([]Proposal, error) {
q := `SELECT ` + proposalCols + ` FROM proposals WHERE 1=1`
var args []any
if f.Status != "" {
q += ` AND status = ?`
args = append(args, string(f.Status))
}
if f.Kind != "" {
q += ` AND kind = ?`
args = append(args, f.Kind)
}
q += ` ORDER BY created_at DESC, id DESC LIMIT ?`
args = append(args, ProposalListMax)
return s.queryProposals(q, args...)
}
// ProposalsByUser returns the user's proposals, newest first, at most
// ProposalListMax.
func (s *Store) ProposalsByUser(userID int64) ([]Proposal, error) {
return s.proposalsByUser(userID, ProposalListMax)
}
// AllProposalsByUser is ProposalsByUser without the cap (the account export).
func (s *Store) AllProposalsByUser(userID int64) ([]Proposal, error) {
return s.proposalsByUser(userID, noLimit)
}
func (s *Store) proposalsByUser(userID int64, limit int) ([]Proposal, error) {
return s.queryProposals(`SELECT `+proposalCols+` FROM proposals WHERE proposer_id = ?
ORDER BY created_at DESC, id DESC LIMIT ?`, userID, limit)
}
func (s *Store) queryProposals(q string, args ...any) ([]Proposal, error) {
rows, err := s.db.Query(q, args...)
if err != nil {
return nil, err
}
defer rows.Close()
var out []Proposal
for rows.Next() {
p, err := scanProposal(rows)
if err != nil {
return nil, err
}
out = append(out, *p)
}
return out, rows.Err()
}
// ApprovedSubjects returns the approved subjects of kind, oldest decision
// first, at most limit (0 = all). Never nil. cmd/ingestor runs the same
// query as raw SQL (see ingestorApprovedQuery in proposals_test.go).
func (s *Store) ApprovedSubjects(kind string, limit int) ([]string, error) {
q := `SELECT subject FROM proposals WHERE kind = ? AND status = 'approved' ORDER BY decided_at, id`
args := []any{kind}
if limit > 0 {
q += ` LIMIT ?`
args = append(args, limit)
}
rows, err := s.db.Query(q, args...)
if err != nil {
return nil, err
}
defer rows.Close()
out := []string{}
for rows.Next() {
var subject string
if err := rows.Scan(&subject); err != nil {
return nil, err
}
out = append(out, subject)
}
return out, rows.Err()
}
// PruneProposals deletes rejected and revoked proposals decided more than
// maxAge ago. Pending and approved rows are kept however old they are.
func (s *Store) PruneProposals(maxAge time.Duration) (int64, error) {
res, err := s.db.Exec(`DELETE FROM proposals WHERE status IN ('rejected','revoked') AND decided_at < ?`,
unix(s.now())-secs(maxAge))
if err != nil {
return 0, err
}
return res.RowsAffected()
}