session.go 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170
  1. package middleware
  2. import (
  3. "math/rand"
  4. "time"
  5. "github.com/go-macaron/session"
  6. _ "github.com/go-macaron/session/memcache"
  7. _ "github.com/go-macaron/session/mysql"
  8. _ "github.com/go-macaron/session/postgres"
  9. _ "github.com/go-macaron/session/redis"
  10. "github.com/grafana/grafana/pkg/log"
  11. "gopkg.in/macaron.v1"
  12. )
  13. const (
  14. SESS_KEY_USERID = "uid"
  15. SESS_KEY_OAUTH_STATE = "state"
  16. SESS_KEY_APIKEY = "apikey_id" // used for render requests with api keys
  17. SESS_KEY_LASTLDAPSYNC = "last_ldap_sync"
  18. )
  19. var sessionManager *session.Manager
  20. var sessionOptions *session.Options
  21. var startSessionGC func()
  22. var getSessionCount func() int
  23. var sessionLogger = log.New("session")
  24. func init() {
  25. startSessionGC = func() {
  26. sessionManager.GC()
  27. sessionLogger.Debug("Session GC")
  28. time.AfterFunc(time.Duration(sessionOptions.Gclifetime)*time.Second, startSessionGC)
  29. }
  30. getSessionCount = func() int {
  31. return sessionManager.Count()
  32. }
  33. }
  34. func prepareOptions(opt *session.Options) *session.Options {
  35. if len(opt.Provider) == 0 {
  36. opt.Provider = "memory"
  37. }
  38. if len(opt.ProviderConfig) == 0 {
  39. opt.ProviderConfig = "data/sessions"
  40. }
  41. if len(opt.CookieName) == 0 {
  42. opt.CookieName = "grafana_sess"
  43. }
  44. if len(opt.CookiePath) == 0 {
  45. opt.CookiePath = "/"
  46. }
  47. if opt.Gclifetime == 0 {
  48. opt.Gclifetime = 3600
  49. }
  50. if opt.Maxlifetime == 0 {
  51. opt.Maxlifetime = opt.Gclifetime
  52. }
  53. if opt.IDLength == 0 {
  54. opt.IDLength = 16
  55. }
  56. return opt
  57. }
  58. func Sessioner(options *session.Options) macaron.Handler {
  59. var err error
  60. sessionOptions = prepareOptions(options)
  61. sessionManager, err = session.NewManager(options.Provider, *options)
  62. if err != nil {
  63. panic(err)
  64. }
  65. // start GC threads after some random seconds
  66. rndSeconds := 10 + rand.Int63n(180)
  67. time.AfterFunc(time.Duration(rndSeconds)*time.Second, startSessionGC)
  68. return func(ctx *Context) {
  69. ctx.Next()
  70. if err = ctx.Session.Release(); err != nil {
  71. panic("session(release): " + err.Error())
  72. }
  73. }
  74. }
  75. func GetSession() SessionStore {
  76. return &SessionWrapper{manager: sessionManager}
  77. }
  78. type SessionStore interface {
  79. // Set sets value to given key in session.
  80. Set(interface{}, interface{}) error
  81. // Get gets value by given key in session.
  82. Get(interface{}) interface{}
  83. // Delete deletes a key from session.
  84. Delete(interface{}) interface{}
  85. // ID returns current session ID.
  86. ID() string
  87. // Release releases session resource and save data to provider.
  88. Release() error
  89. // Destory deletes a session.
  90. Destory(*Context) error
  91. // init
  92. Start(*Context) error
  93. // RegenerateId regenerates the session id
  94. RegenerateId(*Context) error
  95. }
  96. type SessionWrapper struct {
  97. session session.RawStore
  98. manager *session.Manager
  99. }
  100. func (s *SessionWrapper) Start(c *Context) error {
  101. var err error
  102. s.session, err = s.manager.Start(c.Context)
  103. return err
  104. }
  105. func (s *SessionWrapper) RegenerateId(c *Context) error {
  106. var err error
  107. s.session, err = s.manager.RegenerateId(c.Context)
  108. return err
  109. }
  110. func (s *SessionWrapper) Set(k interface{}, v interface{}) error {
  111. if s.session != nil {
  112. return s.session.Set(k, v)
  113. }
  114. return nil
  115. }
  116. func (s *SessionWrapper) Get(k interface{}) interface{} {
  117. if s.session != nil {
  118. return s.session.Get(k)
  119. }
  120. return nil
  121. }
  122. func (s *SessionWrapper) Delete(k interface{}) interface{} {
  123. if s.session != nil {
  124. return s.session.Delete(k)
  125. }
  126. return nil
  127. }
  128. func (s *SessionWrapper) ID() string {
  129. if s.session != nil {
  130. return s.session.ID()
  131. }
  132. return ""
  133. }
  134. func (s *SessionWrapper) Release() error {
  135. if s.session != nil {
  136. return s.session.Release()
  137. }
  138. return nil
  139. }
  140. func (s *SessionWrapper) Destory(c *Context) error {
  141. if s.session != nil {
  142. if err := s.manager.Destory(c.Context); err != nil {
  143. return err
  144. }
  145. s.session = nil
  146. }
  147. return nil
  148. }