/
gsession_session.go
359 lines (332 loc) · 9.04 KB
/
gsession_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
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package gsession
import (
"context"
"time"
"github.com/gogf/gf/v2/container/gmap"
"github.com/gogf/gf/v2/container/gvar"
"github.com/gogf/gf/v2/errors/gcode"
"github.com/gogf/gf/v2/errors/gerror"
"github.com/gogf/gf/v2/internal/intlog"
)
// Session struct for storing single session data, which is bound to a single request.
// The Session struct is the interface with user, but the Storage is the underlying adapter designed interface
// for functionality implements.
type Session struct {
id string // Session id. It retrieves the session if id is custom specified.
ctx context.Context // Context for current session. Please note that, session lives along with context.
data *gmap.StrAnyMap // Current Session data, which is retrieved from Storage.
dirty bool // Used to mark session is modified.
start bool // Used to mark session is started.
manager *Manager // Parent session Manager.
// idFunc is a callback function used for creating custom session id.
// This is called if session id is empty ever when session starts.
idFunc func(ttl time.Duration) (id string)
}
// init does the lazy initialization for session, which retrieves the session if session id is specified,
// or else it creates a new empty session.
func (s *Session) init() error {
if s.start {
return nil
}
var err error
// Session retrieving.
if s.id != "" {
// Retrieve stored session data from storage.
if s.manager.storage != nil {
s.data, err = s.manager.storage.GetSession(s.ctx, s.id, s.manager.GetTTL())
if err != nil && err != ErrorDisabled {
intlog.Errorf(s.ctx, `session restoring failed for id "%s": %+v`, s.id, err)
return err
}
}
}
// Session id creation.
if s.id == "" {
if s.idFunc != nil {
// Use custom session id creating function.
s.id = s.idFunc(s.manager.ttl)
} else {
// Use default session id creating function of storage.
s.id, err = s.manager.storage.New(s.ctx, s.manager.ttl)
if err != nil && err != ErrorDisabled {
intlog.Errorf(s.ctx, "create session id failed: %+v", err)
return err
}
// If session storage does not implements id generating functionality,
// it then uses default session id creating function.
if s.id == "" {
s.id = NewSessionId()
}
}
}
if s.data == nil {
s.data = gmap.NewStrAnyMap(true)
}
s.start = true
return nil
}
// Close closes current session and updates its ttl in the session manager.
// If this session is dirty, it also exports it to storage.
//
// NOTE that this function must be called ever after a session request done.
func (s *Session) Close() error {
if s.manager.storage == nil {
return nil
}
if s.start && s.id != "" {
size := s.data.Size()
if s.dirty {
err := s.manager.storage.SetSession(s.ctx, s.id, s.data, s.manager.ttl)
if err != nil && err != ErrorDisabled {
return err
}
} else if size > 0 {
err := s.manager.storage.UpdateTTL(s.ctx, s.id, s.manager.ttl)
if err != nil && err != ErrorDisabled {
return err
}
}
}
return nil
}
// Set sets key-value pair to this session.
func (s *Session) Set(key string, value interface{}) (err error) {
if err = s.init(); err != nil {
return err
}
if err = s.manager.storage.Set(s.ctx, s.id, key, value, s.manager.ttl); err != nil {
if err == ErrorDisabled {
s.data.Set(key, value)
} else {
return err
}
}
s.dirty = true
return nil
}
// SetMap batch sets the session using map.
func (s *Session) SetMap(data map[string]interface{}) (err error) {
if err = s.init(); err != nil {
return err
}
if err = s.manager.storage.SetMap(s.ctx, s.id, data, s.manager.ttl); err != nil {
if err == ErrorDisabled {
s.data.Sets(data)
} else {
return err
}
}
s.dirty = true
return nil
}
// Remove removes key along with its value from this session.
func (s *Session) Remove(keys ...string) (err error) {
if s.id == "" {
return nil
}
if err = s.init(); err != nil {
return err
}
for _, key := range keys {
if err = s.manager.storage.Remove(s.ctx, s.id, key); err != nil {
if err == ErrorDisabled {
s.data.Remove(key)
} else {
return err
}
}
}
s.dirty = true
return nil
}
// RemoveAll deletes all key-value pairs from this session.
func (s *Session) RemoveAll() (err error) {
if s.id == "" {
return nil
}
if err = s.init(); err != nil {
return err
}
if err = s.manager.storage.RemoveAll(s.ctx, s.id); err != nil {
if err != ErrorDisabled {
return err
}
}
// Remove data from memory.
if s.data != nil {
s.data.Clear()
}
s.dirty = true
return nil
}
// Id returns the session id for this session.
// It creates and returns a new session id if the session id is not passed in initialization.
func (s *Session) Id() (id string, err error) {
if err = s.init(); err != nil {
return "", err
}
return s.id, nil
}
// SetId sets custom session before session starts.
// It returns error if it is called after session starts.
func (s *Session) SetId(id string) error {
if s.start {
return gerror.NewCode(gcode.CodeInvalidOperation, "session already started")
}
s.id = id
return nil
}
// SetIdFunc sets custom session id creating function before session starts.
// It returns error if it is called after session starts.
func (s *Session) SetIdFunc(f func(ttl time.Duration) string) error {
if s.start {
return gerror.NewCode(gcode.CodeInvalidOperation, "session already started")
}
s.idFunc = f
return nil
}
// Data returns all data as map.
// Note that it's using value copy internally for concurrent-safe purpose.
func (s *Session) Data() (sessionData map[string]interface{}, err error) {
if s.id == "" {
return map[string]interface{}{}, nil
}
if err = s.init(); err != nil {
return nil, err
}
sessionData, err = s.manager.storage.Data(s.ctx, s.id)
if err != nil && err != ErrorDisabled {
intlog.Errorf(s.ctx, `%+v`, err)
}
if sessionData != nil {
return sessionData, nil
}
return s.data.Map(), nil
}
// Size returns the size of the session.
func (s *Session) Size() (size int, err error) {
if s.id == "" {
return 0, nil
}
if err = s.init(); err != nil {
return 0, err
}
size, err = s.manager.storage.GetSize(s.ctx, s.id)
if err != nil && err != ErrorDisabled {
intlog.Errorf(s.ctx, `%+v`, err)
}
if size > 0 {
return size, nil
}
return s.data.Size(), nil
}
// Contains checks whether key exist in the session.
func (s *Session) Contains(key string) (ok bool, err error) {
if s.id == "" {
return false, nil
}
if err = s.init(); err != nil {
return false, err
}
v, err := s.Get(key)
if err != nil {
return false, err
}
return !v.IsNil(), nil
}
// IsDirty checks whether there's any data changes in the session.
func (s *Session) IsDirty() bool {
return s.dirty
}
// Get retrieves session value with given key.
// It returns `def` if the key does not exist in the session if `def` is given,
// or else it returns nil.
func (s *Session) Get(key string, def ...interface{}) (value *gvar.Var, err error) {
if s.id == "" {
return nil, nil
}
if err = s.init(); err != nil {
return nil, err
}
v, err := s.manager.storage.Get(s.ctx, s.id, key)
if err != nil && err != ErrorDisabled {
intlog.Errorf(s.ctx, `%+v`, err)
return nil, err
}
if v != nil {
return gvar.New(v), nil
}
if v = s.data.Get(key); v != nil {
return gvar.New(v), nil
}
if len(def) > 0 {
return gvar.New(def[0]), nil
}
return nil, nil
}
// MustId performs as function Id, but it panics if any error occurs.
func (s *Session) MustId() string {
id, err := s.Id()
if err != nil {
panic(err)
}
return id
}
// MustGet performs as function Get, but it panics if any error occurs.
func (s *Session) MustGet(key string, def ...interface{}) *gvar.Var {
v, err := s.Get(key, def...)
if err != nil {
panic(err)
}
return v
}
// MustSet performs as function Set, but it panics if any error occurs.
func (s *Session) MustSet(key string, value interface{}) {
err := s.Set(key, value)
if err != nil {
panic(err)
}
}
// MustSetMap performs as function SetMap, but it panics if any error occurs.
func (s *Session) MustSetMap(data map[string]interface{}) {
err := s.SetMap(data)
if err != nil {
panic(err)
}
}
// MustContains performs as function Contains, but it panics if any error occurs.
func (s *Session) MustContains(key string) bool {
b, err := s.Contains(key)
if err != nil {
panic(err)
}
return b
}
// MustData performs as function Data, but it panics if any error occurs.
func (s *Session) MustData() map[string]interface{} {
m, err := s.Data()
if err != nil {
panic(err)
}
return m
}
// MustSize performs as function Size, but it panics if any error occurs.
func (s *Session) MustSize() int {
size, err := s.Size()
if err != nil {
panic(err)
}
return size
}
// MustRemove performs as function Remove, but it panics if any error occurs.
func (s *Session) MustRemove(keys ...string) {
err := s.Remove(keys...)
if err != nil {
panic(err)
}
}