Files
OwnCord/Server/ws/deps.go
T

311 lines
14 KiB
Go
Raw Normal View History

package ws
import (
"context"
"log/slog"
"github.com/J3vb/OwnCord/Server/auth"
"github.com/J3vb/OwnCord/Server/db"
"github.com/J3vb/OwnCord/Server/permissions"
"github.com/J3vb/OwnCord/Server/plugin"
"github.com/J3vb/OwnCord/Server/service"
)
// ClientInfo holds a read-only snapshot of client state for V2 handlers.
// Handlers receive this instead of a mutable *Client pointer, making them
// easier to test and reason about.
type ClientInfo struct {
2026-08-01 22:06:14 +02:00
UserID int64
Username string
Avatar *string
// DisplayName is the connection's nickname, nil when unset. Carried
// alongside Username rather than replacing it: renderers fall back to the
// username, and mentions still resolve against it.
DisplayName *string
RoleName string
ReqID string
VoiceChannelID int64 // 0 if not in a voice channel
VoiceJoinToken string // opaque join-instance token for the current voice session
}
// ── Per-domain dependency structs ───────────────────────────────────────────
// PingDeps holds dependencies for the ping handler.
type PingDeps struct {
Limiter *auth.RateLimiter
}
// ChatDeps holds dependencies for chat handlers.
type ChatDeps struct {
Limiter *auth.RateLimiter
MessageSvc *service.MessageService
}
// PresenceDeps holds dependencies for presence, typing, and channel focus handlers.
type PresenceDeps struct {
Limiter *auth.RateLimiter
ChannelSvc *service.ChannelService
}
// ReactionDeps holds dependencies for reaction handlers.
type ReactionDeps struct {
MessageSvc *service.MessageService
}
// VoiceTokenGenerator generates LiveKit access tokens. Abstracted so V2
// handlers can be tested without a real LiveKit server.
type VoiceTokenGenerator interface {
GenerateToken(userID int64, username string, channelID int64, voiceJoinToken string, canPublish, canSubscribe, canVideo, canScreenShare bool) (string, error)
URL() string
}
2026-08-01 22:06:14 +02:00
// VoiceModerator applies the effects of a voice moderation action that reach
// past the acting connection: the SFU and the target's own socket. *Hub
// implements it, and VoiceDeps carries the Hub itself so SetLiveKit's late
// wiring is picked up at call time (same reason as VoiceTokenGenerator).
type VoiceModerator interface {
// MuteParticipant mutes or unmutes the target's published audio at the SFU.
MuteParticipant(ctx context.Context, channelID, userID int64, voiceJoinToken string, muted bool) error
// DisconnectFromVoice runs the voice-leave routine for the target's
// connection. Reports false when the target has no connection on this node.
DisconnectFromVoice(ctx context.Context, userID int64) bool
// SendToUser delivers one server->client frame to the target.
SendToUser(userID int64, msg []byte) bool
}
// KeyHolderChecker reports whether a user is the E2EE key holder for a voice channel.
type KeyHolderChecker interface {
IsVoiceKeyHolder(channelID, userID int64) bool
}
// PluginDeps holds dependencies for the chat_command (plugin slash-command)
// handler. Registry is a getter, not a captured value, because the plugin
// registry is wired via SetPluginRegistry AFTER NewHub builds the deps; reading
// it live at dispatch time picks up the late wiring. MessageSvc gates channel
// broadcasts through the same posting policy as a real message send.
type PluginDeps struct {
Registry func() CommandDispatcher
MessageSvc *service.MessageService
Limiter *auth.RateLimiter
}
// CommandDispatcher is the one method the chat_command handler needs from the
// plugin registry; *plugin.Registry satisfies it. Taking the interface rather
// than the concrete type is what makes the broadcast path testable: without
// the wazero build tag a real registry has no runtime and can only ever answer
// with a Reply, so the CanPost gate would otherwise be unreachable from a test.
type CommandDispatcher interface {
DispatchCommand(ctx context.Context, userID, channelID int64, cmd string, args []string) (*plugin.CommandResult, bool)
}
// VoiceDeps holds dependencies for voice handlers.
type VoiceDeps struct {
DB *db.DB
Limiter *auth.RateLimiter
Permissions *permissions.Checker
// PermSvc is the cached permission service. When non-nil the permission
// helpers below answer from its per-user cache instead of per-call role and
// override queries; when nil (tests constructing bare deps) they keep the
// live DB path and fail closed exactly as before.
PermSvc *service.PermissionService
LiveKit *LiveKitClient
TokenGen VoiceTokenGenerator // used by voice_token_refresh V2
KeyHolder KeyHolderChecker // used by voice_token_refresh V2
2026-08-01 22:06:14 +02:00
Mod VoiceModerator // used by the voice moderation handlers
}
// ── V2 permission helpers ───────────────────────────────────────────────────
// requirePerm checks a channel permission. Returns nil if allowed, or a Result
// carrying either an INTERNAL error (when the server is misconfigured or a DB
// lookup fails) or a FORBIDDEN error (when the permission bit is genuinely
// absent from the user's role). Previously every branch returned FORBIDDEN,
// which hid operator-visible failures behind a user-facing permission denial.
//
// A positive verdict from the cached PermissionService is taken as-is (grants
// are invalidated synchronously at every mutation site, so it cannot be a
// stale allow beyond the invalidation contract). A negative verdict falls
// through to the live path because the cache's boolean cannot express the
// INTERNAL-vs-FORBIDDEN distinction above — denials are the rare case, so the
// extra lookups only happen when the check is about to fail anyway.
func requirePerm(ctx context.Context, database *db.DB, perms *permissions.Checker, permSvc *service.PermissionService, userID, channelID, perm int64, label string) *Result {
if permSvc != nil && permSvc.HasChannelPerm(ctx, userID, channelID, perm) {
return nil
}
if database == nil || perms == nil {
// Missing dependency is a server bug, not a user ACL outcome. Log
// here so operators see something even when the client surfaces a
// generic error.
slog.Error("ws: requirePerm called with nil dependency",
"have_database", database != nil, "have_perms", perms != nil, "label", label)
r := Result{Error: ClientError{Code: ErrCodeInternal, Message: "permission check unavailable"}}
return &r
}
role, err := database.GetRoleForUser(ctx, userID)
if err != nil {
slog.Error("ws: requirePerm GetRoleForUser failed",
"user_id", userID, "channel_id", channelID, "err", err)
r := Result{Error: ClientError{Code: ErrCodeInternal, Message: "permission check failed"}}
return &r
}
if role == nil {
// No role row is a genuine ACL outcome (no role == no perms).
r := Result{Error: ClientError{Code: ErrCodeForbidden, Message: "missing " + label + " permission"}}
return &r
}
2026-08-01 22:06:14 +02:00
if !perms.HasChannelPerm(ctx, role.Permissions, role.ID, userID, channelID, perm) {
r := Result{Error: ClientError{Code: ErrCodeForbidden, Message: "missing " + label + " permission"}}
return &r
}
return nil
}
// hasPerm checks a channel permission. Returns true if allowed. With a
// PermissionService the answer comes from its per-user cache (false on any
// lookup failure, same fail-closed posture as the live path); without one it
// falls back to per-call DB lookups.
func hasPerm(ctx context.Context, database *db.DB, perms *permissions.Checker, permSvc *service.PermissionService, userID, channelID, perm int64) bool {
if permSvc != nil {
return permSvc.HasChannelPerm(ctx, userID, channelID, perm)
}
if database == nil || perms == nil {
return false
}
role, err := database.GetRoleForUser(ctx, userID)
if err != nil || role == nil {
return false
}
2026-08-01 22:06:14 +02:00
return perms.HasChannelPerm(ctx, role.Permissions, role.ID, userID, channelID, perm)
}
// hasPermChecked is hasPerm's error-preserving counterpart: it distinguishes
// "the role/override lookup failed" (err != nil, verdict meaningless) from
// "the lookup answered and the bit is absent" (false, nil error). hasPerm and
// hasChannelAccess both collapse that distinction to a fail-closed false,
// which is the correct posture for every gate that sends FORBIDDEN on denial
// (requireChannelAccess, requirePerm, and friends) — do not route those
// through this helper. It exists for a caller like applySetChannelID's
// post-Subscribe revalidation (OC-0266), which documents that a transient
// lookup error must NOT be treated as a denial: unwinding on a DB hiccup
// would silently kill the channel's live message stream with no error frame
// ever sent to the client.
func hasPermChecked(ctx context.Context, database *db.DB, perms *permissions.Checker, permSvc *service.PermissionService, userID, channelID, perm int64) (bool, error) {
if permSvc != nil {
return permSvc.HasChannelPermChecked(ctx, userID, channelID, perm)
}
if database == nil || perms == nil {
return false, nil
}
role, err := database.GetRoleForUser(ctx, userID)
if err != nil {
return false, err
}
if role == nil {
return false, nil
}
return perms.HasChannelPerm(ctx, role.Permissions, role.ID, userID, channelID, perm), nil
}
// hasChannelAccess is the gate to use when the channel id comes from the client:
// it is hasPerm plus the channel-type branch that role bits cannot express.
//
// A DM channel carries no channel_overrides rows, so a default Member's base
// bits satisfy hasPerm for ANY dm channel id — including a conversation the
// caller is not part of. permissions.Checker.RequireChannelAccess is the shared
// definition of channel access (service.PermissionService.RequireChannelAccess
// mirrors it for the REST/service paths) and supplies the IsDMParticipant
// branch, so the DM membership rule keeps exactly one implementation. Group DMs
// need no special case: dm_participants holds one row per participant and
// IsDMParticipant is a lookup on (user_id, channel_id).
//
// The role bit is still required on top, which RequireChannelAccess waives for
// DMs. Voice has always demanded CONNECT_VOICE and sweepStaleVoiceStates keeps
// re-checking it per role for every live participant, so keeping it here means
// this check can only ever narrow access — never hand someone a grant the old
// role-only check refused, and never let the sweeper evict a client the join
// gate admitted.
//
// Blocking is deliberately not consulted here: it is the message paths' rule
// (service.requireDMNotBlocked), it is two-party only, and a blocked user is
// still a participant, so it is orthogonal to the non-participant hole this
// closes.
//
// With a PermissionService the role-bit gate is answered from its per-user
// cache (the channel-type lookup and the DM membership check stay live —
// dm_participants rows are membership, not permission, state and are never
// cached). Both branches enforce the same rule: role bit required on top, DM
// membership via the single shared IsDMParticipant definition.
func hasChannelAccess(ctx context.Context, database *db.DB, perms *permissions.Checker, permSvc *service.PermissionService, userID, channelID, perm int64) bool {
if database == nil {
return false
}
if permSvc == nil {
return hasChannelAccessLive(ctx, database, perms, userID, channelID, perm)
}
if !permSvc.HasChannelPerm(ctx, userID, channelID, perm) {
return false
}
ch, err := database.GetChannel(ctx, channelID)
if err != nil {
// Fail closed: an unknown type would silently take the non-DM path.
slog.Error("ws: hasChannelAccess GetChannel failed, denying",
"user_id", userID, "channel_id", channelID, "err", err)
return false
}
// A missing channel row takes the non-DM branch, i.e. the role verdict
// above stands: there is no DM there to join, and callers keep reporting a
// deleted channel the way they always have.
if ch == nil || ch.Type != "dm" {
return true
}
// DM: for "dm" the service's RequireChannelAccess is exactly the
// IsDMParticipant membership rule (it waives the role check, which was
// already enforced above).
return permSvc.RequireChannelAccess(ctx, userID, ch.Type, channelID, perm) == nil
}
// hasChannelAccessLive is the uncached hasChannelAccess path, kept verbatim for
// hubs and deps constructed without a PermissionService (bare test fixtures).
func hasChannelAccessLive(ctx context.Context, database *db.DB, perms *permissions.Checker, userID, channelID, perm int64) bool {
if database == nil || perms == nil {
return false
}
role, err := database.GetRoleForUser(ctx, userID)
if err != nil || role == nil {
return false
}
2026-08-01 22:06:14 +02:00
if !perms.HasChannelPerm(ctx, role.Permissions, role.ID, userID, channelID, perm) {
return false
}
ch, err := database.GetChannel(ctx, channelID)
if err != nil {
// Fail closed: an unknown type would silently take the non-DM path.
slog.Error("ws: hasChannelAccess GetChannel failed, denying",
"user_id", userID, "channel_id", channelID, "err", err)
return false
}
// A missing channel row takes the non-DM branch, i.e. the role verdict
// above stands: there is no DM there to join, and callers keep reporting a
// deleted channel the way they always have.
if ch == nil || ch.Type != "dm" {
// For every non-DM type, RequireChannelAccess is defined as exactly the
// HasChannelPerm call already made above, so re-invoking it would only
// repeat the same override lookup. The role verdict is the answer.
return true
}
// DM: the role bit above stays required on top; the membership rule keeps
// its single shared definition in RequireChannelAccess (IsDMParticipant),
// which waives the role check for DMs.
return perms.RequireChannelAccess(ctx, userID, role.Permissions, role.ID, ch.Type, channelID, perm) == nil
}
// ── V2 handler type ─────────────────────────────────────────────────────────
// HandlerV2 is the function signature for new-style (pure-ish) handlers.
// They receive a typed Command, a read-only ClientInfo snapshot, and a
// domain-specific deps struct (passed as any; handler asserts the concrete type).
// They return a Result describing what events to emit and any error.
// TODO: consider replacing `deps any` with generics (HandlerV2[D any]) to get
// compile-time type safety on deps wiring. Requires reworking the registry map.
type HandlerV2 func(ctx context.Context, cmd Command, info ClientInfo, deps any) Result