webapi_session.go 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517
  1. package state
  2. import (
  3. "context"
  4. "crypto/rand"
  5. "encoding/hex"
  6. "errors"
  7. "log/slog"
  8. "strconv"
  9. "sync"
  10. "time"
  11. "github.com/mk6i/open-oscar-server/server/webapi/types"
  12. "github.com/mk6i/open-oscar-server/wire"
  13. )
  14. var (
  15. // ErrNoWebAPISession is returned when a WebAPI session is not found.
  16. ErrNoWebAPISession = errors.New("WebAPI session not found")
  17. // ErrWebAPISessionExpired is returned when a WebAPI session has expired.
  18. ErrWebAPISessionExpired = errors.New("WebAPI session expired")
  19. )
  20. // WebAPISession represents an active Web AIM API session.
  21. type WebAPISession struct {
  22. AimSID string // Unique session ID for web client
  23. ScreenName DisplayScreenName // User identity
  24. OSCARSession *SessionInstance // Bridge to existing OSCAR session
  25. Events []string // Subscribed event types
  26. EventQueue *types.EventQueue // Per-session event queue
  27. DevID string // Developer ID that created this session
  28. ClientName string // Client application name
  29. ClientVersion string // Client application version
  30. CreatedAt time.Time // SessionInstance creation time
  31. LastAccessed time.Time // Last activity time
  32. ExpiresAt time.Time // SessionInstance expiration time
  33. FetchTimeout int // Long-polling timeout in milliseconds
  34. TimeToNextFetch int // Suggested delay before next fetch
  35. RemoteAddr string // Client IP address
  36. TempBuddies map[string]bool // Temporary buddies for this session only
  37. BuddyListRefresher func(ctx context.Context) (interface{}, error) // Called on feedbag changes to push buddylist event
  38. imLog map[string][]WebAPIStoredIM
  39. imLogMu sync.Mutex
  40. logger *slog.Logger // Logger for debugging
  41. }
  42. // IsExpired checks if the session has expired.
  43. func (s *WebAPISession) IsExpired() bool {
  44. return time.Now().After(s.ExpiresAt)
  45. }
  46. // Touch updates the last accessed time and extends expiration if needed.
  47. func (s *WebAPISession) Touch() {
  48. s.LastAccessed = time.Now()
  49. // Extend expiration by 60 minutes from last access
  50. newExpiry := s.LastAccessed.Add(60 * time.Minute)
  51. if newExpiry.After(s.ExpiresAt) {
  52. s.ExpiresAt = newExpiry
  53. }
  54. }
  55. // IsSubscribedTo checks if the session is subscribed to a specific event type.
  56. func (s *WebAPISession) IsSubscribedTo(eventType string) bool {
  57. for _, event := range s.Events {
  58. if event == eventType {
  59. return true
  60. }
  61. }
  62. return false
  63. }
  64. // StartListeningToOSCARSession starts a goroutine that listens to the OSCAR session's
  65. // message channel and converts SNAC messages into WebAPI events.
  66. func (s *WebAPISession) StartListeningToOSCARSession() {
  67. if s.OSCARSession == nil {
  68. return
  69. }
  70. // Start goroutine to listen for OSCAR messages
  71. go func() {
  72. msgCh := s.OSCARSession.ReceiveMessage()
  73. for {
  74. select {
  75. case msg, ok := <-msgCh:
  76. if !ok {
  77. // Channel closed, OSCAR session ended
  78. return
  79. }
  80. s.handleSNACMessage(msg)
  81. case <-s.OSCARSession.Closed():
  82. // OSCAR session closed
  83. return
  84. }
  85. }
  86. }()
  87. }
  88. // handleSNACMessage converts a SNAC message into WebAPI events and pushes them to the event queue.
  89. func (s *WebAPISession) handleSNACMessage(msg wire.SNACMessage) {
  90. if s.EventQueue == nil {
  91. return
  92. }
  93. // Convert SNAC message to WebAPI events based on food group and subgroup
  94. switch msg.Frame.FoodGroup {
  95. case wire.ICBM:
  96. s.handleICBMMessage(msg)
  97. case wire.Buddy:
  98. s.handleBuddyMessage(msg)
  99. case wire.Feedbag:
  100. s.handleFeedbagMessage(msg)
  101. }
  102. }
  103. // handleICBMMessage handles ICBM (instant messaging) SNAC messages.
  104. func (s *WebAPISession) handleICBMMessage(msg wire.SNACMessage) {
  105. switch msg.Frame.SubGroup {
  106. case wire.ICBMChannelMsgToClient:
  107. s.handleIncomingIM(msg)
  108. case wire.ICBMClientEvent:
  109. s.handleTypingNotification(msg)
  110. }
  111. }
  112. // handleIncomingIM handles incoming instant messages.
  113. func (s *WebAPISession) handleIncomingIM(msg wire.SNACMessage) {
  114. if !s.IsSubscribedTo("im") {
  115. return
  116. }
  117. body, ok := msg.Body.(wire.SNAC_0x04_0x07_ICBMChannelMsgToClient)
  118. if !ok {
  119. return
  120. }
  121. // Extract message text from TLV data
  122. var messageText string
  123. if msgData, hasMsg := body.Bytes(wire.ICBMTLVAOLIMData); hasMsg {
  124. if text, err := wire.UnmarshalICBMMessageText(msgData); err == nil {
  125. messageText = text
  126. }
  127. }
  128. if messageText == "" {
  129. return
  130. }
  131. // Check if it's an auto-response (channel 2)
  132. autoResponse := body.ChannelID == 0x0002
  133. msgID := strconv.FormatUint(body.Cookie, 10)
  134. partner := body.ScreenName
  135. nowSec := time.Now().Unix()
  136. s.AddStoredIM(partner, partner, messageText, msgID, nowSec)
  137. // Create IM event
  138. imEvent := types.IMEvent{
  139. Source: types.UserInfo{
  140. AimID: body.ScreenName,
  141. DisplayID: body.ScreenName,
  142. UserType: "aim",
  143. State: "online",
  144. },
  145. Message: messageText,
  146. MsgID: msgID,
  147. Timestamp: float64(time.Now().Unix()),
  148. AutoResp: autoResponse,
  149. }
  150. s.EventQueue.Push(types.EventTypeIM, imEvent)
  151. if s.IsSubscribedTo("conversation") {
  152. s.EventQueue.Push(types.EventTypeConversation, types.ConversationEventData("update", []map[string]interface{}{
  153. types.ConversationEntry(
  154. body.ScreenName,
  155. body.ScreenName,
  156. messageText,
  157. msgID,
  158. body.ScreenName,
  159. false,
  160. 1,
  161. ),
  162. }))
  163. }
  164. }
  165. // handleTypingNotification handles typing notifications.
  166. func (s *WebAPISession) handleTypingNotification(msg wire.SNACMessage) {
  167. if !s.IsSubscribedTo("typing") {
  168. return
  169. }
  170. body, ok := msg.Body.(wire.SNAC_0x04_0x14_ICBMClientEvent)
  171. if !ok {
  172. return
  173. }
  174. // Event types: 0=stopped typing, 1=text typed, 2=typing
  175. isTyping := body.Event == 1 || body.Event == 2
  176. typingEvent := types.TypingEvent{
  177. From: body.ScreenName,
  178. Typing: isTyping,
  179. }
  180. s.EventQueue.Push(types.EventTypeTyping, typingEvent)
  181. }
  182. // handleBuddyMessage handles buddy/presence SNAC messages.
  183. func (s *WebAPISession) handleBuddyMessage(msg wire.SNACMessage) {
  184. switch msg.Frame.SubGroup {
  185. case wire.BuddyArrived:
  186. s.handleBuddyArrived(msg)
  187. case wire.BuddyDeparted:
  188. s.handleBuddyDeparted(msg)
  189. }
  190. }
  191. // handleBuddyArrived handles when a buddy comes online.
  192. func (s *WebAPISession) handleBuddyArrived(msg wire.SNACMessage) {
  193. if !s.IsSubscribedTo("presence") {
  194. return
  195. }
  196. body, ok := msg.Body.(wire.SNAC_0x03_0x0B_BuddyArrived)
  197. if !ok {
  198. return
  199. }
  200. stateStr := "online"
  201. // For BuddyArrived updates, infer presence state from the TLVUserInfo.
  202. // Away and invisible transitions are typically broadcast using BuddyArrived
  203. // with updated user flags/status bits, not BuddyDeparted.
  204. if body.IsInvisible() {
  205. stateStr = "offline"
  206. } else if body.IsAway() {
  207. stateStr = "away"
  208. } else if mask, ok := body.Uint32BE(wire.OServiceUserInfoStatus); ok {
  209. if mask&wire.OServiceUserStatusDND == wire.OServiceUserStatusDND {
  210. stateStr = "dnd"
  211. } else if mask&wire.OServiceUserStatusAway == wire.OServiceUserStatusAway {
  212. stateStr = "away"
  213. }
  214. }
  215. presenceEvent := types.PresenceEvent{
  216. AimID: body.ScreenName,
  217. State: stateStr,
  218. UserType: "aim",
  219. }
  220. s.EventQueue.Push(types.EventTypePresence, presenceEvent)
  221. }
  222. // handleBuddyDeparted handles when a buddy goes offline.
  223. func (s *WebAPISession) handleBuddyDeparted(msg wire.SNACMessage) {
  224. if !s.IsSubscribedTo("presence") {
  225. return
  226. }
  227. body, ok := msg.Body.(wire.SNAC_0x03_0x0C_BuddyDeparted)
  228. if !ok {
  229. return
  230. }
  231. presenceEvent := types.PresenceEvent{
  232. AimID: body.ScreenName,
  233. State: "offline",
  234. UserType: "aim",
  235. }
  236. s.EventQueue.Push(types.EventTypePresence, presenceEvent)
  237. }
  238. func (s *WebAPISession) handleFeedbagMessage(msg wire.SNACMessage) {
  239. switch msg.Frame.SubGroup {
  240. case wire.FeedbagInsertItem, wire.FeedbagUpdateItem, wire.FeedbagDeleteItem:
  241. if s.BuddyListRefresher == nil {
  242. return
  243. }
  244. groups, err := s.BuddyListRefresher(context.Background())
  245. if err != nil {
  246. s.logger.Error("failed to refresh buddy list after feedbag change", "err", err)
  247. return
  248. }
  249. s.EventQueue.Push(types.EventTypeBuddyList, map[string]interface{}{"groups": groups})
  250. }
  251. }
  252. // WebAPISessionManager manages Web API sessions with thread-safe operations.
  253. type WebAPISessionManager struct {
  254. sessions map[string]*WebAPISession // Keyed by aimsid
  255. byUser map[IdentScreenName]*WebAPISession // Keyed by screen name
  256. mu sync.RWMutex
  257. cleanupTicker *time.Ticker
  258. stopCleanup chan struct{}
  259. }
  260. // NewWebAPISessionManager creates a new WebAPI session manager.
  261. func NewWebAPISessionManager() *WebAPISessionManager {
  262. mgr := &WebAPISessionManager{
  263. sessions: make(map[string]*WebAPISession),
  264. byUser: make(map[IdentScreenName]*WebAPISession),
  265. stopCleanup: make(chan struct{}),
  266. }
  267. // Start cleanup goroutine to remove expired sessions
  268. mgr.cleanupTicker = time.NewTicker(1 * time.Minute)
  269. go mgr.cleanupExpiredSessions()
  270. return mgr
  271. }
  272. // CreateSession creates a new WebAPI session.
  273. func (m *WebAPISessionManager) CreateSession(ctx context.Context, screenName DisplayScreenName, devID string, events []string, oscarSession *SessionInstance, logger *slog.Logger) (*WebAPISession, error) {
  274. m.mu.Lock()
  275. defer m.mu.Unlock()
  276. // Check if user already has an active session
  277. identName := screenName.IdentScreenName()
  278. if existing, exists := m.byUser[identName]; exists {
  279. // Remove the old session
  280. delete(m.sessions, existing.AimSID)
  281. }
  282. // Generate unique session ID
  283. aimsid, err := generateSessionID()
  284. if err != nil {
  285. return nil, err
  286. }
  287. now := time.Now()
  288. session := &WebAPISession{
  289. AimSID: aimsid,
  290. ScreenName: screenName,
  291. OSCARSession: oscarSession,
  292. Events: events,
  293. EventQueue: types.NewEventQueue(1000), // Max 1000 events per session
  294. DevID: devID,
  295. CreatedAt: now,
  296. LastAccessed: now,
  297. ExpiresAt: now.Add(60 * time.Minute), // 60 minute initial expiry
  298. FetchTimeout: 60000, // 60 seconds default for better stability
  299. TimeToNextFetch: 500, // 500ms suggested delay
  300. logger: logger,
  301. }
  302. m.sessions[aimsid] = session
  303. m.byUser[identName] = session
  304. // Start listening to OSCAR session message channel
  305. session.StartListeningToOSCARSession()
  306. return session, nil
  307. }
  308. // GetSession retrieves a session by aimsid.
  309. func (m *WebAPISessionManager) GetSession(ctx context.Context, aimsid string) (*WebAPISession, error) {
  310. m.mu.RLock()
  311. defer m.mu.RUnlock()
  312. session, exists := m.sessions[aimsid]
  313. if !exists {
  314. return nil, ErrNoWebAPISession
  315. }
  316. if session.IsExpired() {
  317. return nil, ErrWebAPISessionExpired
  318. }
  319. return session, nil
  320. }
  321. // GetSessionByUser retrieves a session by screen name.
  322. func (m *WebAPISessionManager) GetSessionByUser(ctx context.Context, screenName IdentScreenName) (*WebAPISession, error) {
  323. m.mu.RLock()
  324. defer m.mu.RUnlock()
  325. session, exists := m.byUser[screenName]
  326. if !exists {
  327. return nil, ErrNoWebAPISession
  328. }
  329. if session.IsExpired() {
  330. return nil, ErrWebAPISessionExpired
  331. }
  332. return session, nil
  333. }
  334. // RemoveSession removes a session by aimsid.
  335. func (m *WebAPISessionManager) RemoveSession(ctx context.Context, aimsid string) error {
  336. m.mu.Lock()
  337. defer m.mu.Unlock()
  338. session, exists := m.sessions[aimsid]
  339. if !exists {
  340. return ErrNoWebAPISession
  341. }
  342. delete(m.sessions, aimsid)
  343. delete(m.byUser, session.ScreenName.IdentScreenName())
  344. // CloseSession the event queue to unblock any waiting fetches
  345. if session.EventQueue != nil {
  346. session.EventQueue.Close()
  347. }
  348. return nil
  349. }
  350. // TouchSession updates the last accessed time for a session.
  351. func (m *WebAPISessionManager) TouchSession(ctx context.Context, aimsid string) error {
  352. m.mu.Lock()
  353. defer m.mu.Unlock()
  354. session, exists := m.sessions[aimsid]
  355. if !exists {
  356. return ErrNoWebAPISession
  357. }
  358. session.Touch()
  359. return nil
  360. }
  361. // GetAllSessions returns all active sessions (for monitoring/admin).
  362. func (m *WebAPISessionManager) GetAllSessions(ctx context.Context) []*WebAPISession {
  363. m.mu.RLock()
  364. defer m.mu.RUnlock()
  365. sessions := make([]*WebAPISession, 0, len(m.sessions))
  366. for _, session := range m.sessions {
  367. if !session.IsExpired() {
  368. sessions = append(sessions, session)
  369. }
  370. }
  371. return sessions
  372. }
  373. // GetSessionsByScreenName returns all sessions for a given screen name.
  374. func (m *WebAPISessionManager) GetSessionsByScreenName(ctx context.Context, screenName DisplayScreenName) []*WebAPISession {
  375. m.mu.RLock()
  376. defer m.mu.RUnlock()
  377. var sessions []*WebAPISession
  378. identScreenName := screenName.IdentScreenName()
  379. // Check both the byUser map and iterate through all sessions
  380. // since a user might have multiple sessions
  381. for _, session := range m.sessions {
  382. if session.ScreenName.IdentScreenName() == identScreenName {
  383. sessions = append(sessions, session)
  384. }
  385. }
  386. return sessions
  387. }
  388. // cleanupExpiredSessions periodically removes expired sessions.
  389. func (m *WebAPISessionManager) cleanupExpiredSessions() {
  390. for {
  391. select {
  392. case <-m.cleanupTicker.C:
  393. m.mu.Lock()
  394. now := time.Now()
  395. var toRemove []string
  396. for aimsid, session := range m.sessions {
  397. if now.After(session.ExpiresAt) {
  398. toRemove = append(toRemove, aimsid)
  399. }
  400. }
  401. for _, aimsid := range toRemove {
  402. session := m.sessions[aimsid]
  403. delete(m.sessions, aimsid)
  404. delete(m.byUser, session.ScreenName.IdentScreenName())
  405. if session.EventQueue != nil {
  406. session.EventQueue.Close()
  407. }
  408. }
  409. m.mu.Unlock()
  410. case <-m.stopCleanup:
  411. m.cleanupTicker.Stop()
  412. return
  413. }
  414. }
  415. }
  416. // Shutdown stops the session manager and cleans up resources.
  417. func (m *WebAPISessionManager) Shutdown(ctx context.Context) {
  418. close(m.stopCleanup)
  419. m.mu.Lock()
  420. defer m.mu.Unlock()
  421. // CloseSession all event queues
  422. for _, session := range m.sessions {
  423. if session.EventQueue != nil {
  424. session.EventQueue.Close()
  425. }
  426. }
  427. // Clear all sessions
  428. m.sessions = make(map[string]*WebAPISession)
  429. m.byUser = make(map[IdentScreenName]*WebAPISession)
  430. }
  431. // generateSessionID creates a cryptographically secure session ID.
  432. func generateSessionID() (string, error) {
  433. bytes := make([]byte, 32) // 256 bits
  434. if _, err := rand.Read(bytes); err != nil {
  435. return "", err
  436. }
  437. return hex.EncodeToString(bytes), nil
  438. }