im_server/server/sessionstore.go

/******************************************************************************
 *
 *  Description:
 *
 *  Session management.
 *
 *****************************************************************************/

package main

import (
	"container/list"
	"net/http"
	"sync"
	"time"

	"github.com/gorilla/websocket"
	"github.com/tinode/chat/pbx"
	"github.com/tinode/chat/server/logs"
	"github.com/tinode/chat/server/store"
	"github.com/tinode/chat/server/store/types"
)

// WaitGroup with a semaphore functionality
// (limiting number of threads/goroutines accessing the guarded resource simultaneously).
type boundedWaitGroup struct {
	wg  sync.WaitGroup
	sem chan struct{}
}

func newBoundedWaitGroup(capacity int) *boundedWaitGroup {
	return &boundedWaitGroup{sem: make(chan struct{}, capacity)}
}

func (w *boundedWaitGroup) Add(delta int) {
	if delta <= 0 {
		return
	}
	for range delta {
		w.sem <- struct{}{}
	}
	w.wg.Add(delta)
}

func (w *boundedWaitGroup) Done() {
	select {
	case _, ok := <-w.sem:
		if !ok {
			logs.Err.Panicln("boundedWaitGroup.sem closed.")
		}
	default:
		logs.Err.Panicln("boundedWaitGroup.Done() called before Add().")
	}
	w.wg.Done()
}

func (w *boundedWaitGroup) Wait() {
	w.wg.Wait()
}

// SessionStore holds live sessions. Long polling sessions are stored in a linked list with
// most recent sessions on top. In addition all sessions are stored in a map indexed by session ID.
type SessionStore struct {
	lock sync.Mutex

	// Support for long polling sessions: a list of sessions sorted by last access time.
	// Needed for cleaning abandoned sessions.
	lru      *list.List
	lifeTime time.Duration

	// All sessions indexed by session ID
	sessCache map[string]*Session
}

// NewSession creates a new session and saves it to the session store.
func (ss *SessionStore) NewSession(conn any, sid string) (*Session, int) {
	var s Session

	if sid == "" {
		s.sid = store.Store.GetUidString()
	} else {
		s.sid = sid
	}

	ss.lock.Lock()
	if _, found := ss.sessCache[s.sid]; found {
		logs.Err.Fatalln("ERROR! duplicate session ID", s.sid)
	}
	ss.lock.Unlock()

	switch c := conn.(type) {
	case *websocket.Conn:
		s.proto = WEBSOCK
		s.ws = c
	case http.ResponseWriter:
		s.proto = LPOLL
		// no need to store c for long polling, it changes with every request
	case *ClusterNode:
		s.proto = MULTIPLEX
		s.clnode = c
	case pbx.Node_MessageLoopServer:
		s.proto = GRPC
		s.grpcnode = c
	default:
		logs.Err.Panicln("session: unknown connection type", conn)
	}

	s.subs = make(map[string]*Subscription)
	s.send = make(chan any, sendQueueLimit+32) // buffered
	s.stop = make(chan any, 1)                 // Buffered by 1 just to make it non-blocking
	s.detach = make(chan string, 64)           // buffered

	s.bkgTimer = time.NewTimer(time.Hour)
	s.bkgTimer.Stop()

	// Make sure at most 1 request is modifying session/topic state at any time.
	// TODO: use Mutex & CondVar?
	s.inflightReqs = newBoundedWaitGroup(1)

	s.lastTouched = time.Now()

	ss.lock.Lock()

	if s.proto == LPOLL {
		// Only LP sessions need to be sorted by last active
		s.lpTracker = ss.lru.PushFront(&s)
	}

	ss.sessCache[s.sid] = &s

	// Expire stale long polling sessions: ss.lru contains only long polling sessions.
	// If ss.lru is empty this is a noop.
	var expired []*Session
	expire := s.lastTouched.Add(-ss.lifeTime)
	for elem := ss.lru.Back(); elem != nil; elem = ss.lru.Back() {
		sess := elem.Value.(*Session)
		if sess.lastTouched.Before(expire) {
			ss.lru.Remove(elem)
			delete(ss.sessCache, sess.sid)
			expired = append(expired, sess)
		} else {
			break // don't need to traverse further
		}
	}

	numSessions := len(ss.sessCache)
	statsSet("LiveSessions", int64(numSessions))
	statsInc("TotalSessions", 1)

	ss.lock.Unlock()

	// Deleting long polling sessions.
	for _, sess := range expired {
		// This locks the session. Thus cleaning up outside of the
		// sessionStore lock. Otherwise deadlock.
		sess.cleanUp(true)
	}

	return &s, numSessions
}

// Get fetches a session from store by session ID.
func (ss *SessionStore) Get(sid string) *Session {
	ss.lock.Lock()
	defer ss.lock.Unlock()

	if sess := ss.sessCache[sid]; sess != nil {
		if sess.proto == LPOLL {
			ss.lru.MoveToFront(sess.lpTracker)
			sess.lastTouched = time.Now()
		}

		return sess
	}

	return nil
}

