Files
pad/internal/server/server.go
T
xarmian 48323e229e feat(admin): GET /admin/users/{id}/metrics windowed engagement metrics (TASK-1547) (#602)
Final backend task for PLAN-1542. Returns three engagement signals that
power the metric tiles on the admin user modal's Overview tab (T1553):

- days_since_write: derived from users.last_write_at (T1543). nil when
  the user has never had a write recorded.

- writes_7d: COUNT of write-class activities (created/updated/archived/
  restored/moved/commented) authored in the last 7 days.

- collections_touched_30d: COUNT(DISTINCT collection_id) of items the
  user has authored writes for in the last 30 days. Goes through
  activities.user_id (not items.last_modified_by, which is an attribution
  string — see T1543's architecture note).

api_requests_7d is intentionally NOT included; no per-request log exists.
Filed as a follow-up (IDEA-1556) that will add this as an additive,
non-breaking field once the request-log table lands.

Implementation:

- Store.GetUserMetrics in users.go runs three small queries: scalar
  SELECT for last_write_at, one COUNT(*) over activities, and a
  JOIN(activities, items) for the DISTINCT collection count. All
  three are index-backed (idx_activities_user from migration 022).

- No caching layer in this PR. The queries are cheap, and a per-user
  short cache fits more naturally at the handler boundary if needed —
  premature here.

- Handler handleAdminGetUserMetrics wired at GET /admin/users/{userID}/metrics.
  requireAdmin gate; 404 on missing user.

Tests: TestGetUserMetrics seeds a workspace with two collections, six
activities (five inside 7d, one ancient outside both windows), verifies
all three metrics. TestGetUserMetricsEmptyUser covers the no-activity
case (nil days_since_write, zero counts, no error).
2026-05-20 17:13:28 -04:00

1940 lines
80 KiB
Go
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
package server
import (
"bytes"
"context"
"crypto/subtle"
"encoding/base64"
"encoding/json"
"fmt"
"io/fs"
"log/slog"
"net"
"net/http"
"net/url"
"strings"
"sync"
"time"
"github.com/go-chi/chi/v5"
chimiddleware "github.com/go-chi/chi/v5/middleware"
"github.com/go-chi/cors"
"github.com/prometheus/client_golang/prometheus/promhttp"
"github.com/PerpetualSoftware/pad/internal/attachments"
"github.com/PerpetualSoftware/pad/internal/billing"
"github.com/PerpetualSoftware/pad/internal/collab"
"github.com/PerpetualSoftware/pad/internal/email"
"github.com/PerpetualSoftware/pad/internal/events"
"github.com/PerpetualSoftware/pad/internal/metrics"
"github.com/PerpetualSoftware/pad/internal/models"
"github.com/PerpetualSoftware/pad/internal/oauth"
"github.com/PerpetualSoftware/pad/internal/store"
"github.com/PerpetualSoftware/pad/internal/webhooks"
)
type Server struct {
store *store.Store
router *chi.Mux
routerOnce sync.Once // ensures setupRouter runs once, after all config
httpServer *http.Server // underlying HTTP server (set during ListenAndServe)
webFS fs.FS // embedded web UI static files (optional)
events events.EventBus // real-time event bus (optional)
collab *collab.RoomManager // Yjs collab room manager (PLAN-1248); optional
webhooks *webhooks.Dispatcher // webhook dispatcher (optional)
email *email.Sender // transactional email sender (optional)
emailAPIKey string // Maileroo API key (used for unsubscribe HMAC)
rateLimiters *RateLimiters // per-endpoint rate limiters
baseURL string // public base URL for generating links (e.g. invite URLs)
corsOrigins string // comma-separated CORS origins (empty = localhost defaults)
secureCookies bool // set Secure flag on cookies (for TLS deployments)
metrics *metrics.Metrics // Prometheus metrics (optional)
metricsToken string // shared bearer token for /metrics scrapes ("" = loopback-only)
trustedProxyCIDRs []*net.IPNet // CIDRs allowed to set X-Forwarded-For (nil = proxy headers untrusted)
ipChangeEnforceStrict bool // when true, reject sessions whose client IP differs from the one recorded at session creation
sseMaxConnections int // global SSE connection limit (0 = unlimited)
sseMaxPerWorkspace int // per-workspace SSE connection limit (0 = unlimited)
cloudMode bool // true when running as Pad Cloud (PAD_CLOUD=true or PAD_MODE=cloud)
cloudSecrets []string // shared secrets for sidecar ↔ pad communication (supports rotation)
cloudSidecar CloudSidecar // reverse pad → pad-cloud client (e.g. Stripe cancel on account delete); nil = not configured
version string // release version (e.g. "dev", "1.2.3")
commit string // git commit hash
buildTime string // build timestamp
twoFAChallengeSecret []byte // HMAC key for 2FA challenge tokens
// Attachments storage. Wired via SetAttachments at startup; nil-checked
// by handlers so a server constructed for a test that doesn't need
// uploads still compiles and serves every other endpoint.
attachments *attachments.Registry
attachmentMaxBytes int64 // per-file upload cap; 0 = use defaultAttachmentMaxBytes
// Image processor used by the upload handler to derive thumbnail
// variants (TASK-878) and by the editor's rotate / crop tools
// (TASK-879/880). Wired via SetImageProcessor; nil-checked by
// callers so a server without image processing — e.g. a self-host
// build that doesn't want the dependency — still serves every
// other endpoint and stores originals untouched.
imageProcessor attachments.Processor
// MCP Streamable HTTP transport (PLAN-943 TASK-950). Wired via
// SetMCPTransport at startup when the deployment is in cloud mode.
// nil on self-hosted deployments and on any cloud build that hasn't
// constructed the MCP server yet — registerMCPRoutes nil-checks so
// the routes don't mount in either case. See handlers_mcp.go.
mcpTransport http.Handler
mcpPublicURL string // canonical public URL of the MCP vhost (e.g. https://mcp.getpad.dev)
mcpAuthServerURL string // canonical URL of the OAuth auth server (e.g. https://app.getpad.dev), TASK-951
// OAuth 2.1 authorization server (PLAN-943 TASK-1024 sub-PR B,
// HTTP handlers in TASK-1025 sub-PR C). Wired via SetOAuthServer
// at startup when the deployment is in cloud mode + has the
// fosite-backed server constructed. nil disables the OAuth
// surface — registerOAuthRoutes nil-checks so the routes don't
// mount on self-hosted deployments. See handlers_oauth.go.
oauthServer *oauth.Server
// claimSecret is the HMAC key for stateless 6-digit claim codes
// (PLAN-1519 / TASK-1521 / IDEA-1517 §4). Wired by SetClaimSecret
// at startup — production reuses the deployment's 32-byte
// encryption key (cfg.EncryptionKey) since both are server-
// stable secrets with equivalent rotation cadence. nil/short →
// /api/v1/oauth/claim returns 412 "claim_disabled" on every
// request, surfacing a clear misconfiguration signal rather than
// silently accepting forgeable codes.
claimSecret []byte
// oauthMetricsWired records whether wireOAuthMetricsObserver has
// already attached the active-tokens callback collector. Re-
// registering would panic via prometheus.MustRegister, so the flag
// guards the one-shot registration. The TTL observer side is
// idempotent (just a function-pointer set) and runs unconditionally.
oauthMetricsWired bool
// MCP audit log async writer (PLAN-943 TASK-960). Spawned by
// startMCPAuditWriter at startup when MCP is wired; shut down
// from Server.Stop. nil-safe: every audit-emitting code path
// nil-checks so MCP-less builds + tests that don't start the
// writer still work. See middleware_mcp_audit.go.
mcpAudit *mcpAuditWriter
// MCP session tracker (PLAN-943 TASK-1120). Replaces the naive
// +1/-1 active-sessions accounting from TASK-961. Wired by
// startMCPSessionTracker (called from SetMCPTransport in cloud
// mode); shut down from Server.Stop alongside the audit writer.
// nil-safe: trackMCPSession + the gauge-update path both
// nil-check so non-cloud builds + tests run without the tracker.
// See middleware_mcp_session.go.
mcpSessions *mcpSessionTracker
mcpSessionTTL time.Duration // 0 → defaultMCPSessionTTL
mcpSessionSweepInterval time.Duration // 0 → defaultMCPSessionSweepInterval
// storageInfoCache memoizes per-workspace storage usage summaries
// behind a short TTL (storageInfoTTL). Reduces DB load on the
// Settings → Storage page and quota-aware UI surfaces. Initialized
// in newServer; never nil so handlers can call get/set without
// guarding.
storageInfoCache *storageInfoCache
// importBundleMaxBytes caps a single workspace import bundle.
// 0 → defaultImportBundleMaxBytes (2 GiB). Set via
// SetImportBundleMaxBytes from cmd/pad/main.go using the
// PAD_IMPORT_BUNDLE_MAX_BYTES env var so operators with larger
// exports can opt in without recompiling.
importBundleMaxBytes int64
// orphanGC holds the periodic-sweep config + lifecycle for the
// attachment orphan garbage collector (TASK-886). Configured via
// SetOrphanGCConfig and started via StartOrphanGC. Stop() signals
// the loop to exit and waits for it via the bg WaitGroup.
orphanGC orphanGCConfig
// opLogGC holds the periodic-sweep config + lifecycle for the
// Yjs op-log prune sweeper (TASK-1309). Mirrors orphanGC's
// pattern. Configured via SetOpLogGCConfig + started via
// StartOpLogGC; Stop() signals the loop via stopOpLogGC.
opLogGC opLogGCConfig
// inFlightUploadHashes tracks content_hash values for uploads
// that have called AttachmentStore.Put but not yet inserted the
// attachments row. Without this, the orphan GC could delete a
// blob between Put and CreateAttachment, leaving a live row that
// references a missing blob (Codex P2 on PR #307 round 1).
//
// A plain map + mutex rather than sync.Map: counters need
// atomic-with-delete semantics (decrement-then-delete-if-zero
// must be one critical section, not two — sync.Map.CompareAndDelete
// addresses the entry but not the inc/dec interleaving). Codex
// P1 round 2 caught the prior sync.Map version racing on
// release-vs-reload of the same hash.
inFlightHashesMu sync.Mutex
inFlightHashes map[string]int64
// bg tracks fire-and-forget goroutines spawned by request handlers
// (TouchUserActivity in middleware_auth, async email sends, etc.) so
// the server can drain them before shutdown / test cleanup. Without
// this, tests using t.TempDir() race the still-running goroutine's
// SQLite WAL write against TempDir RemoveAll, leaving "directory not
// empty" cleanup errors in CI. See BUG-842.
bg sync.WaitGroup
// First-run bootstrap token (TASK-1167 / PLAN-1166). When non-empty,
// handleBootstrap accepts the value via the X-Bootstrap-Token header
// from non-loopback peers (self-host mode only — cloud mode never
// loads or honors a token, D2/D10). Wired at startup via
// SetBootstrapToken; cleared by consumeBootstrapToken after the first
// admin is created.
//
// The mutex protects the token field AND the entire validate-token →
// check-UserCount → CreateUser → consume sequence in handleBootstrap.
// Two simultaneous valid-token requests with different emails would
// otherwise create two admins from one token (F5). Bootstrap happens
// once per install, so the contention window is irrelevant.
bootstrapMu sync.Mutex
bootstrapToken string
bootstrapTokenPath string
// bypassSetupToken, when true, allows the first-admin bootstrap POST to
// succeed from any IP without an X-Bootstrap-Token header — i.e. the
// /setup form on the web UI works directly, without the operator having
// to copy a token out of `docker logs`. Wired from PAD_BYPASS_SETUP_TOKEN
// at startup via SetBypassSetupToken (cmd/pad/main.go).
//
// Self-host only — cloud mode IGNORES this flag entirely (D2/D10 from
// the original logs-token design: cloud bootstrap stays loopback-only).
// The UserCount==0 gate in handleBootstrap is unchanged: once the first
// admin exists, the bootstrap endpoint returns 409 "already initialized"
// regardless of bypass. This matches the operator's mental model — the
// flag opens up the *first-run* surface, not registration in general.
//
// Operators on trusted networks (Unraid LAN, Tailscale-only deployments,
// homelabs behind a firewall) typically prefer this; operators with
// public exposure should leave it off and use the logs-token path.
bypassSetupToken bool
}
// goAsync spawns fn in a goroutine that's tracked by s.bg, so Stop() can
// wait for in-flight background work to finish. Use this for any
// fire-and-forget work that touches the database, filesystem, or external
// services from inside a request handler — never bare `go func() {...}()`.
func (s *Server) goAsync(fn func()) {
s.bg.Add(1)
go func() {
defer s.bg.Done()
fn()
}()
}
// Stop waits for all background goroutines started via goAsync to finish
// AND drains the rate-limiter cleanup goroutines spawned at construction
// time (BUG-851). Safe to call multiple times. Should be called before
// Store.Close() so in-flight DB writes don't race a closed connection
// (or worse, the SQLite -wal/-shm file removal in t.TempDir cleanup).
func (s *Server) Stop() {
// Signal long-running background loops (orphan GC, etc.) to exit.
// Each loop registers itself on s.bg, so the Wait() below blocks
// until they actually finish and any in-flight goroutines drain.
s.stopOrphanGC()
// Yjs op-log prune sweeper (TASK-1309). Same lifecycle pattern;
// signals BEFORE Wait() so the goroutine sees the close and exits.
s.stopOpLogGC()
// MCP audit writer / sweeper run on s.bg too. Signal first so
// the workers see the close BEFORE Wait() blocks; without the
// signal Wait would hang forever on the writer's blocking
// queue receive.
s.stopMCPAuditWriter()
// MCP session tracker (TASK-1120) runs its sweeper on s.bg too.
// Order with the audit writer doesn't matter — both are
// independent goroutines; we just need the close BEFORE Wait().
s.stopMCPSessionTracker()
// Close the collab room manager BEFORE bg.Wait() so any in-flight
// op-log GC sweep (TASK-1309) blocked on a per-item lock behind
// an active Join can drain. collab.Close() tears down the Joins
// (their WS readLoops return, runConn unwinds, itemLocks
// release), which unblocks the GC's per-item PruneItemOpLogIfDormantBefore
// call. Without this ordering, Stop() can deadlock: GC waits on
// itemLock; Join holds itemLock until WS closes; WS only closes
// when collab.Close() runs; collab.Close() only runs after
// bg.Wait(); bg.Wait() never returns because GC is stuck.
// Per Codex review of TASK-1309 [P2]. nil-safe: collab is optional.
if s.collab != nil {
s.collab.Close()
}
s.bg.Wait()
s.rateLimiters.Stop() // nil-safe via the RateLimiters receiver guard
}
func New(s *store.Store) *Server {
return &Server{
store: s,
rateLimiters: NewRateLimiters(),
storageInfoCache: newStorageInfoCache(storageInfoTTL),
}
}
// Init2FASecret loads the 2FA challenge signing key from platform_settings.
// If no key exists (first run), a new random key is generated and persisted.
// This must be called before the server handles requests so that challenge
// tokens survive process restarts and work across multiple instances.
func (s *Server) Init2FASecret() error {
const settingKey = "2fa_challenge_secret"
existing, err := s.store.GetPlatformSetting(settingKey)
if err != nil {
return fmt.Errorf("load 2FA secret: %w", err)
}
if existing != "" {
decoded, err := base64.StdEncoding.DecodeString(existing)
if err != nil {
return fmt.Errorf("decode 2FA secret: %w", err)
}
s.twoFAChallengeSecret = decoded
return nil
}
// First run — generate and persist a new secret.
// Multiple instances may race here on a fresh database; after persisting,
// re-read the winning value so all instances converge on the same key.
secret, err := generateTwoFASecret()
if err != nil {
return err
}
encoded := base64.StdEncoding.EncodeToString(secret)
if err := s.store.SetPlatformSetting(settingKey, encoded); err != nil {
return fmt.Errorf("persist 2FA secret: %w", err)
}
// Re-read to pick up whichever instance won the race (upsert may have
// been overwritten by a concurrent instance between our check and write).
final, err := s.store.GetPlatformSetting(settingKey)
if err != nil {
return fmt.Errorf("re-read 2FA secret: %w", err)
}
decoded, err := base64.StdEncoding.DecodeString(final)
if err != nil {
return fmt.Errorf("decode 2FA secret after re-read: %w", err)
}
s.twoFAChallengeSecret = decoded
slog.Info("initialized 2FA challenge signing key")
return nil
}
// SetCloudMode enables cloud mode with the shared sidecar secret(s).
// Accepts a comma-separated list of secrets for rotation support:
// "new-key,old-key" — both are accepted for INBOUND calls from pad-cloud.
// The OUTBOUND direction (pad → pad-cloud, see SetCloudSidecar) is
// configured separately via PAD_CLOUD_OUTBOUND_SECRET or derived from the
// last entry of this list — see cmd/pad/main.go for the resolution order.
func (s *Server) SetCloudMode(secret string) {
s.cloudMode = true
for _, k := range strings.Split(secret, ",") {
k = strings.TrimSpace(k)
if k != "" {
s.cloudSecrets = append(s.cloudSecrets, k)
}
}
// Propagate to the email sender so transactional emails carry the
// getpad.dev marketing footer (docs/brand.md §7) on Cloud installs.
// Self-hosted deployments leave cloudMode false on the sender, keeping
// outgoing mail neutral so operators can ship under their own brand.
if s.email != nil {
s.email.SetCloudMode(true)
}
}
// CloudSidecar is the reverse pad → pad-cloud client interface. Concrete
// implementation lives in internal/billing so server has no direct Stripe
// dependency. Kept as an interface so tests can inject fakes without
// spinning up a real HTTP server or touching Stripe.
type CloudSidecar interface {
// CancelCustomer asks pad-cloud to cancel every active Stripe subscription
// for customerID and then delete the Stripe customer object. Used by
// handleDeleteAccount to cascade account deletion through to Stripe billing
// (TASK-690).
//
// Failure contract: any non-nil error means the caller MUST abort the
// local delete. pad-cloud normalizes Stripe's "already gone" cases to a
// 200 on its side (see pad-cloud stripe.go isStripeAlreadyGone), so
// every error we see here is a real failure — transport, 4xx (ops
// misconfig), or 5xx (upstream breakage). Continuing after an error
// would wipe the user's StripeCustomerID while leaving the subscription
// billing, which is exactly the regression TASK-690 exists to prevent.
CancelCustomer(customerID string) error
// GetBillingMetrics fetches an aggregated Stripe-derived snapshot from
// pad-cloud's /admin/metrics/billing endpoint (active subs, MRR, ARR,
// churn, cancellations). Used by handleAdminBillingStats to power the
// admin Billing dashboard (TASK-827 / PLAN-825).
//
// Failure contract: returns an error on transport failure or non-200
// status. The admin handler treats any error as "degrade to local-only"
// and surfaces the distinction in its response via cloud_unreachable —
// it never propagates the upstream failure to the operator's browser.
GetBillingMetrics() (*billing.BillingMetricsResponse, error)
}
// SetCloudSidecar installs the reverse pad → pad-cloud client. Called from
// cmd/pad/main.go when PAD_CLOUD_SIDECAR_URL + PAD_CLOUD_SECRET are set.
// When unset, handleDeleteAccount skips the Stripe cancel step (self-hosted
// deploys that don't run a Stripe-backed sidecar have nothing to cascade).
func (s *Server) SetCloudSidecar(c CloudSidecar) {
s.cloudSidecar = c
}
// IsCloud reports whether the server is running in cloud mode.
func (s *Server) IsCloud() bool {
return s.cloudMode
}
// SetVersion stores the build version info for the health endpoint.
func (s *Server) SetVersion(version, commit, buildTime string) {
s.version = version
s.commit = commit
s.buildTime = buildTime
}
// SetBaseURL sets the public base URL used for generating shareable links.
//
// If the supplied URL has an unspecified bind-all host ("0.0.0.0", "::",
// "[::]"), this logs a WARN: such a URL is the right thing to *bind* to
// but the wrong thing to *send* to a recipient (their browser cannot
// resolve 0.0.0.0 / :: as a connect target). Callers shipping email
// links from such a deployment should set PAD_URL or PUBLIC_URL to the
// real public hostname (e.g. https://app.getpad.dev). See BUG-899.
func (s *Server) SetBaseURL(rawURL string) {
s.baseURL = strings.TrimRight(rawURL, "/")
if s.baseURL == "" {
return
}
if u, err := url.Parse(s.baseURL); err == nil {
switch u.Hostname() {
case "", "0.0.0.0", "::":
slog.Warn("server base URL has an unspecified host; emailed links (password reset, invites, share links) will not be reachable. Set PAD_URL or PUBLIC_URL to the deployment's public URL (e.g. https://app.getpad.dev).", "base_url", s.baseURL)
}
}
}
// SetEventBus attaches an event bus for real-time SSE streaming.
func (s *Server) SetEventBus(bus events.EventBus) {
s.events = bus
}
// SetCollabRoomManager attaches a Yjs collab RoomManager (PLAN-1248).
// When set, the /api/v1/collab/{itemID} WebSocket endpoint hands new
// connections to the manager for op-log replay + fan-out. When nil,
// the endpoint exists but answers 503 — that's intentional so a
// self-host build that wants the editor without collab can leave
// this unwired without surfacing surprise behaviour.
func (s *Server) SetCollabRoomManager(rm *collab.RoomManager) {
s.collab = rm
}
// SetWebhookDispatcher attaches a webhook dispatcher for outgoing notifications.
func (s *Server) SetWebhookDispatcher(d *webhooks.Dispatcher) {
s.webhooks = d
}
// SetEmailSender attaches a transactional email sender.
// The apiKey is stored separately for deriving the unsubscribe HMAC secret.
//
// If the server is already in cloud mode when this is called (i.e.
// SetCloudMode ran before email config arrived from main.go), propagate
// the flag so the new sender adds the getpad.dev marketing footer to
// outgoing emails. Without this, the cloud-mode flag would silently
// fail to take effect when callers wired email and cloud mode in
// either order.
func (s *Server) SetEmailSender(e *email.Sender, apiKey ...string) {
s.email = e
if len(apiKey) > 0 {
s.emailAPIKey = apiKey[0]
}
if s.cloudMode && s.email != nil {
s.email.SetCloudMode(true)
}
}
// SetCORSOrigins configures allowed CORS origins (comma-separated).
func (s *Server) SetCORSOrigins(origins string) {
s.corsOrigins = origins
}
// SetAttachments wires the attachment storage Registry that the upload
// and download handlers use. Pass maxBytes = 0 to keep the
// defaultAttachmentMaxBytes ceiling (25 MiB).
func (s *Server) SetAttachments(reg *attachments.Registry, maxBytes int64) {
s.attachments = reg
s.attachmentMaxBytes = maxBytes
}
// SetImageProcessor wires the image processor that the upload handler
// uses to derive thumbnail variants (TASK-878). Optional — without it
// uploads still succeed but no thumbnails are generated; the
// download handler's variant fallback path returns the original blob.
// The capabilities endpoint reflects whichever processor is wired.
func (s *Server) SetImageProcessor(p attachments.Processor) {
s.imageProcessor = p
}
// markUploadInFlight increments the in-flight counter for a content
// hash. Returns a release func the caller MUST defer; the release
// decrements and removes the entry once it hits zero. Used by the
// upload handler to fence Put + CreateAttachment against orphan-GC
// blob deletions of the same hash.
//
// Increment + map-store + decrement + delete all run under one
// mutex so a concurrent uploadInFlight call can't observe a stale
// "0" between the last release-decrement and the next-upload
// increment. The earlier sync.Map version split increment from
// LoadOrStore-then-atomic-add and missed that window (Codex P1 on
// PR #307 round 2).
func (s *Server) markUploadInFlight(hash string) func() {
s.inFlightHashesMu.Lock()
if s.inFlightHashes == nil {
s.inFlightHashes = make(map[string]int64)
}
s.inFlightHashes[hash]++
s.inFlightHashesMu.Unlock()
return func() {
s.inFlightHashesMu.Lock()
defer s.inFlightHashesMu.Unlock()
s.inFlightHashes[hash]--
if s.inFlightHashes[hash] <= 0 {
delete(s.inFlightHashes, hash)
}
}
}
// uploadInFlight reports whether any upload is currently materializing
// a blob with the given hash. The orphan GC consults this before
// deleting a blob — if an upload just finished Put but hasn't
// inserted the row yet, GC must NOT reclaim the blob.
func (s *Server) uploadInFlight(hash string) bool {
s.inFlightHashesMu.Lock()
defer s.inFlightHashesMu.Unlock()
return s.inFlightHashes[hash] > 0
}
// SetImportBundleMaxBytes overrides the default 2 GiB cap on a
// single workspace import bundle. Set to 0 to fall back to the
// default. Wired from PAD_IMPORT_BUNDLE_MAX_BYTES in cmd/pad/main.go
// so operators with workspaces over 2 GiB can opt in without
// recompiling. Larger caps trade memory headroom (one blob in
// flight at a time, ≤25 MiB) for a longer import wall-clock.
func (s *Server) SetImportBundleMaxBytes(n int64) {
s.importBundleMaxBytes = n
}
// SetSecureCookies enables the Secure flag on all cookies.
func (s *Server) SetSecureCookies(secure bool) {
s.secureCookies = secure
}
// SetMetrics attaches Prometheus metrics to the server.
// Must be called before the first request is served.
//
// Side effect (TASK-961): when both metrics AND the OAuth server are
// wired, this also attaches the OAuth-active-tokens callback collector
// and the revocation TTL observer. Order-independent — both
// SetMetrics and SetOAuthServer call wireOAuthMetricsObserver, which
// no-ops until both prerequisites are present.
func (s *Server) SetMetrics(m *metrics.Metrics) {
s.metrics = m
s.wireOAuthMetricsObserver()
}
// wireOAuthMetricsObserver attaches the OAuth metrics that need both
// the metrics registry AND the OAuth server: the active-tokens
// callback collector (reads via the store) and the per-revocation
// TTL observer (fires from internal/oauth/storage.go on every
// access-token family revocation).
//
// Idempotent — re-registering the same collector would panic via
// prometheus.MustRegister, so we guard with a flag. Setting the
// observer multiple times is harmless (just replaces the function
// pointer).
//
// Why this lives on Server rather than in cmd/pad: it composes two
// optional Server fields whose set-order isn't guaranteed by the
// boot sequence, and centralizing the wiring here keeps the cmd/pad
// startup path declarative ("set X, set Y") without an explicit
// "now wire the cross-cut" call.
func (s *Server) wireOAuthMetricsObserver() {
if s.metrics == nil || s.oauthServer == nil {
return
}
if !s.oauthMetricsWired {
s.metrics.RegisterOAuthActiveTokensCollector(s.store.CountActiveOAuthAccessTokens)
s.oauthMetricsWired = true
}
s.oauthServer.Storage().SetRevocationObserver(func(kind string, ttl time.Duration) {
s.metrics.OAuthTokenRevocationsTotal.WithLabelValues(kind).Inc()
s.metrics.OAuthTokenTTLSeconds.Observe(ttl.Seconds())
})
}
// SetMetricsToken configures the static bearer token required to scrape
// /metrics. When empty (the default), /metrics is exposed only to loopback
// callers so a self-hosted Prometheus on the same host keeps working
// without config — but LAN/internet scrapes are refused. A non-empty
// token requires "Authorization: Bearer <token>" regardless of source.
func (s *Server) SetMetricsToken(token string) {
s.metricsToken = strings.TrimSpace(token)
}
// metricsAuth gates the /metrics endpoint. See SetMetricsToken for the
// policy. Uses constant-time comparison to avoid leaking the configured
// token via response timing.
func (s *Server) metricsAuth(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if s.metricsToken == "" {
// No token configured → loopback-only access.
if !requestIsLoopback(r) {
writeError(w, http.StatusForbidden, "forbidden",
"/metrics is restricted to loopback when PAD_METRICS_TOKEN is unset")
return
}
next.ServeHTTP(w, r)
return
}
const prefix = "Bearer "
authHeader := r.Header.Get("Authorization")
if !strings.HasPrefix(authHeader, prefix) {
w.Header().Set("WWW-Authenticate", `Bearer realm="metrics"`)
writeError(w, http.StatusUnauthorized, "unauthorized",
"Missing Bearer token for /metrics")
return
}
given := strings.TrimSpace(strings.TrimPrefix(authHeader, prefix))
if subtle.ConstantTimeCompare([]byte(given), []byte(s.metricsToken)) != 1 {
w.Header().Set("WWW-Authenticate", `Bearer realm="metrics"`)
writeError(w, http.StatusUnauthorized, "unauthorized",
"Invalid Bearer token for /metrics")
return
}
next.ServeHTTP(w, r)
})
}
// SetSSELimits configures global and per-workspace SSE connection limits.
// A value of 0 means unlimited.
func (s *Server) SetSSELimits(global, perWorkspace int) {
s.sseMaxConnections = global
s.sseMaxPerWorkspace = perWorkspace
}
// SetTrustedProxies configures which direct TCP peers are allowed to set
// X-Real-IP / X-Forwarded-For on incoming requests. Accepts a comma-
// separated list of CIDRs or bare IPs (e.g. "10.0.0.0/8, 172.16.0.0/12").
// When empty (the default), proxy headers are ignored entirely — the
// actual TCP peer address is used for rate limiting, the bootstrap
// loopback check, and audit logging.
func (s *Server) SetTrustedProxies(spec string) {
s.trustedProxyCIDRs = ParseTrustedProxyCIDRs(spec)
}
// SetIPChangeEnforce controls how the auth middleware reacts when a
// session's client IP changes mid-lifetime:
// - mode == "strict": reject the request (session treated as possibly stolen)
// - anything else (default): log to the audit log, update the stored IP,
// and let the request through. Strict mode breaks legitimate mobility
// (mobile roaming, VPN toggles) so it is opt-in for high-sensitivity
// deployments via the PAD_IP_CHANGE_ENFORCE env var.
func (s *Server) SetIPChangeEnforce(mode string) {
s.ipChangeEnforceStrict = strings.EqualFold(strings.TrimSpace(mode), "strict")
}
// reconfigureEmail reads email settings from the platform_settings table
// and updates (or creates) the email sender. Called after admin settings change.
func (s *Server) reconfigureEmail() {
apiKey, _ := s.store.GetPlatformSetting(settingMailerooAPIKey)
fromAddr, _ := s.store.GetPlatformSetting(settingEmailFrom)
fromName, _ := s.store.GetPlatformSetting(settingEmailFromName)
if apiKey == "" {
return // No API key — leave email as-is (may still have env var config)
}
s.emailAPIKey = apiKey
if s.email == nil {
// Create a new sender from platform settings
s.email = email.NewSender(apiKey, fromAddr, fromName, s.baseURL)
} else {
// Update existing sender
s.email.Configure(apiKey, fromAddr, fromName, s.baseURL)
}
// Propagate cloud mode whichever way email was wired — see SetEmailSender
// for the matching note. Configure() preserves cloudMode on existing
// senders since SetCloudMode is independent; this branch covers the
// fresh-NewSender path.
if s.cloudMode {
s.email.SetCloudMode(true)
}
}
// InitEmailFromSettings loads email config from platform settings on startup,
// merging with any env-var-based sender that was already attached.
func (s *Server) InitEmailFromSettings() {
s.reconfigureEmail()
}
func (s *Server) setupRouter() {
r := chi.NewRouter()
// Infrastructure middleware (applies to all routes including /metrics)
// CapturePeerAddr MUST run before TrustedProxyRealIP so downstream code
// that needs to verify the real TCP peer (e.g. the bootstrap loopback
// check) can read the untampered value from request context even on
// deployments with a trusted reverse proxy in front.
r.Use(CapturePeerAddr)
// RealIP is gated on PAD_TRUSTED_PROXIES. When unset (the default), proxy
// headers are ignored and the real TCP peer address is used everywhere.
// This prevents X-Forwarded-For spoofing from bypassing rate limits, the
// bootstrap loopback check, or audit logs on direct-exposed deployments.
r.Use(TrustedProxyRealIP(s.trustedProxyCIDRs))
r.Use(chimiddleware.RequestID)
r.Use(StructuredLogger)
if s.metrics != nil {
r.Use(MetricsMiddleware(s.metrics))
}
r.Use(chimiddleware.Recoverer)
// Security headers (applies to all routes)
r.Use(SecurityHeaders)
if s.secureCookies {
r.Use(StrictTransportSecurity)
}
// MCP Streamable HTTP transport + OAuth discovery endpoints
// (PLAN-943 TASK-950). Mounted outside the standard /api/v1
// auth-required group because:
//
// - /mcp uses Bearer auth via its own MCPBearerAuth middleware,
// producing the spec-shape 401 + WWW-Authenticate that MCP
// clients expect (the API-stack 401 envelope is JSON-only and
// would fail Claude Desktop's discovery handshake).
// - /.well-known/oauth-protected-resource and
// /.well-known/oauth-authorization-server are public discovery
// documents (RFC 9728 / RFC 8414); routing them through
// TokenAuth+SessionAuth+RequireAuth would 401 unauth probes.
//
// No-op when SetMCPTransport hasn't been called or cloud mode is
// off — see registerMCPRoutes for the gating.
s.registerMCPRoutes(r)
// OAuth 2.1 authorization-server flow endpoints (PLAN-943
// TASK-1025 sub-PR C). /oauth/{register,authorize,token,
// authorize/decide} mounted alongside /mcp + /.well-known/*,
// outside /api/v1's auth-required group. CSRF middleware runs
// only on /api/* paths so /oauth/* is naturally exempt; the
// consent-decision endpoint adds its own form-token check
// using the existing __Host-pad_csrf cookie.
//
// SessionAuth runs in this group so /oauth/authorize can detect
// whether the user is logged in via the __Host-pad_session
// cookie. SessionAuth falls through gracefully when no cookie
// is present (handlers see currentUser(r)==nil and redirect to
// /login). RequireAuth is intentionally NOT used — /oauth/authorize
// must be reachable anonymously to trigger the login redirect.
//
// RateLimit gates /oauth/register specifically (per Codex review
// #372 round 2 — the DCR endpoint is open by RFC 7591 design,
// but unlimited writes to oauth_clients are an obvious DoS
// surface). The middleware short-circuits other /oauth/* paths
// because they're either session-bound or PKCE-bound; explicit
// per-endpoint limits arrive with TASK-959.
//
// No-op when SetOAuthServer hasn't been called or cloud mode is off.
r.Group(func(r chi.Router) {
r.Use(s.requireCloudMode)
r.Use(s.SessionAuth)
r.Use(s.RateLimit)
s.registerOAuthRoutes(r)
})
// Prometheus scrape endpoint — exempt from the standard auth/CSRF stack
// (Prometheus can't present a session cookie or pass a CSRF header), but
// gated by a dedicated static bearer token. Without the gate, any
// unauthenticated caller on the network can read workspace counts, API
// usage patterns, and — via label enumeration — user/workspace IDs.
//
// The gate runs in three layers:
// 1. No PAD_METRICS_TOKEN → endpoint is open ONLY to loopback. Safe
// default for self-hosters running Prometheus on the same box.
// 2. PAD_METRICS_TOKEN set → "Authorization: Bearer <token>" required.
// Compared in constant time; empty/missing header → 401.
// 3. In either case the SecurityHeaders / rate-limit / logging chain
// already wraps this group from the outer r.Use() calls above.
if s.metrics != nil {
r.Group(func(r chi.Router) {
r.Use(s.metricsAuth)
r.Handle("/metrics", promhttp.HandlerFor(s.metrics.Registry, promhttp.HandlerOpts{}))
})
}
// All other routes — full middleware stack
r.Group(func(r chi.Router) {
r.Use(cors.Handler(cors.Options{
AllowedOrigins: parseCORSOrigins(s.corsOrigins),
AllowedMethods: []string{"GET", "POST", "PATCH", "PUT", "DELETE", "OPTIONS"},
AllowedHeaders: []string{"Accept", "Authorization", "Content-Type", "X-CSRF-Token", "X-Share-Password", "X-Bootstrap-Token"},
// Credentials flag is gated on an operator explicitly listing
// PAD_CORS_ORIGINS. The CLI uses Bearer tokens so the default
// "no CORS_ORIGINS set" path doesn't need credential sharing;
// leaving it off by default prevents cross-origin fetches from
// a browser on a different site from piggy-backing cookies
// on the victim's session.
AllowCredentials: corsAllowCredentials(s.corsOrigins),
MaxAge: 300,
}))
r.Use(s.TokenAuth)
r.Use(s.SessionAuth)
r.Use(s.RateLimit)
r.Use(s.CSRFProtect)
r.Use(s.RequireAuth)
r.Use(jsonContentType)
// SSE endpoint (outside jsonContentType middleware — but inherits auth)
r.Get("/api/v1/events", s.handleSSE)
// WebSocket endpoint for Yjs-based collaborative editing on a
// single item (PLAN-1248). Lives outside jsonContentType for
// the same reason as SSE: the response is a WS upgrade, not
// JSON. Inherits the auth middleware chain — handleCollab
// then re-checks workspace access keyed on the item's
// workspace ID (the URL only carries itemID).
r.Get("/api/v1/collab/{itemID}", s.handleCollab)
// API routes
r.Route("/api/v1", func(r chi.Router) {
r.Get("/health", s.handleHealth)
r.Get("/health/live", s.handleHealthLive)
r.Get("/health/ready", s.handleHealthReady)
r.Get("/plan-limits", s.handleGetPlanLimits) // Public: billing page reads plan limits
r.Get("/unsubscribe", s.handleUnsubscribe) // Public: email opt-out (HMAC-signed)
// Server capabilities — public so the editor can fetch it
// pre-login and gate per-format rotate / crop UI on the
// processor's reach (TASK-878). The response is static for
// the lifetime of the binary; clients can cache freely.
r.Get("/server/capabilities", s.handleServerCapabilities)
// Auth endpoints (exempt from auth middleware)
r.Route("/auth", func(r chi.Router) {
r.Get("/session", s.handleSessionCheck)
r.Post("/bootstrap", s.handleBootstrap)
r.Post("/register", s.handleRegister)
r.Get("/check-username", s.handleCheckUsername)
r.Post("/login", s.handleLogin)
r.Post("/logout", s.handleLogout)
r.Get("/me", s.handleGetCurrentUser)
r.Patch("/me", s.handleUpdateCurrentUser)
// Password reset
r.Post("/forgot-password", s.handleForgotPassword)
r.Post("/reset-password", s.handleResetPassword)
// Two-factor authentication
r.Post("/2fa/setup", s.handleTOTPSetup)
r.Post("/2fa/verify", s.handleTOTPVerify)
r.Post("/2fa/disable", s.handleTOTPDisable)
r.Post("/2fa/login-verify", s.handleTOTPLoginVerify)
// Account management (GDPR)
r.Post("/delete-account", s.handleDeleteAccount)
r.Get("/export", s.handleExportAccount)
// User-scoped API tokens
r.Get("/tokens", s.handleListUserTokens)
r.Post("/tokens", s.handleCreateUserToken)
r.Delete("/tokens/{tokenID}", s.handleDeleteUserToken)
r.Post("/tokens/{tokenID}/rotate", s.handleRotateUserToken)
// Cloud: OAuth login/linking (called by pad-cloud sidecar, protected by cloud secret)
r.Post("/oauth-login", s.handleOAuthLogin)
r.Post("/oauth-link", s.handleOAuthLink)
r.Post("/oauth-unlink", s.handleOAuthUnlink)
// CLI browser-based auth flow
r.Post("/cli/sessions", s.handleCreateCLIAuthSession)
r.Get("/cli/sessions/{code}", s.handlePollCLIAuthSession)
r.Post("/cli/sessions/{code}/approve", s.handleApproveCLIAuthSession)
})
// Admin endpoints (admin-only, handlers check role internally)
r.Route("/admin", func(r chi.Router) {
r.Get("/settings", s.handleGetPlatformSettings)
r.Patch("/settings", s.handleUpdatePlatformSettings)
r.Post("/test-email", s.handleTestEmail)
// Cloud sidecar endpoints — only exist in cloud mode. requireCloudMode
// returns 404 outside cloud mode so a self-hosted deployment doesn't
// expose "Cloud mode not configured" to unauthenticated probes.
r.Group(func(r chi.Router) {
r.Use(s.requireCloudMode)
r.Post("/plan", s.handleSetPlan) // Cloud: sidecar sets user plans; also accessible to admins
r.Post("/stripe-customer-id", s.handleSetStripeCustomerID) // Cloud: sidecar stores Stripe customer ID after checkout
r.Get("/user-by-customer", s.handleGetUserByCustomerID) // Cloud: sidecar looks up user by Stripe customer ID
r.Post("/stripe-event-processed", s.handleStripeEventProcessed) // Cloud: sidecar webhook idempotency (TASK-696)
r.Post("/stripe-event-unmark", s.handleStripeEventUnmark) // Cloud: sidecar handler-failure rollback (TASK-736)
r.Post("/payment-failed", s.handlePaymentFailed) // Cloud: sidecar forwards invoice.payment_failed to trigger email (TASK-712)
// Admin Billing dashboard data (TASK-827 / PLAN-825). Proxies
// pad-cloud's /admin/metrics/billing for Stripe-derived stats
// (active subs, MRR, ARR, churn) and merges with local
// users-table aggregates (customers_by_plan, new_signups_30d).
// Always returns 200; degraded states (sidecar unreachable,
// Stripe not configured) are surfaced as flags in the body.
r.Get("/billing-stats", s.handleAdminBillingStats)
})
// User management
r.Get("/users", s.handleAdminListUsers)
r.Get("/users/{userID}", s.handleAdminGetUser)
r.Patch("/users/{userID}", s.handleAdminUpdateUser)
r.Post("/users/{userID}/reset-password", s.handleAdminResetPassword)
r.Get("/users/{userID}/workspaces", s.handleAdminGetUserWorkspaces)
r.Get("/users/{userID}/detail", s.handleAdminGetUserDetail)
r.Get("/users/{userID}/activity", s.handleAdminGetUserActivity)
r.Get("/users/{userID}/metrics", s.handleAdminGetUserMetrics)
r.Post("/users/{userID}/disable", s.handleAdminDisableUser)
r.Post("/users/{userID}/enable", s.handleAdminEnableUser)
// Invitations
r.Get("/invitations", s.handleAdminListInvitations)
r.Post("/invitations/{invID}/resend", s.handleAdminResendInvitation)
r.Delete("/invitations/{invID}", s.handleAdminDeleteInvitation)
// Plan limits
r.Get("/limits", s.handleAdminGetLimits)
r.Patch("/limits", s.handleAdminUpdateLimits)
// Platform stats
r.Get("/stats", s.handleAdminStats)
// MCP audit log — admin-only full-table view (TASK-960).
// Powers /console/admin/mcp-audit. Per-connection
// drilldown that users see for their own connections
// lives at /api/v1/connected-apps/{id}/audit (registered
// outside the admin group so non-admin users can read
// their own).
r.Get("/mcp-audit", s.handleAdminMCPAudit)
})
// Audit log (admin-only)
r.Get("/audit-log", s.handleAuditLog)
// MCP per-connection audit (TASK-960). Owner-only via the
// store query (user_id is one of the WHERE clauses);
// returns the requesting user's own MCP activity for one
// connection. The handler runs inside the standard
// /api/v1 auth-required group, so unauthenticated callers
// 401 here just like every other API endpoint.
r.Get("/connected-apps/{id}/audit", s.handleMCPConnectionAudit)
// Connected-apps management (TASK-954). Lists every
// active OAuth grant chain the user has authorized
// (Claude Desktop, Cursor, …) and lets them revoke one.
// Cloud-mode-gated because OAuth is a cloud-only
// surface — self-hosted deployments would always see
// an empty list.
r.Group(func(r chi.Router) {
r.Use(s.requireCloudMode)
r.Get("/connected-apps", s.handleListConnectedApps)
r.Delete("/connected-apps/{id}", s.handleRevokeConnectedApp)
// PLAN-1519 / TASK-1524 / IDEA-1517 §3: mutation
// endpoints for the connections-page UI. Per-field
// patches rather than a general PATCH for cleaner
// error envelopes + audit shape.
r.Patch("/connected-apps/{id}/name", s.handleRenameConnectedApp)
r.Patch("/connected-apps/{id}/flags", s.handleUpdateConnectedAppFlags)
r.Post("/connected-apps/{id}/workspaces", s.handleAddConnectedAppWorkspace)
r.Delete("/connected-apps/{id}/workspaces/{slug}", s.handleRemoveConnectedAppWorkspace)
})
// Templates
r.Get("/templates", s.handleListTemplates)
// Convention Library
r.Get("/convention-library", s.handleConventionLibrary)
// Playbook Library
r.Get("/playbook-library", s.handlePlaybookLibrary)
// URL import — fetch a remote page and return markdown.
// Side-effect-free; the client decides what to do with the
// markdown. See PLAN-1467 / TASK-1472 / internal/urlimport.
r.Post("/import/url", s.handleImportURL)
// Invitations (outside workspace scope)
r.Post("/invitations/{code}/accept", s.handleAcceptInvitation)
// OAuth client public-info (PLAN-943 TASK-1027 sub-PR E).
// Read-only consent-screen support for OAuth clients
// registered via /oauth/register. Auth-required (inherits
// RequireAuth from the parent group); cloud-mode-gated so
// self-hosted deployments without an OAuth server don't
// expose a hollow endpoint. Returns four non-sensitive
// fields (client_id, client_name, logo_uri, redirect_uris)
// — see handlers_oauth_clients.go for the full leak-surface
// rationale.
r.Group(func(r chi.Router) {
r.Use(s.requireCloudMode)
r.Get("/oauth/clients/{id}/public-info", s.handleOAuthClientPublicInfo)
})
// Share link resolution (outside workspace scope, no auth required)
r.Get("/s/{token}", s.handleResolveShareLink)
// Claim-code redemption (PLAN-1519 / TASK-1521 / IDEA-1517 §4).
// POST /api/v1/oauth/claim with body {workspace, code} grants
// the calling OAuth connection access to one workspace via a
// stateless 6-digit HMAC code the user generated in the web
// UI's "Connect project" modal. Auth: standard /api/v1 chain
// (TokenAuth + RequireAuth); the handler itself short-circuits
// the side effect when the caller isn't an OAuth grant (PAT /
// CLI session) and 412s when the claim secret isn't wired.
r.Post("/oauth/claim", s.handleOAuthClaim)
// Workspaces
r.Route("/workspaces", func(r chi.Router) {
r.Get("/", s.handleListWorkspaces)
r.Post("/", s.handleCreateWorkspace)
r.Post("/import", s.handleImportWorkspace)
r.Put("/reorder", s.handleReorderWorkspaces)
r.Route("/{slug}", func(r chi.Router) {
r.Use(s.RequireWorkspaceAccess)
r.Get("/", s.handleGetWorkspace)
r.Patch("/", s.handleUpdateWorkspace)
r.Delete("/", s.handleDeleteWorkspace)
r.Get("/export", s.handleExportWorkspace)
// Activity (workspace level)
r.Get("/activity", s.handleListWorkspaceActivity)
// Claim-code generation + smart suppression (PLAN-1519
// / TASK-1525 / IDEA-1517 §4). Inherits
// RequireWorkspaceAccess so any member can pull a code
// for any workspace they belong to — membership IS
// the consent. See handlers_claim_code.go.
r.Get("/claim-code", s.handleWorkspaceClaimCode)
// Documents (v1 — will be replaced by items in Phase 2)
r.Route("/documents", func(r chi.Router) {
r.Get("/", s.handleListDocuments)
r.Post("/", s.handleCreateDocument)
r.Route("/{docID}", func(r chi.Router) {
r.Get("/", s.handleGetDocument)
r.Patch("/", s.handleUpdateDocument)
r.Delete("/", s.handleDeleteDocument)
r.Post("/restore", s.handleRestoreDocument)
// Versions
r.Get("/versions", s.handleListVersions)
r.Get("/versions/{versionID}", s.handleGetVersion)
// Activity (document level)
r.Get("/activity", s.handleListDocumentActivity)
})
})
// Collections (v2)
r.Route("/collections", func(r chi.Router) {
r.Get("/", s.handleListCollections)
r.Post("/", s.handleCreateCollection)
r.Route("/{collSlug}", func(r chi.Router) {
r.Get("/", s.handleGetCollection)
r.Patch("/", s.handleUpdateCollection)
r.Delete("/", s.handleDeleteCollection)
// Items within collection
r.Get("/items", s.handleListCollectionItems)
r.Post("/items", s.handleCreateItem)
// Pairs with /items-index — server-side checkbox
// progress so the collection page can render
// list/board/table progress badges without
// fetching item content (TASK-1349).
r.Get("/checkbox-progress", s.handleCollectionCheckboxProgress)
// Collection grants
r.Get("/grants", s.handleListCollectionGrants)
r.Post("/grants", s.handleCreateCollectionGrant)
r.Delete("/grants/{grantID}", s.handleDeleteCollectionGrant)
r.Get("/share-links", s.handleListCollectionShareLinks)
r.Post("/share-links", s.handleCreateCollectionShareLink)
// Saved views within collection
r.Get("/views", s.handleListViews)
r.Post("/views", s.handleCreateView)
r.Route("/views/{viewID}", func(r chi.Router) {
r.Patch("/", s.handleUpdateView)
r.Delete("/", s.handleDeleteView)
})
})
})
// Plans progress
r.Get("/plans-progress", s.handlePlansProgress)
// Skinny-projection cross-collection items list for the
// local-first read model bootstrap (PLAN-1343 / TASK-1344).
// Lives at workspace level — sibling to /plans-progress
// and /starred — so the path can't ever collide with an
// item slug under /items/{itemSlug}.
r.Get("/items-index", s.handleListItemsIndex)
// Delta-fetch sibling of /items-index: returns rows
// where seq > since, including tombstones, so a
// local-first read-model client can resume without
// re-downloading the whole index (PLAN-1343 / TASK-1354).
r.Get("/items-changes", s.handleListItemsChanges)
// User grants (all grants for a specific user in this workspace)
r.Get("/users/{userID}/grants", s.handleListUserGrants)
// Starred items
r.Get("/starred", s.handleListStarredItems)
// Items (cross-collection, v2)
r.Get("/items", s.handleListItems)
r.Route("/items/{itemSlug}", func(r chi.Router) {
r.Get("/", s.handleGetItem)
r.Patch("/", s.handleUpdateItem)
r.Delete("/", s.handleDeleteItem)
r.Post("/restore", s.handleRestoreItem)
r.Post("/move", s.handleMoveItem)
r.Get("/versions", s.handleListItemVersions)
r.Post("/versions/{versionID}/restore", s.handleRestoreItemVersion)
r.Get("/activity", s.handleListItemActivity)
r.Get("/links", s.handleGetItemLinks)
r.Post("/links", s.handleCreateItemLink)
r.Get("/comments", s.handleListComments)
r.Post("/comments", s.handleCreateComment)
r.Get("/timeline", s.handleListItemTimeline)
r.Get("/children", s.handleGetItemChildren)
r.Get("/progress", s.handleGetItemProgress)
r.Get("/tasks", s.handleGetItemChildren) // deprecated alias
r.Get("/grants", s.handleListItemGrants)
r.Post("/grants", s.handleCreateItemGrant)
r.Delete("/grants/{grantID}", s.handleDeleteItemGrant)
r.Get("/share-links", s.handleListItemShareLinks)
r.Post("/share-links", s.handleCreateItemShareLink)
// Stars
r.Get("/star", s.handleGetItemStarStatus)
r.Post("/star", s.handleStarItem)
r.Delete("/star", s.handleUnstarItem)
})
// Links (v2)
r.Delete("/links/{linkID}", s.handleDeleteItemLink)
// Share links (workspace-scoped management)
r.Delete("/share-links/{linkID}", s.handleDeleteShareLink)
r.Get("/share-links/{linkID}/views", s.handleShareLinkViews)
// Comments (v2)
r.Route("/comments/{commentID}", func(r chi.Router) {
r.Delete("/", s.handleDeleteComment)
r.Post("/replies", s.handleCreateReply)
r.Post("/reactions", s.handleAddReaction)
r.Delete("/reactions/{emoji}", s.handleRemoveReaction)
})
// Role Board (cross-collection role-based view)
r.Get("/roles/board", s.handleRoleBoard)
r.Put("/roles/board/reorder", s.handleRoleBoardReorder)
r.Put("/roles/board/lane-order", s.handleRoleBoardLaneReorder)
// Agent Roles
r.Route("/agent-roles", func(r chi.Router) {
r.Get("/", s.handleListAgentRoles)
r.Post("/", s.handleCreateAgentRole)
r.Route("/{roleID}", func(r chi.Router) {
r.Get("/", s.handleGetAgentRole)
r.Patch("/", s.handleUpdateAgentRole)
r.Delete("/", s.handleDeleteAgentRole)
})
})
// Attachments
// POST /attachments — upload (TASK-871)
// GET /attachments/{attachmentID} — serve blob (TASK-872, supports ?variant=)
// HEAD /attachments/{attachmentID} — metadata only (TASK-877 file-chip enrichment)
// POST /attachments/{attachmentID}/transform — server-side rotate/crop (TASK-879/880)
//
// chi does not auto-route HEAD to the GET handler, so the
// editor's HEAD probe for size + MIME has to be registered
// explicitly. The handler short-circuits the streaming
// path on HEAD; http.ServeContent already strips the body
// on the seekable path.
r.Post("/attachments", s.handleUploadAttachment)
r.Get("/attachments", s.handleListWorkspaceAttachments)
r.Get("/attachments/{attachmentID}", s.handleGetAttachment)
r.Head("/attachments/{attachmentID}", s.handleGetAttachment)
r.Post("/attachments/{attachmentID}/transform", s.handleTransformAttachment)
r.Delete("/attachments/{attachmentID}", s.handleDeleteWorkspaceAttachment)
// Storage usage summary for Settings → Storage and other
// quota-aware UI surfaces (TASK-881). Cached behind a
// short TTL — see handleGetWorkspaceStorageUsage.
r.Get("/storage/usage", s.handleGetWorkspaceStorageUsage)
// Webhooks
r.Route("/webhooks", func(r chi.Router) {
r.Get("/", s.handleListWebhooks)
r.Post("/", s.handleCreateWebhook)
r.Route("/{webhookID}", func(r chi.Router) {
r.Delete("/", s.handleDeleteWebhook)
r.Post("/test", s.handleTestWebhook)
})
})
// API Tokens
r.Route("/tokens", func(r chi.Router) {
r.Get("/", s.handleListTokens)
r.Post("/", s.handleCreateToken)
r.Delete("/{tokenID}", s.handleDeleteToken)
})
// Members
r.Route("/members", func(r chi.Router) {
r.Get("/", s.handleListMembers)
r.Post("/invite", s.handleInviteMember)
r.Delete("/invitations/{invID}", s.handleCancelInvitation)
r.Delete("/{userID}", s.handleRemoveMember)
r.Patch("/{userID}", s.handleUpdateMemberRole)
r.Get("/{userID}/collection-access", s.handleGetMemberCollectionAccess)
r.Put("/{userID}/collection-access", s.handleSetMemberCollectionAccess)
})
// Me — current user's effective workspace context (role,
// collection access, grants). Open to any principal admitted
// by RequireWorkspaceAccess (members + guests).
r.Get("/me", s.handleGetMe)
// Dashboard (v2)
r.Get("/dashboard", s.handleGetDashboard)
// Agent bootstrap (PLAN-1377 / TASK-1379) — single
// round-trip that returns workspace + user +
// collections + always-on conventions + roles +
// playbook metadata + dashboard + recent activity.
// Replaces the four /pad context-loading calls the
// skill used to make. Same shape via the MCP
// surfaces in TASK-1380.
r.Get("/agent/bootstrap", s.handleGetBootstrap)
// Playbook surface (PLAN-1377 / TASK-1382) — list /
// show / run for first-class invokable procedures.
// run is side-effect-free: it parses args per the
// playbook's declared spec and returns the body +
// bound args. The agent (skill or MCP-driven)
// executes the body; the server does not.
r.Get("/playbooks", s.handleListPlaybooks)
r.Get("/playbooks/{ref}", s.handleShowPlaybook)
r.Post("/playbooks/{ref}/run", s.handleRunPlaybook)
// Incremental sync — returns items changed since a timestamp
r.Get("/changes", s.handleGetChanges)
})
})
// Search
r.Get("/search", s.handleSearch)
})
// Cross-workspace wiki-link resolver (IDEA-1492). Resolves
// `[[workspace::REF]]` links emitted by the markdown renderer to
// the canonical item URL via a 302 redirect. Lives outside /api/v1
// because rendered HTML hrefs target user-facing paths, not API
// endpoints. Registered at the outer group level so chi matches
// these URLs ahead of the catch-all SPA handler. ACL check matches
// existing workspace-access semantics — 404 (not 403) on no-access
// so we don't leak whether a workspace exists.
//
// URL shape: `/-/r/{workspace}/{ref}` — the leading `-/r/` prefix
// is structurally impossible to collide with any user-namespace
// URL because username slugs require a leading letter (slugify
// rule), so no existing or future page route under
// /{username}/... can shadow this resolver, and no collection
// slug under /{u}/{ws}/{coll}/... can intercept it
// (slug grammar also requires letter-led). This replaces the
// earlier `/{username}/{workspace}/ref/{ref}` shape that risked
// collision with collection slugs named "ref" on pre-existing
// data (Codex round-2 P1.4 — picked Option B over a migration
// because the feature is unshipped, the new shape is more
// defensive, and the only cost is a frontend emit-shape change).
r.Get("/-/r/{workspace}/{ref}", s.handleResolveCrossWorkspaceRef)
}) // end r.Group (full middleware stack)
s.router = r
}
// SetWebUI sets the embedded web UI filesystem for serving the SPA.
func (s *Server) SetWebUI(fsys fs.FS) {
s.webFS = fsys
s.ensureRouter()
s.router.Handle("/*", s.spaHandler())
}
func (s *Server) spaHandler() http.Handler {
fileServer := http.FileServer(http.FS(s.webFS))
indexHTML, err := fs.ReadFile(s.webFS, "index.html")
if err != nil {
// Embedded web UI is missing — fail fast instead of silently
// serving blank HTML to every request. This indicates a broken
// build, so the server should refuse to start.
panic(fmt.Sprintf("spaHandler: failed to read embedded index.html: %v", err))
}
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
path := r.URL.Path
if strings.HasPrefix(path, "/api/") {
http.NotFound(w, r)
return
}
cleanPath := strings.TrimPrefix(path, "/")
if cleanPath != "" {
if _, err := fs.Stat(s.webFS, cleanPath); err == nil {
if strings.Contains(path, "/immutable/") {
w.Header().Set("Cache-Control", "public, max-age=31536000, immutable")
} else {
w.Header().Set("Cache-Control", "no-cache")
}
fileServer.ServeHTTP(w, r)
return
}
}
// Generate per-request nonce for inline script CSP
nonce := generateCSPNonce()
// Inject nonce into inline <script> tags (SvelteKit bootstrap)
html := bytes.Replace(indexHTML, []byte("<script>"), []byte(fmt.Sprintf(`<script nonce="%s">`, nonce)), -1)
// Set nonce-based CSP (overrides the strict default from SecurityHeaders).
// - 'nonce-<N>' authorizes the SvelteKit bootstrap <script> we inject below.
// - 'strict-dynamic' lets that trusted script dynamically import() the
// SvelteKit runtime chunks without listing every build-hashed path. In
// browsers that honor CSP L3, 'strict-dynamic' supersedes the 'self'
// host-list, so an XSS gap that injects <script src="//evil.com"> is
// rejected even though 'self' is present. 'self' stays as a fallback
// for older browsers that don't implement strict-dynamic.
// - script-src-attr 'none' blocks inline event handlers regardless of the
// script-src nonce — per CSP spec, event attributes bypass script-src.
w.Header().Set("Content-Security-Policy", fmt.Sprintf(
"default-src 'self'; script-src 'self' 'nonce-%s' 'strict-dynamic'; script-src-attr 'none'; style-src 'self' 'unsafe-inline'; img-src 'self' data:; font-src 'self'; connect-src 'self'; frame-ancestors 'none'",
nonce))
w.Header().Set("Content-Type", "text/html; charset=utf-8")
w.Header().Set("Cache-Control", "no-cache, no-store, must-revalidate")
w.WriteHeader(http.StatusOK)
w.Write(html)
})
}
// ensureRouter lazily initializes the router on first use, so all Set*
// configuration is applied before the middleware chain is built.
func (s *Server) ensureRouter() {
s.routerOnce.Do(func() {
s.setupRouter()
})
}
func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request) {
s.ensureRouter()
s.router.ServeHTTP(w, r)
}
// httpIdleTimeout caps the keep-alive idle window on every HTTP
// connection. Tracked here (not in handlers_events.go) because it
// applies to ALL connections, not just SSE — but it has a hard
// invariant relationship with sseKeepaliveInterval: an idle SSE
// stream is kept alive by periodic comment writes, and those must
// land more frequently than IdleTimeout or the connection will be
// closed mid-stream by the http.Server. The guard in
// handlers_events.go's init() enforces 3 × sseKeepaliveInterval <
// httpIdleTimeout so we tolerate one or two missed/dropped writes
// (network blip, scheduler hiccup) before tripping the deadline.
const httpIdleTimeout = 120 * time.Second
func (s *Server) ListenAndServe(addr string) error {
s.ensureRouter()
s.httpServer = &http.Server{
Addr: addr,
Handler: s.router,
ReadTimeout: 15 * time.Second,
ReadHeaderTimeout: 5 * time.Second,
IdleTimeout: httpIdleTimeout,
// Cap total header bytes (default 1 MB) to 64 KB — well above any
// legitimate request (cookies, auth, content-type, a few CSRF/CORS
// headers) and tight enough to cheaply reject header-flood DoS.
MaxHeaderBytes: 64 * 1024,
// WriteTimeout left at 0 — SSE connections are long-lived.
// Non-SSE handlers should use per-request context deadlines.
}
slog.Info("Pad server listening", "addr", addr)
return s.httpServer.ListenAndServe()
}
// Shutdown gracefully drains in-flight requests and stops the HTTP server.
// The provided context controls how long to wait for active connections.
func (s *Server) Shutdown(ctx context.Context) error {
if s.httpServer == nil {
return nil
}
return s.httpServer.Shutdown(ctx)
}
// Handler returns the configured HTTP handler (router).
// Useful for testing with httptest.NewServer.
func (s *Server) Handler() http.Handler {
s.ensureRouter()
return s.router
}
// --- helpers ---
func jsonContentType(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if len(r.URL.Path) >= 7 && r.URL.Path[:7] == "/api/v1" {
w.Header().Set("Content-Type", "application/json")
}
next.ServeHTTP(w, r)
})
}
func writeJSON(w http.ResponseWriter, status int, v interface{}) {
w.WriteHeader(status)
if err := json.NewEncoder(w).Encode(v); err != nil {
slog.Error("failed to encode JSON response", "error", err)
}
}
func writeError(w http.ResponseWriter, status int, code, message string) {
writeJSON(w, status, map[string]interface{}{
"error": map[string]string{
"code": code,
"message": message,
},
})
}
// writeInternalError logs the real error server-side and sends a generic
// message to the client. This prevents leaking SQL errors, file paths,
// and other internal details.
func writeInternalError(w http.ResponseWriter, err error) {
slog.Error("internal server error", "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "An internal error occurred")
}
// defaultJSONBodyLimit is the default cap applied to JSON request bodies
// by decodeJSON. Every /api/* POST/PATCH is comfortably small in practice
// (items, collections, auth payloads — all well under 100 KB), so the
// 2 MB cap is several orders of magnitude above real traffic while still
// cheap to hold in memory per request. Callers who legitimately need
// more — bulk imports — should call decodeJSONWithLimit explicitly.
const defaultJSONBodyLimit = 2 << 20 // 2 MiB
// decodeJSON reads and unmarshals the JSON body into v. Wraps the body in
// http.MaxBytesReader so an attacker can't exhaust memory by POSTing a
// multi-GB JSON blob — without this, json.NewDecoder.Decode happily
// streams the whole body into a single allocation.
func decodeJSON(r *http.Request, v interface{}) error {
return decodeJSONWithLimit(r, v, defaultJSONBodyLimit)
}
// decodeJSONWithLimit is the size-configurable variant. Use this for
// endpoints that accept large payloads (e.g. bulk-import) where the
// default cap is too small — but always pass an explicit cap, never
// remove the wrapper.
func decodeJSONWithLimit(r *http.Request, v interface{}, maxBytes int64) error {
// http.MaxBytesReader.Close() is a no-op; the decoder leaves r.Body at
// EOF anyway. Setting this here also lets the server return a 413
// automatically via the error we wrap below.
if r.Body != nil {
r.Body = http.MaxBytesReader(nil, r.Body, maxBytes)
}
if err := json.NewDecoder(r.Body).Decode(v); err != nil {
return fmt.Errorf("invalid JSON: %w", err)
}
return nil
}
// getWorkspaceID resolves workspace slug/ID from the request.
// If RequireWorkspaceAccess already resolved the workspace, reads from context.
// Otherwise falls back to direct resolution (for unauthenticated paths).
func (s *Server) getWorkspaceID(w http.ResponseWriter, r *http.Request) (string, bool) {
// Fast path: already resolved by RequireWorkspaceAccess middleware
if wsID, ok := r.Context().Value(ctxResolvedWorkspaceID).(string); ok && wsID != "" {
return wsID, true
}
// Slow path: resolve directly (should rarely happen — only for routes
// that don't go through RequireWorkspaceAccess)
slugOrID := chi.URLParam(r, "slug")
ws, err := s.resolveWorkspace(slugOrID, currentUser(r))
if err != nil {
writeInternalError(w, err)
return "", false
}
if ws == nil {
writeError(w, http.StatusNotFound, "not_found", "Workspace not found")
return "", false
}
return ws.ID, true
}
// getWorkspace returns the full workspace object resolved by middleware.
// Falls back to direct resolution for routes without RequireWorkspaceAccess.
func (s *Server) getWorkspace(w http.ResponseWriter, r *http.Request) (*models.Workspace, bool) {
// Fast path: use middleware-resolved ID
if wsID, ok := r.Context().Value(ctxResolvedWorkspaceID).(string); ok && wsID != "" {
ws, err := s.store.GetWorkspaceByID(wsID)
if err != nil {
writeInternalError(w, err)
return nil, false
}
if ws != nil {
return ws, true
}
}
// Slow path: resolve from URL param
slugOrID := chi.URLParam(r, "slug")
ws, err := s.resolveWorkspace(slugOrID, currentUser(r))
if err != nil {
writeInternalError(w, err)
return nil, false
}
if ws == nil {
writeError(w, http.StatusNotFound, "not_found", "Workspace not found")
return nil, false
}
return ws, true
}
// visibleCollectionIDs returns the set of collection IDs the current user can
// see in the given workspace. Returns nil if the user has "all" access (no
// filtering needed), or a non-nil slice for "specific" access. Admins and
// unauthenticated users (fresh install) always get nil (all access).
func (s *Server) visibleCollectionIDs(r *http.Request, workspaceID string) ([]string, error) {
user := currentUser(r)
if user == nil || user.Role == "admin" {
return nil, nil // No filtering for admins or unauthenticated
}
return s.store.VisibleCollectionIDs(workspaceID, user.ID)
}
// requireItemVisible checks that the item's collection is visible to the
// requesting user. For guests with item-level grants, also verifies that the
// specific item is granted (not just the collection). Writes a 404 and returns
// false if not. Callers should invoke this immediately after resolving an item
// by slug/ID.
//
// Thin shim over checkItemVisible — see that helper for the rules. This
// wrapper exists for the legacy call-sites that already hold a *http.Request
// pre-populated by RequireWorkspaceAccess; new callers without that middleware
// (e.g. handlers_ref_resolver.go) should use checkItemVisible directly with
// a manually-derived role.
func (s *Server) requireItemVisible(w http.ResponseWriter, r *http.Request, workspaceID string, item *models.Item) bool {
visible, err := s.checkItemVisible(workspaceID, item, currentUser(r), workspaceRole(r))
if err != nil {
writeInternalError(w, err)
return false
}
if !visible {
writeError(w, http.StatusNotFound, "not_found", "Item not found")
return false
}
return true
}
// checkItemVisible is the context-free visibility decision. Returns (true,
// nil) when the (user, role) pair can see `item` under the same rules
// `requireItemVisible` enforces. Centralizes the rule set so the
// resolver route (IDEA-1492) and the middleware-gated handlers can't drift.
//
// Inputs:
//
// - workspaceID — the resolved workspace's UUID.
// - item — already-loaded item (so the helper doesn't re-resolve and
// accidentally apply a different lookup path).
// - user — currentUser(r) at the call site; nil for unauthenticated.
// - role — workspaceRole(r) at the call site, or the role derived
// manually by callers operating outside RequireWorkspaceAccess.
//
// Rules (in order):
//
// 1. Tokenized-nil-user bypass: when currentUser == nil AND role is one
// of the synthesized-by-middleware roles ("owner" for fresh-install,
// "editor" for legacy workspace-scoped API tokens),
// RequireWorkspaceAccess has already authorized the request — there
// is no per-user filter to apply, and the user-nil rejection at
// rule 2 would false-404 these callers. The bypass is SCOPED TO
// user == nil — real authenticated members with role "owner" /
// "editor" must still fall through to the per-collection filter,
// otherwise a restricted editor member would bypass their own
// collection_access="specific" gate (Codex round-3 regression of
// the round-2 P1.1 fix).
// 2. nil user past rule 1 → not visible. Anonymous viewers without a
// tokenized role have no item-read access (share links own the
// public-read surface via /s/{token}).
// 3. Admin user (user.Role == "admin") → always visible.
// 4. Otherwise: replay the guestResourceFilterCore + member-collection-
// access logic that requireItemVisible used to inline, with a system-
// collections union added to the item-grants branch (Codex round-2
// P1.2 — restricted members with conventions/playbooks access plus
// an unrelated item grant previously 404'd on system-collection items
// because the item-grants branch only checked direct grants + the
// member's explicit collection-access list).
func (s *Server) checkItemVisible(workspaceID string, item *models.Item, user *models.User, role string) (bool, error) {
// Tokenized-nil-user bypass. RequireWorkspaceAccess synthesizes
// "owner" on fresh installs (UserCount == 0, currentUser == nil) and
// "editor" for legacy workspace-scoped API tokens (currentUser ==
// nil but tokenWorkspaceID matches). Both are authorized by the
// middleware already. Real authenticated users with these roles
// (workspace owners, member.Role=="editor", …) must NOT short-circuit
// here — they have to walk the per-collection filter so
// collection_access="specific" + member_collection_access actually
// gates them (Codex round-3 — the round-2 fix dropped the
// `user == nil` qualifier and accidentally disabled the gate for
// every real editor too).
if user == nil && (role == "owner" || role == "editor") {
return true, nil
}
if user == nil {
return false, nil
}
// Admin sees everything (matches visibleCollectionIDs's nil-filter shape).
if user.Role == "admin" {
return true, nil
}
// Visibility filter: nil = unrestricted; non-nil = restricted to the slice.
visibleIDs, err := s.store.VisibleCollectionIDs(workspaceID, user.ID)
if err != nil {
return false, err
}
if !isCollectionVisible(item.CollectionID, visibleIDs) {
return false, nil
}
// Replay guestResourceFilterCore's logic without the *http.Request
// dependency. Member-with-all-access short-circuits to "no item-level
// filter"; guests + restricted members get the grant filter.
if role != "guest" {
member, err := s.store.GetWorkspaceMember(workspaceID, user.ID)
if err != nil {
return false, err
}
if member != nil && (member.CollectionAccess == "all" || member.CollectionAccess == "") {
// Full collection access — visibleIDs filter already passed.
return true, nil
}
}
grantCollIDs, grantedItemIDs, err := s.store.GuestVisibleResources(workspaceID, user.ID)
if err != nil {
return false, err
}
if len(grantedItemIDs) == 0 {
// No item-level grants in play. visibleCollectionIDs already
// determined the collection is reachable; visibility stands.
return true, nil
}
// Item-level grants are active. The item is visible when:
// a) the collection itself has a full grant (any item passes), OR
// b) for restricted members: the collection is in member_collection_access
// (the member's explicit collection-access list), OR
// c) the item's collection is a system collection — restricted
// members always retain access to system collections (conventions,
// playbooks, …); pre-round-2 this branch missed the system-
// collections union that guestResourceFilterCore performed, so a
// restricted member with an item grant in a non-system collection
// was 404'd on a system-collection item they were entitled to see.
// d) the specific item is in the granted-items list.
for _, id := range grantCollIDs {
if id == item.CollectionID {
return true, nil
}
}
if role != "guest" {
// member_collection_access path — restricted members see their
// explicit collection-access list as full grants alongside any
// item-level grants.
memberColls, err := s.store.GetMemberCollectionAccess(workspaceID, user.ID)
if err != nil {
return false, err
}
for _, id := range memberColls {
if id == item.CollectionID {
return true, nil
}
}
// System-collections union — mirror guestResourceFilterCore's
// pre-round-2 behavior. ListSystemCollectionIDs is a workspace-
// scoped lookup (no per-user filter), so the same call is correct
// for every restricted member in the workspace.
sysColls, err := s.store.ListSystemCollectionIDs(workspaceID)
if err != nil {
return false, err
}
for _, id := range sysColls {
if id == item.CollectionID {
return true, nil
}
}
}
for _, id := range grantedItemIDs {
if id == item.ID {
return true, nil
}
}
return false, nil
}
// isItemVisibleToGuest checks if an item is visible given grant-based access,
// considering both full-collection grants and individual item grants.
// When fullCollIDs and grantedItemIDs are both nil, always returns true (no grant filtering).
func (s *Server) isItemVisibleToGuest(r *http.Request, workspaceID string, item *models.Item, fullCollIDs, grantedItemIDs []string) bool {
if fullCollIDs == nil && grantedItemIDs == nil {
return true
}
// Full collection grant covers all items in the collection
for _, id := range fullCollIDs {
if id == item.CollectionID {
return true
}
}
// Otherwise, the specific item must be in the granted items list
for _, id := range grantedItemIDs {
if id == item.ID {
return true
}
}
return false
}
// guestResourceFilter returns the full-collection IDs and granted item IDs for
// the current user if they need item-level grant filtering. Returns nil/nil for:
// - unauthenticated users
// - admin users
// - members with "all" collection access (grants should merge, not replace)
// For guests: returns direct collection grants as fullCollIDs + item grants.
// For restricted members: returns member_collection_access + system collections
// + direct collection grants as fullCollIDs, plus item grants as grantedItemIDs.
// This ensures item grants are additive to the member's existing access.
func (s *Server) guestResourceFilter(r *http.Request, workspaceID string) (fullCollIDs, grantedItemIDs []string, err error) {
return s.guestResourceFilterCore(r, workspaceID, false)
}
// guestResourceFilterIncludeDeletedItems is the delta-sync variant
// of guestResourceFilter. It uses GuestVisibleResourcesIncludeDeleted
// under the hood so soft-deleted granted items still surface in the
// resulting ID set. Used by /items-changes (TASK-1354) so a guest /
// restricted member with an item-level grant still receives the
// `deleted:true` row when their granted item is soft-deleted —
// without this variant the grant ID vanishes before the delta
// query runs and the client keeps the stale entry forever (Codex
// review of TASK-1354 round 1 [P1]).
func (s *Server) guestResourceFilterIncludeDeletedItems(r *http.Request, workspaceID string) (fullCollIDs, grantedItemIDs []string, err error) {
return s.guestResourceFilterCore(r, workspaceID, true)
}
// guestResourceFilterCore is the shared implementation. The
// includeDeletedItems flag swaps the underlying store query.
func (s *Server) guestResourceFilterCore(r *http.Request, workspaceID string, includeDeletedItems bool) (fullCollIDs, grantedItemIDs []string, err error) {
user := currentUser(r)
if user == nil || user.Role == "admin" {
return nil, nil, nil
}
role := workspaceRole(r)
// For workspace members with "all" collection access, item grants should
// not restrict their existing full visibility.
if role != "guest" {
member, err := s.store.GetWorkspaceMember(workspaceID, user.ID)
if err != nil {
return nil, nil, err
}
if member != nil && (member.CollectionAccess == "all" || member.CollectionAccess == "") {
return nil, nil, nil
}
}
// Get grant-based resources — delta-sync callers ask for the
// include-deleted variant so tombstones can flow through.
var grantCollIDs []string
if includeDeletedItems {
grantCollIDs, grantedItemIDs, err = s.store.GuestVisibleResourcesIncludeDeleted(workspaceID, user.ID)
} else {
grantCollIDs, grantedItemIDs, err = s.store.GuestVisibleResources(workspaceID, user.ID)
}
if err != nil {
return nil, nil, err
}
// For guests, grant resources are the only source of access
if role == "guest" {
return grantCollIDs, grantedItemIDs, nil
}
// For restricted members ("specific" access), merge their normal
// member_collection_access + system collections into fullCollIDs so
// item grants are additive, not a replacement. This is critical:
// without this merge, a member with access to collection A plus one
// item grant in collection B would lose collection A in cross-collection
// queries that use these IDs.
fullCollSet := make(map[string]bool)
for _, id := range grantCollIDs {
fullCollSet[id] = true
}
// Add member_collection_access collections
memberColls, err := s.store.GetMemberCollectionAccess(workspaceID, user.ID)
if err != nil {
return nil, nil, err
}
for _, id := range memberColls {
fullCollSet[id] = true
}
// Add system collections (always visible to members)
sysColls, err := s.store.ListSystemCollectionIDs(workspaceID)
if err != nil {
return nil, nil, err
}
for _, id := range sysColls {
fullCollSet[id] = true
}
fullCollIDs = make([]string, 0, len(fullCollSet))
for id := range fullCollSet {
fullCollIDs = append(fullCollIDs, id)
}
return fullCollIDs, grantedItemIDs, nil
}
// isCollectionVisible checks if a collection ID is in the visible set.
// If visibleIDs is nil, all collections are visible.
func isCollectionVisible(collectionID string, visibleIDs []string) bool {
if visibleIDs == nil {
return true
}
for _, id := range visibleIDs {
if id == collectionID {
return true
}
}
return false
}
// requireEditPermission checks if the user has edit access to the given item.
// For regular members (editor/owner), this uses the standard role check.
// For members with insufficient roles (e.g., viewers), it falls back to
// grant-based permissions so grants can override the base role.
// For guests, it resolves the effective permission from grants directly.
// Returns true if the request should continue, false if it was rejected with a 403.
func (s *Server) requireEditPermission(w http.ResponseWriter, r *http.Request, workspaceID string, itemID, collectionID string) bool {
role := workspaceRole(r)
// Editors and owners always have edit access
if role != "guest" && requireRole(r, "editor") {
return true
}
// For guests and members with insufficient role (e.g., viewers),
// check grant-based permissions as an override.
user := currentUser(r)
if user == nil {
writeError(w, http.StatusForbidden, "forbidden", "Insufficient permissions")
return false
}
perm, err := s.store.ResolveUserPermission(workspaceID, user.ID, itemID, collectionID)
if err != nil {
writeInternalError(w, err)
return false
}
if permissionLevel(perm) < permissionLevel("edit") {
writeError(w, http.StatusForbidden, "forbidden", "Insufficient permissions")
return false
}
return true
}
// resolveWorkspace resolves a workspace by slug or UUID, scoped to the
// authenticated user's accessible workspaces when a user context is present.
// Returns nil (not an error) if no workspace is found.
func (s *Server) resolveWorkspace(slugOrID string, user *models.User) (*models.Workspace, error) {
// 1. Is it a UUID? Try resolving by ID first, then fall back to slug.
// A workspace slug could be UUID-shaped (e.g. imported data), so we
// can't short-circuit here.
if isUUID(slugOrID) {
ws, err := s.store.GetWorkspaceByID(slugOrID)
if ws != nil || err != nil {
return ws, err
}
// Not found by ID — fall through to slug-based resolution
}
// 2. No authenticated user — fall back to global slug lookup
// (fresh install, or pre-auth paths)
if user == nil {
return s.store.GetWorkspaceBySlug(slugOrID)
}
// 3. Admin users — global slug lookup (admins can see all workspaces)
if user.Role == "admin" {
return s.store.GetWorkspaceBySlug(slugOrID)
}
// 4. Auth-scoped slug resolution: find workspaces where user is owner or member
workspaces, err := s.store.GetWorkspacesBySlugForUser(slugOrID, user.ID)
if err != nil {
return nil, err
}
if len(workspaces) == 1 {
return &workspaces[0], nil
}
if len(workspaces) == 0 {
return nil, nil
}
// Ambiguous: multiple workspaces match — this should be rare.
// For now, return the first one. The 409 disambiguation is only needed
// when we actually have per-owner slug uniqueness (after the unique
// constraint is changed). Currently slugs are globally unique.
return &workspaces[0], nil
}
// isUUID is defined in handlers_items.go
// getWorkspaceDocument resolves workspace slug and document ID from URL params.
func (s *Server) getWorkspaceDocument(w http.ResponseWriter, r *http.Request) (string, *models.Document, bool) {
workspaceID, ok := s.getWorkspaceID(w, r)
if !ok {
return "", nil, false
}
docID := chi.URLParam(r, "docID")
doc, err := s.store.GetDocument(docID)
if err != nil {
writeInternalError(w, err)
return "", nil, false
}
if doc == nil || doc.WorkspaceID != workspaceID {
writeError(w, http.StatusNotFound, "not_found", "Document not found")
return "", nil, false
}
return workspaceID, doc, true
}