webapi_session.go 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829
  1. package state
  2. import (
  3. "bytes"
  4. "context"
  5. "crypto/rand"
  6. "encoding/hex"
  7. "errors"
  8. "log/slog"
  9. mrand "math/rand/v2"
  10. "strconv"
  11. "sync"
  12. "time"
  13. "github.com/mk6i/open-oscar-server/server/webapi/types"
  14. "github.com/mk6i/open-oscar-server/wire"
  15. )
  16. var (
  17. // ErrNoWebAPISession is returned when a WebAPI session is not found.
  18. ErrNoWebAPISession = errors.New("WebAPI session not found")
  19. // ErrWebAPISessionExpired is returned when a WebAPI session has expired.
  20. ErrWebAPISessionExpired = errors.New("WebAPI session expired")
  21. // ErrWebAPISessionManagerClosed is returned when a session is requested from
  22. // a manager that has been shut down.
  23. ErrWebAPISessionManagerClosed = errors.New("WebAPI session manager is shut down")
  24. )
  25. // Web API session lifecycle timeline.
  26. //
  27. // A web client keeps its session alive by long-polling GET /aim/fetchEvents.
  28. // Every authenticated request touches the session (middleware.RequireSession
  29. // calls TouchSession at request arrival), sliding expiry to now + the TTL. A
  30. // single poll blocks for up to 60s (the fetchEvents long-poll cap) and the
  31. // client waits ~500ms (TimeToNextFetch) before re-polling, so in steady state a
  32. // healthy client touches the session at worst every ~60-65s once jitter is
  33. // included. That worst-case touch interval is the floor the TTL must clear.
  34. //
  35. // If a client hangs up without calling endSession, its last touch was at its
  36. // last poll: the session then expires webAPISessionTTL later and the reaper
  37. // sweeps it within one webAPISessionReapInterval tick. So a silent client is
  38. // removed (and its OSCAR session closed) within TTL + tick of going quiet.
  39. const (
  40. // webAPISessionTTL bounds how long a session survives without a poll. It is
  41. // sized to absorb one missed poll cycle: ~60s for the normal cycle, ~60s for
  42. // the absorbed miss, plus ~20s of jitter margin. Two consecutive misses mean
  43. // the client is genuinely gone and the session is reaped.
  44. webAPISessionTTL = 150 * time.Second
  45. // webAPISessionReapInterval is how often the cleanup goroutine sweeps for
  46. // expired sessions (~TTL/5). A dead session lingers at most
  47. // webAPISessionTTL + webAPISessionReapInterval before removal.
  48. webAPISessionReapInterval = 30 * time.Second
  49. )
  50. // WebAPISession represents an active Web AIM API session.
  51. type WebAPISession struct {
  52. AimSID string // Unique session ID for web client
  53. ScreenName DisplayScreenName // User identity
  54. OSCARSession *SessionInstance // Bridge to existing OSCAR session
  55. OSCARCookie []byte // OSCAR auth cookie for the startOSCARSession handoff
  56. BOSHost string // BOS host advertised to the web client
  57. BOSPort int // BOS port advertised to the web client
  58. UseSSL bool // Whether the handoff advertised an SSL BOS connection
  59. BaseURL string // Web API base URL advertised to the web client, used to build absolute asset URLs
  60. Events []string // Subscribed event types
  61. EventQueue *types.EventQueue // Per-session event queue
  62. DevID string // Developer ID that created this session
  63. ClientName string // Client application name
  64. ClientVersion string // Client application version
  65. CreatedAt time.Time // SessionInstance creation time
  66. LastAccessed time.Time // Last activity time
  67. ExpiresAt time.Time // SessionInstance expiration time
  68. FetchTimeout int // Long-polling timeout in milliseconds
  69. TimeToNextFetch int // Suggested delay before next fetch
  70. RemoteAddr string // Client IP address
  71. TempBuddies map[string]bool // Temporary buddies for this session only
  72. BuddyListRefresher func(ctx context.Context) (interface{}, error) // Called on feedbag changes to push buddylist event
  73. PermitDenyRefresher func(ctx context.Context) (interface{}, error) // Called on feedbag changes to push permitDeny event
  74. MyInfoRefresher func(ctx context.Context) (interface{}, error) // Called on self user-info updates (e.g. icon change) to push myInfo event
  75. BuddyAliasLoader func(ctx context.Context) (map[string]string, error)
  76. // BuddyIconURL formats the absolute buddyIcon URL for a buddy from the icon
  77. // hash carried in a presence SNAC. Returns "" when no URL can be published.
  78. BuddyIconURL func(screenName IdentScreenName, hash []byte) string
  79. aliases map[string]string // cached BuddyAliasLoader result, nil when unloaded or invalidated
  80. aliasMu sync.Mutex
  81. imLog map[string][]WebAPIStoredIM
  82. imLogMu sync.Mutex
  83. // IMRateClassID is the rate class that sending an IM spends. The web client
  84. // renders any rate limit event as the IM banner, so only this class's updates
  85. // may reach it. Zero disables the alert.
  86. IMRateClassID wire.RateLimitClassID
  87. logger *slog.Logger // Logger for debugging
  88. listeners sync.WaitGroup
  89. ctx context.Context
  90. cancel context.CancelFunc
  91. closeMu sync.Mutex
  92. closed bool
  93. }
  94. // IsExpired checks if the session has expired.
  95. func (s *WebAPISession) IsExpired() bool {
  96. return time.Now().After(s.ExpiresAt)
  97. }
  98. // Aliases returns this session owner's private buddy aliases, keyed by normalized
  99. // screen name. Aliases live in the owner's feedbag, so the map is loaded once and
  100. // cached until a feedbag change invalidates it: a signon that brings a large buddy
  101. // list online costs one feedbag query instead of one per buddy.
  102. //
  103. // The map is owned by the session and must not be mutated by callers.
  104. //
  105. // aliasMu is deliberately held across the load rather than released while the
  106. // feedbag is queried. Another instance of the owner can rename a buddy mid-query,
  107. // and its FeedbagUpdateItem SNAC invalidates this cache; if the load ran outside
  108. // the lock, that query's pre-rename result could be stored *after* the
  109. // invalidation and serve the old alias until the next feedbag change. Holding the
  110. // lock makes the invalidation wait for the load and then win.
  111. func (s *WebAPISession) Aliases(ctx context.Context) map[string]string {
  112. s.aliasMu.Lock()
  113. defer s.aliasMu.Unlock()
  114. // The loader is wired after the session is created, so an event arriving in
  115. // that window has no way to resolve aliases.
  116. if s.BuddyAliasLoader == nil {
  117. return nil
  118. }
  119. if s.aliases == nil {
  120. aliases, err := s.BuddyAliasLoader(ctx)
  121. if err != nil {
  122. s.logger.Error("failed to load buddy aliases", "err", err.Error())
  123. return nil
  124. }
  125. s.aliases = aliases
  126. }
  127. return s.aliases
  128. }
  129. // InvalidateAliases drops the cached alias map so the next Aliases call reloads it.
  130. // Callers that change the owner's feedbag must call this: the feedbag service
  131. // relays FeedbagUpdateItem only to the owner's *other* instances, so a session
  132. // never sees a SNAC for its own writes.
  133. func (s *WebAPISession) InvalidateAliases() {
  134. s.aliasMu.Lock()
  135. defer s.aliasMu.Unlock()
  136. s.aliases = nil
  137. }
  138. // aliasFor returns this session owner's private alias for buddy, or "" when none is
  139. // set. The web client deletes the alias it holds whenever it merges a user map, so
  140. // every event naming a buddy has to repeat it.
  141. func (s *WebAPISession) aliasFor(buddy IdentScreenName) string {
  142. // Runs on the SNAC listener goroutine, which has no request context.
  143. return s.Aliases(s.ctx)[buddy.String()]
  144. }
  145. // Touch updates the last accessed time and extends expiration if needed.
  146. func (s *WebAPISession) Touch() {
  147. s.LastAccessed = time.Now()
  148. newExpiry := s.LastAccessed.Add(webAPISessionTTL)
  149. if newExpiry.After(s.ExpiresAt) {
  150. s.ExpiresAt = newExpiry
  151. }
  152. }
  153. // IsSubscribedTo checks if the session is subscribed to a specific event type.
  154. func (s *WebAPISession) IsSubscribedTo(eventType string) bool {
  155. for _, event := range s.Events {
  156. if event == eventType {
  157. return true
  158. }
  159. }
  160. return false
  161. }
  162. // StartListeningToOSCARSession starts a goroutine that listens to the OSCAR session's
  163. // message channel and converts SNAC messages into WebAPI events.
  164. func (s *WebAPISession) StartListeningToOSCARSession() {
  165. s.closeMu.Lock()
  166. defer s.closeMu.Unlock()
  167. if s.closed {
  168. return
  169. }
  170. s.listeners.Add(1)
  171. go func() {
  172. defer s.listeners.Done()
  173. msgCh := s.OSCARSession.ReceiveMessage()
  174. for {
  175. select {
  176. case msg, ok := <-msgCh:
  177. if !ok {
  178. // Channel closed, OSCAR session ended
  179. return
  180. }
  181. s.handleSNACMessage(msg)
  182. case <-s.OSCARSession.Closed():
  183. // The OSCAR instance went away without this session asking — a
  184. // boot, a rate-limit disconnect. Tell the client rather than
  185. // leaving its parked fetcher to hang: a sessionEnded event
  186. // releases the poll at once and the client signs off on the
  187. // spot, instead of waiting out the reaper's next sweep.
  188. //
  189. // A teardown this session started needs no event, and gets
  190. // none: Close closes the queue before it closes the instance,
  191. // so this Push is a no-op on that path.
  192. s.EventQueue.Push(types.EventTypeSessionEnded, struct{}{})
  193. return
  194. }
  195. }
  196. }()
  197. }
  198. // Close tears down the session: it releases any parked event fetchers, closes
  199. // the OSCAR instance, and waits for the listener goroutine to unwind. Safe to
  200. // call more than once.
  201. func (s *WebAPISession) Close() {
  202. s.closeMu.Lock()
  203. if s.closed {
  204. s.closeMu.Unlock()
  205. return
  206. }
  207. s.closed = true
  208. s.closeMu.Unlock()
  209. s.EventQueue.Close()
  210. s.OSCARSession.CloseInstance()
  211. s.cancel()
  212. s.listeners.Wait()
  213. }
  214. // handleSNACMessage converts a SNAC message into WebAPI events and pushes them to the event queue.
  215. func (s *WebAPISession) handleSNACMessage(msg wire.SNACMessage) {
  216. // Convert SNAC message to WebAPI events based on food group and subgroup
  217. switch msg.Frame.FoodGroup {
  218. case wire.ICBM:
  219. s.handleICBMMessage(msg)
  220. case wire.Buddy:
  221. s.handleBuddyMessage(msg)
  222. case wire.Feedbag:
  223. s.handleFeedbagMessage(msg)
  224. case wire.OService:
  225. s.handleOServiceMessage(msg)
  226. }
  227. }
  228. // handleOServiceMessage handles OService SNAC messages relayed to the session's
  229. // own OSCAR instance.
  230. func (s *WebAPISession) handleOServiceMessage(msg wire.SNACMessage) {
  231. switch msg.Frame.SubGroup {
  232. case wire.OServiceUserInfoUpdate:
  233. s.handleUserInfoUpdate(msg)
  234. case wire.OServiceRateParamChange:
  235. s.handleRateLimitUpdate(msg)
  236. }
  237. }
  238. // handleUserInfoUpdate surfaces OServiceUserInfoUpdate, which the server relays to
  239. // a user when their own user info changes (notably a buddy icon upload or clear).
  240. // The client re-renders its identity badge from myInfo events only, so we
  241. // translate this into a fresh myInfo.
  242. func (s *WebAPISession) handleUserInfoUpdate(msg wire.SNACMessage) {
  243. if !s.IsSubscribedTo("myInfo") && !s.IsSubscribedTo("presence") {
  244. return
  245. }
  246. if s.MyInfoRefresher == nil {
  247. return
  248. }
  249. data, err := s.MyInfoRefresher(s.ctx)
  250. if err != nil {
  251. s.logger.Error("failed to refresh myInfo after user-info update", "err", err)
  252. return
  253. }
  254. s.EventQueue.Push(types.EventType("myInfo"), data)
  255. }
  256. // handleRateLimitUpdate translates a rate limit status change — broadcast by the
  257. // account's rate limit monitor — into a rateLimit event. Only the IM class is
  258. // surfaced, since the client feeds any rateLimit event into the
  259. // conversation-window alert. Code 1 is a class-params change, not a status
  260. // transition, and is ignored.
  261. func (s *WebAPISession) handleRateLimitUpdate(msg wire.SNACMessage) {
  262. if s.IMRateClassID == 0 {
  263. return
  264. }
  265. body, ok := msg.Body.(wire.SNAC_0x01_0x0A_OServiceRateParamsChange)
  266. if !ok {
  267. return
  268. }
  269. if wire.RateLimitClassID(body.Rate.ID) != s.IMRateClassID {
  270. return
  271. }
  272. var status string
  273. switch body.Code {
  274. case 2:
  275. status = "warn"
  276. case 3:
  277. status = "limit"
  278. case 4:
  279. status = "clear"
  280. default:
  281. return
  282. }
  283. s.EventQueue.Push(types.EventTypeRateLimit, types.RateLimitEvent{
  284. Classes: []types.RateLimitClass{
  285. {ID: int(body.Rate.ID), Status: status},
  286. },
  287. })
  288. }
  289. // handleICBMMessage handles ICBM (instant messaging) SNAC messages.
  290. func (s *WebAPISession) handleICBMMessage(msg wire.SNACMessage) {
  291. switch msg.Frame.SubGroup {
  292. case wire.ICBMChannelMsgToClient:
  293. s.handleIncomingIM(msg)
  294. case wire.ICBMClientEvent:
  295. s.handleTypingNotification(msg)
  296. }
  297. }
  298. // handleIncomingIM handles incoming instant messages.
  299. func (s *WebAPISession) handleIncomingIM(msg wire.SNACMessage) {
  300. body, ok := msg.Body.(wire.SNAC_0x04_0x07_ICBMChannelMsgToClient)
  301. if !ok {
  302. return
  303. }
  304. // A send time is only stamped on a message replayed out of the offline store,
  305. // so its presence marks this as a delivery of something sent while the user was
  306. // signed off, and carries the moment the sender actually sent it.
  307. sentTime, isOffline := body.Uint32BE(wire.ICBMTLVSendTime)
  308. // Retrieval answers only the instance that asked, and StartSession asks only
  309. // when the client subscribed to offlineIM, so a stamped message here is one
  310. // this session requested. A live IM still needs the im subscription.
  311. if !isOffline && !s.IsSubscribedTo("im") {
  312. return
  313. }
  314. // Extract message text from TLV data
  315. var messageText string
  316. if msgData, hasMsg := body.Bytes(wire.ICBMTLVAOLIMData); hasMsg {
  317. if text, err := wire.UnmarshalICBMMessageText(msgData); err == nil {
  318. messageText = text
  319. }
  320. }
  321. if messageText == "" {
  322. return
  323. }
  324. // Check if it's an auto-response (channel 2)
  325. autoResponse := body.ChannelID == 0x0002
  326. // msgId must be unique per delivered event. The OSCAR cookie is not a
  327. // reliable unique id (some clients reuse it across messages), and the web
  328. // client dedupes its conversation list by msgId, silently dropping any
  329. // collisions. Mint a fresh random id instead of reusing body.Cookie.
  330. msgID := strconv.FormatUint(mrand.Uint64(), 16)
  331. // SNAC user info carries the sender's display screen name. The web client
  332. // keys conversations and users by the normalized aimId and only renders
  333. // displayId, so the two forms must not be interchanged.
  334. partnerDisplay := body.ScreenName
  335. partnerAimID := NewIdentScreenName(partnerDisplay).String()
  336. // An offline message is logged under the time it was sent, so the stored-IM
  337. // history it lands in stays in the order the conversation happened.
  338. timestamp := time.Now().Unix()
  339. if isOffline {
  340. timestamp = int64(sentTime)
  341. }
  342. s.AddStoredIM(partnerAimID, partnerAimID, messageText, msgID, timestamp)
  343. if isOffline {
  344. s.EventQueue.Push(types.EventTypeOfflineIM, types.OfflineIMEvent{
  345. AimID: partnerAimID,
  346. Message: messageText,
  347. MsgID: msgID,
  348. Timestamp: float64(timestamp),
  349. AutoResp: autoResponse,
  350. })
  351. s.logger.Debug("delivered offline instant message",
  352. "from", partnerDisplay,
  353. "to", s.ScreenName,
  354. "sent", timestamp)
  355. } else {
  356. s.EventQueue.Push(types.EventTypeIM, types.IMEvent{
  357. Source: types.UserInfo{
  358. AimID: partnerAimID,
  359. DisplayID: partnerDisplay,
  360. Friendly: s.aliasFor(NewIdentScreenName(partnerAimID)),
  361. UserType: "aim",
  362. State: "online",
  363. },
  364. Message: messageText,
  365. MsgID: msgID,
  366. Timestamp: float64(timestamp),
  367. AutoResp: autoResponse,
  368. })
  369. s.logger.Debug("delivered instant message",
  370. "from", partnerDisplay,
  371. "to", s.ScreenName)
  372. }
  373. if s.IsSubscribedTo("conversation") {
  374. // unread is 0 here, not 1, because the "im"/"offlineIM" event pushed above
  375. // already causes the client to increment its own persisted per-buddy unread
  376. // tally. The "Recent chats" badge is the sum of that persisted tally and
  377. // this conversation's unreadCount, so sending 1 here would double-count
  378. // the message (badge shows 2 for the first IM). Mirrors the sent-IM path,
  379. // which also passes 0.
  380. s.EventQueue.Push(types.EventTypeConversation, types.ConversationEventData("update", []types.ConversationEntryData{
  381. types.ConversationEntry(
  382. partnerAimID,
  383. partnerDisplay,
  384. messageText,
  385. msgID,
  386. partnerAimID,
  387. false,
  388. 0,
  389. ),
  390. }))
  391. }
  392. }
  393. // handleTypingNotification handles typing notifications.
  394. func (s *WebAPISession) handleTypingNotification(msg wire.SNACMessage) {
  395. if !s.IsSubscribedTo("typing") {
  396. return
  397. }
  398. body, ok := msg.Body.(wire.SNAC_0x04_0x14_ICBMClientEvent)
  399. if !ok {
  400. return
  401. }
  402. // Event types: 0x0000=none, 0x0001=typed (paused), 0x0002=typing
  403. var typingStatus string
  404. switch body.Event {
  405. case 0x0002:
  406. typingStatus = "typing"
  407. case 0x0001:
  408. typingStatus = "typed"
  409. default:
  410. typingStatus = "none"
  411. }
  412. typingEvent := types.TypingEvent{
  413. AimID: NewIdentScreenName(body.ScreenName).String(),
  414. TypingStatus: typingStatus,
  415. }
  416. s.EventQueue.Push(types.EventTypeTyping, typingEvent)
  417. }
  418. // handleBuddyMessage handles buddy/presence SNAC messages.
  419. func (s *WebAPISession) handleBuddyMessage(msg wire.SNACMessage) {
  420. switch msg.Frame.SubGroup {
  421. case wire.BuddyArrived:
  422. s.handleBuddyArrived(msg)
  423. case wire.BuddyDeparted:
  424. s.handleBuddyDeparted(msg)
  425. }
  426. }
  427. // handleBuddyArrived handles when a buddy comes online.
  428. func (s *WebAPISession) handleBuddyArrived(msg wire.SNACMessage) {
  429. if !s.IsSubscribedTo("presence") {
  430. return
  431. }
  432. body, ok := msg.Body.(wire.SNAC_0x03_0x0B_BuddyArrived)
  433. if !ok {
  434. return
  435. }
  436. stateStr := "online"
  437. // For BuddyArrived updates, infer presence state from the TLVUserInfo.
  438. // Away and invisible transitions are typically broadcast using BuddyArrived
  439. // with updated user flags/status bits, not BuddyDeparted.
  440. if body.IsInvisible() {
  441. stateStr = "offline"
  442. } else if body.IsAway() {
  443. stateStr = "away"
  444. } else if mask, ok := body.Uint32BE(wire.OServiceUserInfoStatus); ok {
  445. if mask&wire.OServiceUserStatusDND == wire.OServiceUserStatusDND {
  446. stateStr = "dnd"
  447. } else if mask&wire.OServiceUserStatusAway == wire.OServiceUserStatusAway {
  448. stateStr = "away"
  449. }
  450. }
  451. buddy := NewIdentScreenName(body.ScreenName)
  452. presenceEvent := types.PresenceEvent{
  453. AimID: buddy.String(),
  454. Friendly: s.aliasFor(buddy),
  455. State: stateStr,
  456. UserType: "aim",
  457. }
  458. // A BuddyArrived carries the buddy's current icon in TLV 0x1D whenever they
  459. // have one, so an icon change (or clear, which arrives as the sentinel hash)
  460. // rides along on the presence broadcast. Publish the matching URL: with an
  461. // icon it is content-addressed; without one it is the placeholder URL, which
  462. // differs from any prior icon URL and so clears a removed icon under the
  463. // client's shallow merge. An empty result (no origin known) is omitted, which
  464. // preserves whatever icon the client already holds.
  465. if s.BuddyIconURL != nil {
  466. var hash []byte
  467. if b, ok := body.Bytes(wire.OServiceUserInfoBARTInfo); ok {
  468. var id wire.BARTID
  469. if err := wire.UnmarshalBE(&id, bytes.NewBuffer(b)); err == nil {
  470. hash = id.Hash
  471. }
  472. }
  473. presenceEvent.BuddyIcon = s.BuddyIconURL(buddy, hash)
  474. }
  475. s.EventQueue.Push(types.EventTypePresence, presenceEvent)
  476. }
  477. // handleBuddyDeparted handles when a buddy goes offline.
  478. func (s *WebAPISession) handleBuddyDeparted(msg wire.SNACMessage) {
  479. if !s.IsSubscribedTo("presence") {
  480. return
  481. }
  482. body, ok := msg.Body.(wire.SNAC_0x03_0x0C_BuddyDeparted)
  483. if !ok {
  484. return
  485. }
  486. buddy := NewIdentScreenName(body.ScreenName)
  487. // BuddyIcon is deliberately omitted: an offline buddy keeps their icon, and
  488. // omitting it lets the client's merge preserve the icon it already holds.
  489. presenceEvent := types.PresenceEvent{
  490. AimID: buddy.String(),
  491. Friendly: s.aliasFor(buddy),
  492. State: "offline",
  493. UserType: "aim",
  494. }
  495. s.EventQueue.Push(types.EventTypePresence, presenceEvent)
  496. }
  497. func (s *WebAPISession) handleFeedbagMessage(msg wire.SNACMessage) {
  498. switch msg.Frame.SubGroup {
  499. case wire.FeedbagInsertItem, wire.FeedbagUpdateItem, wire.FeedbagDeleteItem:
  500. // A buddy item carries its alias, so any feedbag write can change the map.
  501. s.InvalidateAliases()
  502. if s.BuddyListRefresher != nil {
  503. payload, err := s.BuddyListRefresher(s.ctx)
  504. if err != nil {
  505. s.logger.Error("failed to refresh buddy list after feedbag change", "err", err)
  506. } else {
  507. s.EventQueue.Push(types.EventTypeBuddyList, payload)
  508. }
  509. }
  510. if s.PermitDenyRefresher != nil {
  511. // An insert and an update both relay an UpdateItem body; only a
  512. // delete carries a DeleteItem body.
  513. var items []wire.FeedbagItem
  514. switch body := msg.Body.(type) {
  515. case wire.SNAC_0x13_0x09_FeedbagUpdateItem:
  516. items = body.Items
  517. case wire.SNAC_0x13_0x0A_FeedbagDeleteItem:
  518. items = body.Items
  519. }
  520. for _, item := range items {
  521. if item.ClassID == wire.FeedbagClassIDPermit ||
  522. item.ClassID == wire.FeedbagClassIDDeny ||
  523. item.ClassID == wire.FeedbagClassIdPdinfo {
  524. pdd, err := s.PermitDenyRefresher(s.ctx)
  525. if err != nil {
  526. s.logger.Error("failed to refresh permit/deny after feedbag change", "err", err)
  527. } else {
  528. s.EventQueue.Push(types.EventTypePermitDeny, pdd)
  529. }
  530. break
  531. }
  532. }
  533. }
  534. }
  535. }
  536. // WebAPISessionManager manages Web API sessions with thread-safe operations.
  537. // Construct it with NewWebAPISessionManager and drive its reaper with Run.
  538. type WebAPISessionManager struct {
  539. sessions map[string]*WebAPISession // Keyed by aimsid
  540. mu sync.RWMutex
  541. closed bool // set by Shutdown; rejects new sessions and makes drain idempotent
  542. stopCh chan struct{} // closed by Shutdown to stop the reaper
  543. reaperWG sync.WaitGroup // tracks a running reaper so Shutdown can join it
  544. }
  545. // NewWebAPISessionManager creates a new WebAPI session manager. It does not start
  546. // any goroutines; call Run to start reaping expired sessions.
  547. func NewWebAPISessionManager() *WebAPISessionManager {
  548. return &WebAPISessionManager{
  549. sessions: make(map[string]*WebAPISession),
  550. stopCh: make(chan struct{}),
  551. }
  552. }
  553. // CreateSession creates a new WebAPI session.
  554. //
  555. // The session does not begin listening to its OSCAR instance yet: the caller
  556. // must wire the session's refresher callbacks (BuddyListRefresher, BuddyIconURL,
  557. // MyInfoRefresher, ...) and then call StartListeningToOSCARSession. Wiring them
  558. // after the listener starts would race the goroutine, which reads them as it
  559. // converts SNACs into events.
  560. func (m *WebAPISessionManager) CreateSession(screenName DisplayScreenName, devID string, events []string, oscarSession *SessionInstance, baseURL string, logger *slog.Logger) (*WebAPISession, error) {
  561. m.mu.Lock()
  562. defer m.mu.Unlock()
  563. // Refuse to create sessions once shut down: the reaper is stopped, so a
  564. // session added now would never be closed or reaped.
  565. if m.closed {
  566. return nil, ErrWebAPISessionManagerClosed
  567. }
  568. // Generate unique session ID
  569. aimsid, err := generateSessionID()
  570. if err != nil {
  571. return nil, err
  572. }
  573. now := time.Now()
  574. sessCtx, sessCancel := context.WithCancel(context.Background())
  575. session := &WebAPISession{
  576. ctx: sessCtx,
  577. cancel: sessCancel,
  578. AimSID: aimsid,
  579. ScreenName: screenName,
  580. OSCARSession: oscarSession,
  581. BaseURL: baseURL,
  582. Events: events,
  583. EventQueue: types.NewEventQueue(1000), // Max 1000 events per session
  584. DevID: devID,
  585. CreatedAt: now,
  586. LastAccessed: now,
  587. ExpiresAt: now.Add(webAPISessionTTL),
  588. FetchTimeout: 60000, // 60 seconds default for better stability
  589. TimeToNextFetch: 500, // 500ms suggested delay
  590. logger: logger,
  591. }
  592. m.sessions[aimsid] = session
  593. // The caller starts the OSCAR listener (StartListeningToOSCARSession) once it
  594. // has wired the session's refresher callbacks; starting it here would race
  595. // those assignments.
  596. return session, nil
  597. }
  598. // GetSession retrieves a session by aimsid.
  599. func (m *WebAPISessionManager) GetSession(ctx context.Context, aimsid string) (*WebAPISession, error) {
  600. m.mu.RLock()
  601. defer m.mu.RUnlock()
  602. session, exists := m.sessions[aimsid]
  603. if !exists {
  604. return nil, ErrNoWebAPISession
  605. }
  606. if session.IsExpired() {
  607. return nil, ErrWebAPISessionExpired
  608. }
  609. // A rate-limit disconnect (EvaluateRateLimit -> Session.CloseSession) closes
  610. // every instance for the account while this web session is still unexpired.
  611. // The aimsid must stop resolving at that point, otherwise a client told to
  612. // disconnect could keep issuing charged requests against a dead session (the
  613. // reaper only removes it on time expiry, up to a TTL later).
  614. if session.OSCARSession.IsClosed() {
  615. return nil, ErrWebAPISessionExpired
  616. }
  617. return session, nil
  618. }
  619. // RemoveSession removes a session by aimsid.
  620. func (m *WebAPISessionManager) RemoveSession(ctx context.Context, aimsid string) error {
  621. m.mu.Lock()
  622. session, exists := m.sessions[aimsid]
  623. if !exists {
  624. m.mu.Unlock()
  625. return ErrNoWebAPISession
  626. }
  627. delete(m.sessions, aimsid)
  628. m.mu.Unlock()
  629. // Tear down outside the lock: CloseInstance fans out to buddy-departed
  630. // broadcasts and signout, which we don't want to run under m.mu.
  631. session.Close()
  632. return nil
  633. }
  634. // TouchSession updates the last accessed time for a session.
  635. func (m *WebAPISessionManager) TouchSession(ctx context.Context, aimsid string) error {
  636. m.mu.Lock()
  637. defer m.mu.Unlock()
  638. session, exists := m.sessions[aimsid]
  639. if !exists {
  640. return ErrNoWebAPISession
  641. }
  642. session.Touch()
  643. return nil
  644. }
  645. // Run reaps expired sessions on a fixed interval until ctx is cancelled or
  646. // Shutdown is called. The caller owns the goroutine's lifecycle; typically
  647. // launch it under the server's errgroup:
  648. //
  649. // g.Go(func() error { mgr.Run(ctx); return nil })
  650. //
  651. // Run is a no-op once the manager is closed, so a reaper that loses the race
  652. // with Shutdown never starts reaping a drained manager.
  653. func (m *WebAPISessionManager) Run(ctx context.Context) {
  654. m.mu.Lock()
  655. if m.closed {
  656. m.mu.Unlock()
  657. return
  658. }
  659. // Registering under m.mu is what makes Shutdown's join sound: Shutdown flips
  660. // closed under the same lock, so a reaper either registers before Shutdown
  661. // waits or is turned away here.
  662. m.reaperWG.Add(1)
  663. m.mu.Unlock()
  664. defer m.reaperWG.Done()
  665. ticker := time.NewTicker(webAPISessionReapInterval)
  666. defer ticker.Stop()
  667. for {
  668. select {
  669. case <-ticker.C:
  670. m.reapExpired()
  671. case <-m.stopCh:
  672. return
  673. case <-ctx.Done():
  674. return
  675. }
  676. }
  677. }
  678. // reapExpired removes every dead session and tears it down. A session is dead
  679. // once it has passed its expiry, or once its underlying OSCAR session has been
  680. // closed out from under it (e.g. by a rate-limit disconnect) — the latter is
  681. // already rejected by GetSession, and reaping it here frees the entry promptly
  682. // rather than leaving it until time expiry.
  683. func (m *WebAPISessionManager) reapExpired() {
  684. m.mu.Lock()
  685. now := time.Now()
  686. var expired []*WebAPISession
  687. for aimsid, session := range m.sessions {
  688. if now.After(session.ExpiresAt) || session.OSCARSession.IsClosed() {
  689. delete(m.sessions, aimsid)
  690. expired = append(expired, session)
  691. }
  692. }
  693. m.mu.Unlock()
  694. // Tear down outside the lock: CloseInstance fans out to buddy-departed
  695. // broadcasts and signout, which we don't want to run under m.mu.
  696. for _, session := range expired {
  697. session.Close()
  698. }
  699. }
  700. // Shutdown drains and closes all sessions, stops the reaper started by Run, and
  701. // blocks further CreateSession calls. It does not depend on the caller
  702. // cancelling Run's context. Safe to call more than once, though only the first
  703. // call waits for the drain. The drain is bounded by ctx: Shutdown returns
  704. // ctx.Err() rather than block forever on a listener that ignores cancellation.
  705. func (m *WebAPISessionManager) Shutdown(ctx context.Context) error {
  706. m.mu.Lock()
  707. if m.closed {
  708. m.mu.Unlock()
  709. return nil
  710. }
  711. m.closed = true
  712. close(m.stopCh)
  713. sessions := make([]*WebAPISession, 0, len(m.sessions))
  714. for _, session := range m.sessions {
  715. sessions = append(sessions, session)
  716. }
  717. // Clear all sessions
  718. m.sessions = make(map[string]*WebAPISession)
  719. m.mu.Unlock()
  720. drained := make(chan struct{})
  721. go func() {
  722. defer close(drained)
  723. // Tear down outside the lock: CloseInstance fans out to buddy-departed
  724. // broadcasts and signout, which we don't want to run under m.mu.
  725. for _, session := range sessions {
  726. session.Close()
  727. }
  728. m.reaperWG.Wait()
  729. }()
  730. select {
  731. case <-drained:
  732. return nil
  733. case <-ctx.Done():
  734. return ctx.Err()
  735. }
  736. }
  737. // generateSessionID creates a cryptographically secure session ID.
  738. func generateSessionID() (string, error) {
  739. bytes := make([]byte, 32) // 256 bits
  740. if _, err := rand.Read(bytes); err != nil {
  741. return "", err
  742. }
  743. return hex.EncodeToString(bytes), nil
  744. }