// Delete removes session from store.
func (ss *SessionStore) Delete(s *Session) {
	ss.lock.Lock()
	defer ss.lock.Unlock()

	delete(ss.sessCache, s.sid)
	if s.proto == LPOLL {
		ss.lru.Remove(s.lpTracker)
	}

	statsSet("LiveSessions", int64(len(ss.sessCache)))
}

// Range calls given function for all sessions. It stops if the function returns false.
func (ss *SessionStore) Range(f func(sid string, s *Session) bool) {
	ss.lock.Lock()
	for sid, s := range ss.sessCache {
		if !f(sid, s) {
			break
		}
	}
	ss.lock.Unlock()
}

func (ss *SessionStore) DeliverToUser(tenantID types.TenantID, uid types.Uid, skipSid string, msg *ServerComMessage) int {
	if ss == nil || !tenantID.IsValid() || uid.IsZero() || msg == nil {
		return 0
	}
	delivered := 0
	ss.Range(func(_ string, sess *Session) bool {
		if sess == nil || sess.isCluster() || sess.isProxy() || sess.tenantID != tenantID || sess.uid != uid || sess.sid == skipSid {
			return true
		}
		if userMessageSkipTopic(msg, sess) {
			return true
		}
		if sess.queueOut(msg.copy()) {
			delivered++
		}
		return true
	})
	return delivered
}

func userMessageSkipTopic(msg *ServerComMessage, sess *Session) bool {
	if msg == nil || sess == nil {
		return false
	}
	skipTopic := ""
	switch {
	case msg.Pres != nil:
		skipTopic = msg.Pres.SkipTopic
	case msg.Info != nil:
		skipTopic = msg.Info.SkipTopic
	}
	return sessionHasTopicOrP2PAlias(sess, skipTopic)
}

func sessionHasTopicOrP2PAlias(sess *Session, topic string) bool {
	if sess == nil || topic == "" {
		return false
	}
	if sess.hasSub(topic) {
		return true
	}
	if types.GetTopicCat(topic) != types.TopicCatP2P || sess.uid.IsZero() {
		return false
	}
	viewTopic, err := types.P2PNameForUser(sess.uid, topic)
	if err != nil || viewTopic == "" {
		return false
	}
	return sess.hasSub(viewTopic)
}

func (ss *SessionStore) DeliverToTopicSubscribers(tenantID types.TenantID, topic, skipSid string, msg *ServerComMessage) int {
	if ss == nil || !tenantID.IsValid() || topic == "" || msg == nil {
		return 0
	}
	delivered := 0
	ss.Range(func(_ string, sess *Session) bool {
		if sess == nil || sess.isCluster() || sess.isProxy() || sess.tenantID != tenantID || sess.sid == skipSid || !sess.hasSub(topic) {
			return true
		}
		msgCopy := msg.copy()
		if msgCopy.RcptTo == "" {
			msgCopy.RcptTo = topic
		}
		if msgCopy.Data != nil && msgCopy.Data.Topic == "" {
			msgCopy.Data.Topic = topic
		}
		if sess.queueOut(msgCopy) {
			delivered++
		}
		return true
	})
	return delivered
}

func (ss *SessionStore) DeliverToP2PTopic(tenantID types.TenantID, topic, skipSid string, msg *ServerComMessage) int {
	if ss == nil || !tenantID.IsValid() || topic == "" || msg == nil {
		return 0
	}
	uid1, uid2, err := types.ParseP2P(topic)
	if err != nil {
		return ss.DeliverToTopicSubscribers(tenantID, topic, skipSid, msg)
	}
	participants := map[types.Uid]struct{}{uid1: {}, uid2: {}}
	delivered := 0
	ss.Range(func(_ string, sess *Session) bool {
		if sess == nil || sess.isCluster() || sess.isProxy() || sess.tenantID != tenantID || sess.sid == skipSid {
			return true
		}
		if _, ok := participants[sess.uid]; !ok {
			return true
		}
		viewTopic, err := types.P2PNameForUser(sess.uid, topic)
		if err != nil || viewTopic == "" {
			return true
		}
		if !sess.hasSub(topic) && !sess.hasSub(viewTopic) {
			return true
		}
		msgCopy := msg.copy()
		msgCopy.RcptTo = sess.uid.UserId()
		if msgCopy.Data != nil {
			msgCopy.Data.Topic = viewTopic
		}
		if msgCopy.Info != nil {
			msgCopy.Info.Topic = viewTopic
		}
		if msgCopy.Pres != nil {
			msgCopy.Pres.Topic = viewTopic
		}
		if sess.queueOut(msgCopy) {
			delivered++
		}
		return true
	})
	return delivered
}

