forked from phachon/fasthttpsession
/
session.go
293 lines (244 loc) · 7.11 KB
/
session.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
package fasthttpsession
import (
"errors"
"fmt"
"reflect"
"time"
cmap "github.com/orcaman/concurrent-map"
"github.com/valyala/fasthttp"
)
var version = "v0.0.1"
// Session struct
type Session struct {
provider Provider
config *Config
cookie *Cookie
ccmap cmap.ConcurrentMap
}
var providers = make(map[string]Provider)
// register session provider
func Register(providerName string, provider Provider) {
if providers[providerName] != nil {
panic("session register error, provider " + providerName + " already registered!")
}
if provider == nil {
panic("session register error, provider " + providerName + " is nil!")
}
providers[providerName] = provider
}
// return new Session
func NewSession(cfg *Config) *Session {
if cfg.CookieName == "" {
cfg.CookieName = defaultCookieName
}
if cfg.GCLifetime == 0 {
cfg.GCLifetime = defaultGCLifetime
}
if cfg.SessionLifetime == 0 {
cfg.SessionLifetime = cfg.GCLifetime
}
if cfg.SessionIdGeneratorFunc == nil {
cfg.SessionIdGeneratorFunc = cfg.defaultSessionIdGenerator
}
session := &Session{
config: cfg,
cookie: NewCookie(),
ccmap: cmap.New(),
}
return session
}
// ChangeCookieName => Update cookie name
func (s *Session) ChangeCookieName(cookieName string) {
if cookieName != "" {
s.config.CookieName = cookieName
}
}
// ChangeNeedStoreInMap => Change store ccmap between : SessionStore <=> ctx
func (s *Session) ChangeNeedStoreInMap(controlFlg bool) {
s.config.NeedStoreInMap = controlFlg
}
// set session provider and provider config
func (s *Session) SetProvider(providerName string, providerConfig ProviderConfig) error {
provider, ok := providers[providerName]
if !ok {
return errors.New("session set provider error, " + providerName + " not registered!")
}
err := provider.Init(s.config.SessionLifetime, providerConfig)
if err != nil {
return err
}
s.provider = provider
// start gc
if s.provider.NeedGC() {
go func() {
defer func() {
e := recover()
if e != nil {
panic(errors.New(fmt.Sprintf("session gc crash, %v", e)))
}
}()
s.gc()
}()
}
return nil
}
// start session gc process.
func (s *Session) gc() {
for {
select {
case <-time.After(time.Duration(s.config.GCLifetime) * time.Second):
s.provider.GC()
}
}
}
func getCtxPointer(ctx *fasthttp.RequestCtx) string {
var ctxPtr uintptr = reflect.ValueOf(ctx).Pointer()
return fmt.Sprintf("0x%x", ctxPtr)
}
func (s *Session) GetSessionStoreWithCtx(ctx *fasthttp.RequestCtx) (sessionStore SessionStore, err error) {
if s.config.NeedStoreInMap == false {
return sessionStore, errors.New(fmt.Sprintf("Not support this method in constructor"))
}
if tmp, ok := s.ccmap.Get(getCtxPointer(ctx)); ok {
return tmp.(SessionStore), nil
}
return sessionStore, errors.New(fmt.Sprintf("Session store is empty"))
}
func (s *Session) SetSessionStoreWithCtx(ctx *fasthttp.RequestCtx, sessionStore SessionStore) {
s.ccmap.Set(getCtxPointer(ctx), sessionStore)
}
func (s *Session) RemoveSessionStoreWithCtx(ctx *fasthttp.RequestCtx) bool {
if s.config.NeedStoreInMap == false {
return true
}
var ctxStr = getCtxPointer(ctx)
ok := s.ccmap.Has(ctxStr)
if ok {
s.ccmap.Remove(ctxStr)
return true
}
return false
}
// session start
// 1. get sessionId from fasthttp ctx
// 2. if sessionId is empty, generator sessionId and set response Set-Cookie
// 3. return session provider store
func (s *Session) Start(ctx *fasthttp.RequestCtx) (sessionStore SessionStore, err error) {
if s.provider == nil {
return sessionStore, errors.New("session start error, not set provider")
}
sessionId := s.GetSessionId(ctx)
if sessionId == "" {
// new generator session id
sessionId = s.config.SessionIdGenerator()
if sessionId == "" {
return sessionStore, errors.New("session generator sessionId is empty")
}
}
// read provider session store
sessionStore, err = s.provider.ReadStore(sessionId)
if err != nil {
return sessionStore, errors.New(fmt.Sprintf("Error when read session data : %s", err.Error()))
}
// encode cookie value
encodeCookieValue := s.config.Encode(sessionId)
// set response cookie
s.cookie.Set(ctx,
s.config.CookieName,
encodeCookieValue,
s.config.Domain,
s.config.Expires,
s.config.Secure)
if s.config.SessionIdInHttpHeader {
ctx.Request.Header.Set(s.config.SessionNameInHttpHeader, sessionId)
ctx.Response.Header.Set(s.config.SessionNameInHttpHeader, sessionId)
}
if s.config.NeedStoreInMap {
s.SetSessionStoreWithCtx(ctx, sessionStore)
}
return sessionStore, nil
}
// get session id
// 1. get session id by reading from cookie
// 2. get session id from query
// 3. get session id from http headers
func (s *Session) GetSessionId(ctx *fasthttp.RequestCtx) string {
cookieByte := ctx.Request.Header.Cookie(s.config.CookieName)
if len(cookieByte) > 0 {
return s.config.Decode(string(cookieByte))
}
if s.config.SessionIdInURLQuery {
cookieFormValue := ctx.FormValue(s.config.SessionNameInUrlQuery)
if len(cookieFormValue) > 0 {
return s.config.Decode(string(cookieFormValue))
}
}
if s.config.SessionIdInHttpHeader {
cookieHeader := ctx.Request.Header.Peek(s.config.SessionNameInHttpHeader)
if len(cookieHeader) > 0 {
return s.config.Decode(string(cookieHeader))
}
}
return ""
}
// regenerate a session id for this SessionStore
func (s *Session) Regenerate(ctx *fasthttp.RequestCtx) (sessionStore SessionStore, err error) {
if s.provider == nil {
return sessionStore, errors.New("session regenerate error, not set provider")
}
// generator new session id
sessionId := s.config.SessionIdGenerator()
if sessionId == "" {
return sessionStore, errors.New("session generator sessionId is empty")
}
// encode cookie value
encodeCookieValue := s.config.Encode(sessionId)
// regenerate provider session store
oldSessionId := s.GetSessionId(ctx)
if oldSessionId != "" {
sessionStore, err = s.provider.Regenerate(oldSessionId, sessionId)
} else {
sessionStore, err = s.provider.ReadStore(sessionId)
}
if err != nil {
return sessionStore, errors.New(fmt.Sprintf("Error when read session data : %s", err.Error()))
}
// reset response cookie
s.cookie.Set(ctx,
s.config.CookieName,
encodeCookieValue,
s.config.Domain,
s.config.Expires,
s.config.Secure)
// reset http header
if s.config.SessionIdInHttpHeader {
ctx.Request.Header.Set(s.config.SessionNameInHttpHeader, sessionId)
ctx.Response.Header.Set(s.config.SessionNameInHttpHeader, sessionId)
}
if s.config.NeedStoreInMap {
s.SetSessionStoreWithCtx(ctx, sessionStore)
}
return sessionStore, nil
}
// destroy session in fasthttp ctx
func (s *Session) Destroy(ctx *fasthttp.RequestCtx) {
if s.config.NeedStoreInMap {
defer s.RemoveSessionStoreWithCtx(ctx)
}
// delete header if sessionId in http Header
if s.config.SessionIdInHttpHeader {
ctx.Request.Header.Del(s.config.SessionNameInHttpHeader)
ctx.Response.Header.Del(s.config.SessionNameInHttpHeader)
}
cookieValue := s.cookie.Get(ctx, s.config.CookieName)
if cookieValue == "" {
return
}
sessionId := s.config.Decode(cookieValue)
s.provider.Destroy(sessionId)
// delete cookie by cookieName
s.cookie.Delete(ctx, s.config.CookieName)
}
func Version() string {
return version
}