-
Notifications
You must be signed in to change notification settings - Fork 20
/
session.go
226 lines (182 loc) · 4.98 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
package session
import (
"errors"
"fmt"
"time"
"github.com/valyala/fasthttp"
)
var providers Dict
// Register register session provider
func Register(providerName string, provider Provider) error {
if provider == nil {
return errRegisterNilProvider(providerName)
} else if providers.Has(providerName) {
return errProviderAlreadyRegisted(providerName)
}
providers.Set(providerName, provider)
return nil
}
// New return new Session
func New(cfg *Config) *Session {
cfg.cookieLen = defaultCookieLen
if cfg.CookieName == "" {
cfg.CookieName = defaultSessionKeyName
}
if cfg.SessionIDInHTTPHeader && cfg.SessionNameInHTTPHeader == "" {
cfg.SessionNameInHTTPHeader = defaultSessionKeyName
}
if cfg.SessionIDInURLQuery && cfg.SessionNameInURLQuery == "" {
cfg.SessionNameInURLQuery = defaultSessionKeyName
}
if cfg.GCLifetime == 0 {
cfg.GCLifetime = defaultGCLifetime
}
if cfg.SessionIDGeneratorFunc == nil {
cfg.SessionIDGeneratorFunc = cfg.defaultSessionIDGenerator
}
if cfg.IsSecureFunc == nil {
cfg.IsSecureFunc = cfg.defaultIsSecureFunc
}
session := &Session{
config: cfg,
cookie: NewCookie(),
}
return session
}
// SetProvider set session provider and provider config
func (s *Session) SetProvider(name string, cfg ProviderConfig) error {
if !providers.Has(name) {
return errors.New("session set provider error, " + name + " not registered!")
}
s.provider = providers.Get(name).(Provider)
err := s.provider.Init(int64(s.config.Expires), cfg)
if err != nil {
return err
}
if s.provider.NeedGC() {
s.startGC()
}
return nil
}
// startGC start session gc process.
func (s *Session) startGC() {
go func() {
defer func() {
e := recover()
if e != nil {
panic(fmt.Errorf("session gc crash, %v", e))
}
}()
for {
select {
case <-time.After(s.config.GCLifetime):
s.provider.GC()
}
}
}()
}
func (s *Session) setHTTPValues(ctx *fasthttp.RequestCtx, sessionID []byte) {
secure := s.config.Secure && s.config.IsSecureFunc(ctx)
s.cookie.Set(ctx, s.config.CookieName, sessionID, s.config.Domain, s.config.Expires, secure)
if s.config.SessionIDInHTTPHeader {
ctx.Request.Header.SetBytesV(s.config.SessionNameInHTTPHeader, sessionID)
ctx.Response.Header.SetBytesV(s.config.SessionNameInHTTPHeader, sessionID)
}
}
func (s *Session) delHTTPValues(ctx *fasthttp.RequestCtx) {
s.cookie.Delete(ctx, s.config.CookieName)
if s.config.SessionIDInHTTPHeader {
ctx.Request.Header.Del(s.config.SessionNameInHTTPHeader)
ctx.Response.Header.Del(s.config.SessionNameInHTTPHeader)
}
}
// get session id
// 1. get session id from cookie
// 2. get session id from http headers
// 3. get session id from query string
func (s *Session) getSessionID(ctx *fasthttp.RequestCtx) []byte {
val := ctx.Request.Header.Cookie(s.config.CookieName)
if len(val) > 0 {
return val
}
if s.config.SessionIDInHTTPHeader {
val = ctx.Request.Header.Peek(s.config.SessionNameInHTTPHeader)
if len(val) > 0 {
return val
}
}
if s.config.SessionIDInURLQuery {
val = ctx.FormValue(s.config.SessionNameInURLQuery)
if len(val) > 0 {
return val
}
}
return nil
}
// Get get user session from provider
// 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) Get(ctx *fasthttp.RequestCtx) (Storer, error) {
if s.provider == nil {
return nil, errNotSetProvider
}
sessionID := s.getSessionID(ctx)
if len(sessionID) == 0 {
sessionID = s.config.SessionIDGeneratorFunc()
if len(sessionID) == 0 {
return nil, errEmptySessionID
}
s.setHTTPValues(ctx, sessionID)
}
store, err := s.provider.Get(sessionID)
if err != nil {
return nil, err
}
return store, nil
}
// Save save the user session with current store
//
// Use this function if you want to avoid some extra-allocations
// This will save the store into provider and will return it to the pool
//
// Warning: Don't use more the store after exec this function, because, you will lose the after data
// For avoid it, defer this function in your request handler
func (s *Session) Save(ctx *fasthttp.RequestCtx, store Storer) {
err := store.Save()
if err != nil {
ctx.Error(err.Error(), fasthttp.StatusInternalServerError)
return
}
s.provider.Put(store)
}
// Regenerate regenerate a session id for this Storer
func (s *Session) Regenerate(ctx *fasthttp.RequestCtx) (Storer, error) {
if s.provider == nil {
return nil, errNotSetProvider
}
newID := s.config.SessionIDGeneratorFunc()
if len(newID) == 0 {
return nil, errEmptySessionID
}
oldID := s.getSessionID(ctx)
store, err := s.provider.Regenerate(oldID, newID)
if err != nil {
return nil, err
}
s.setHTTPValues(ctx, newID)
return store, nil
}
// Destroy destroy session in fasthttp ctx
func (s *Session) Destroy(ctx *fasthttp.RequestCtx) error {
sessionID := s.getSessionID(ctx)
if len(sessionID) == 0 {
return nil
}
err := s.provider.Destroy(sessionID)
if err != nil {
return err
}
s.delHTTPValues(ctx)
return nil
}