// Shutdown terminates sessionStore. No need to clean up.
// Don't send to clustered sessions, their servers are not being shut down.
func (ss *SessionStore) Shutdown() {
	ss.lock.Lock()
	defer ss.lock.Unlock()

	shutdown := NoErrShutdown(types.TimeNow())
	for _, s := range ss.sessCache {
		if !s.isMultiplex() {
			_, data := s.serialize(shutdown)
			s.stopSession(data)
		}
	}

	// TODO: Consider broadcasting shutdown to other cluster nodes.

	logs.Info.Println("SessionStore shut down, sessions terminated:", len(ss.sessCache))
}

// EvictUser terminates all sessions of a given user.
func (ss *SessionStore) EvictUser(uid types.Uid, skipSid string, reason ...string) int {
	ss.lock.Lock()
	defer ss.lock.Unlock()

	// FIXME: this probably needs to be optimized. This may take very long time if the node hosts 100000 sessions.
	evicted := NoErrEvicted("", "", types.TimeNow())
	evicted.AsUser = uid.UserId()
	if len(reason) > 0 && reason[0] != "" {
		evicted.Ctrl.Params = map[string]any{"reason": reason[0]}
	}
	count := 0
	for _, s := range ss.sessCache {
		if s.uid == uid && !s.isMultiplex() && s.sid != skipSid {
			_, data := s.serialize(evicted)
			s.stopSession(data)
			delete(ss.sessCache, s.sid)
			if s.proto == LPOLL {
				ss.lru.Remove(s.lpTracker)
			}
			count++
		}
	}

	statsSet("LiveSessions", int64(len(ss.sessCache)))
	return count
}

// EvictUserDevice terminates all sessions of a given user connected with a device.
func (ss *SessionStore) EvictUserDevice(uid types.Uid, deviceID string, reason ...string) int {
	ss.lock.Lock()
	defer ss.lock.Unlock()

	if uid.IsZero() || deviceID == "" {
		return 0
	}
	evicted := NoErrEvicted("", "", types.TimeNow())
	evicted.AsUser = uid.UserId()
	if len(reason) > 0 && reason[0] != "" {
		evicted.Ctrl.Params = map[string]any{"reason": reason[0]}
	}
	count := 0
	for _, s := range ss.sessCache {
		if s.uid == uid && s.deviceID == deviceID && !s.isMultiplex() {
			_, data := s.serialize(evicted)
			s.stopSession(data)
			delete(ss.sessCache, s.sid)
			if s.proto == LPOLL {
				ss.lru.Remove(s.lpTracker)
			}
			count++
		}
	}

	statsSet("LiveSessions", int64(len(ss.sessCache)))
	return count
}

// EvictUserPlatform terminates all sessions of a given user in the same eviction
// platform group, keeping the session identified by skipSid (e.g. the new login
// which triggers the eviction). ios/android/mobile are treated as one mobile
// group (顶号互踢); web only matches web.
func (ss *SessionStore) EvictUserPlatform(uid types.Uid, platf, skipSid string, reason ...string) int {
	ss.lock.Lock()
	defer ss.lock.Unlock()

	if uid.IsZero() || platf == "" {
		return 0
	}
	evicted := NoErrEvicted("", "", types.TimeNow())
	evicted.AsUser = uid.UserId()
	if len(reason) > 0 && reason[0] != "" {
		evicted.Ctrl.Params = map[string]any{"reason": reason[0]}
	}
	count := 0
	for _, s := range ss.sessCache {
		if s.uid == uid && sameEvictPlatform(s.platf, platf) && !s.isMultiplex() && s.sid != skipSid {
			_, data := s.serialize(evicted)
			s.stopSession(data)
			delete(ss.sessCache, s.sid)
			if s.proto == LPOLL {
				ss.lru.Remove(s.lpTracker)
			}
			count++
		}
	}

	statsSet("LiveSessions", int64(len(ss.sessCache)))
	return count
}

// NodeRestarted removes stale sessions from a restarted cluster node.
//   - nodeName is the name of affected node
//   - fingerprint is the new fingerprint of the node.
func (ss *SessionStore) NodeRestarted(nodeName string, fingerprint int64) {
	ss.lock.Lock()
	defer ss.lock.Unlock()

	for _, s := range ss.sessCache {
		if !s.isMultiplex() || s.clnode.name != nodeName {
			continue
		}
		if s.clnode.fingerprint != fingerprint {
			s.stopSession(nil)
			delete(ss.sessCache, s.sid)
		}
	}

	statsSet("LiveSessions", int64(len(ss.sessCache)))
}

// NewSessionStore initializes a session store.
func NewSessionStore(lifetime time.Duration) *SessionStore {
	ss := &SessionStore{
		lru:      list.New(),
		lifeTime: lifetime,

		sessCache: make(map[string]*Session),
	}

	statsRegisterInt("LiveSessions")
	statsRegisterInt("TotalSessions")

	return ss
}