/
gsession_storage_file.go
246 lines (219 loc) · 7.56 KB
/
gsession_storage_file.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
// 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"
"github.com/gogf/gf/container/gmap"
"github.com/gogf/gf/errors/gcode"
"github.com/gogf/gf/errors/gerror"
"github.com/gogf/gf/internal/intlog"
"github.com/gogf/gf/internal/json"
"os"
"time"
"github.com/gogf/gf/crypto/gaes"
"github.com/gogf/gf/os/gtimer"
"github.com/gogf/gf/container/gset"
"github.com/gogf/gf/encoding/gbinary"
"github.com/gogf/gf/os/gtime"
"github.com/gogf/gf/os/gfile"
)
// StorageFile implements the Session Storage interface with file system.
type StorageFile struct {
path string
cryptoKey []byte
cryptoEnabled bool
updatingIdSet *gset.StrSet
}
var (
DefaultStorageFilePath = gfile.TempDir("gsessions")
DefaultStorageFileCryptoKey = []byte("Session storage file crypto key!")
DefaultStorageFileCryptoEnabled = false
DefaultStorageFileLoopInterval = 10 * time.Second
)
// NewStorageFile creates and returns a file storage object for session.
func NewStorageFile(path ...string) *StorageFile {
storagePath := DefaultStorageFilePath
if len(path) > 0 && path[0] != "" {
storagePath, _ = gfile.Search(path[0])
if storagePath == "" {
panic(gerror.NewCodef(gcode.CodeInvalidParameter, `"%s" does not exist`, path[0]))
}
if !gfile.IsWritable(storagePath) {
panic(gerror.NewCodef(gcode.CodeInvalidParameter, `"%s" is not writable`, path[0]))
}
}
if storagePath != "" {
if err := gfile.Mkdir(storagePath); err != nil {
panic(gerror.WrapCodef(gcode.CodeInternalError, err, `Mkdir "%s" failed in PWD "%s"`, path, gfile.Pwd()))
}
}
s := &StorageFile{
path: storagePath,
cryptoKey: DefaultStorageFileCryptoKey,
cryptoEnabled: DefaultStorageFileCryptoEnabled,
updatingIdSet: gset.NewStrSet(true),
}
gtimer.AddSingleton(DefaultStorageFileLoopInterval, s.updateSessionTimely)
return s
}
// updateSessionTimely batch updates the TTL for sessions timely.
func (s *StorageFile) updateSessionTimely() {
var (
id string
err error
)
// Batch updating sessions.
for {
if id = s.updatingIdSet.Pop(); id == "" {
break
}
if err = s.updateSessionTTl(context.TODO(), id); err != nil {
intlog.Error(context.TODO(), err)
}
}
}
// SetCryptoKey sets the crypto key for session storage.
// The crypto key is used when crypto feature is enabled.
func (s *StorageFile) SetCryptoKey(key []byte) {
s.cryptoKey = key
}
// SetCryptoEnabled enables/disables the crypto feature for session storage.
func (s *StorageFile) SetCryptoEnabled(enabled bool) {
s.cryptoEnabled = enabled
}
// sessionFilePath returns the storage file path for given session id.
func (s *StorageFile) sessionFilePath(id string) string {
return gfile.Join(s.path, id)
}
// New creates a session id.
// This function can be used for custom session creation.
func (s *StorageFile) New(ctx context.Context, ttl time.Duration) (id string, err error) {
return "", ErrorDisabled
}
// Get retrieves session value with given key.
// It returns nil if the key does not exist in the session.
func (s *StorageFile) Get(ctx context.Context, id string, key string) (value interface{}, err error) {
return nil, ErrorDisabled
}
// GetMap retrieves all key-value pairs as map from storage.
func (s *StorageFile) GetMap(ctx context.Context, id string) (data map[string]interface{}, err error) {
return nil, ErrorDisabled
}
// GetSize retrieves the size of key-value pairs from storage.
func (s *StorageFile) GetSize(ctx context.Context, id string) (size int, err error) {
return -1, ErrorDisabled
}
// Set sets key-value session pair to the storage.
// The parameter `ttl` specifies the TTL for the session id (not for the key-value pair).
func (s *StorageFile) Set(ctx context.Context, id string, key string, value interface{}, ttl time.Duration) error {
return ErrorDisabled
}
// SetMap batch sets key-value session pairs with map to the storage.
// The parameter `ttl` specifies the TTL for the session id(not for the key-value pair).
func (s *StorageFile) SetMap(ctx context.Context, id string, data map[string]interface{}, ttl time.Duration) error {
return ErrorDisabled
}
// Remove deletes key with its value from storage.
func (s *StorageFile) Remove(ctx context.Context, id string, key string) error {
return ErrorDisabled
}
// RemoveAll deletes all key-value pairs from storage.
func (s *StorageFile) RemoveAll(ctx context.Context, id string) error {
return ErrorDisabled
}
// GetSession returns the session data as *gmap.StrAnyMap for given session id from storage.
//
// The parameter `ttl` specifies the TTL for this session, and it returns nil if the TTL is exceeded.
// The parameter `data` is the current old session data stored in memory,
// and for some storage it might be nil if memory storage is disabled.
//
// This function is called ever when session starts.
func (s *StorageFile) GetSession(ctx context.Context, id string, ttl time.Duration, data *gmap.StrAnyMap) (*gmap.StrAnyMap, error) {
if data != nil {
return data, nil
}
path := s.sessionFilePath(id)
content := gfile.GetBytes(path)
if len(content) > 8 {
timestampMilli := gbinary.DecodeToInt64(content[:8])
if timestampMilli+ttl.Nanoseconds()/1e6 < gtime.TimestampMilli() {
return nil, nil
}
var err error
content = content[8:]
// Decrypt with AES.
if s.cryptoEnabled {
content, err = gaes.Decrypt(content, DefaultStorageFileCryptoKey)
if err != nil {
return nil, err
}
}
var m map[string]interface{}
if err = json.UnmarshalUseNumber(content, &m); err != nil {
return nil, err
}
if m == nil {
return nil, nil
}
return gmap.NewStrAnyMapFrom(m, true), nil
}
return nil, nil
}
// SetSession updates the data map for specified session id.
// This function is called ever after session, which is changed dirty, is closed.
// This copy all session data map from memory to storage.
func (s *StorageFile) SetSession(ctx context.Context, id string, data *gmap.StrAnyMap, ttl time.Duration) error {
intlog.Printf(ctx, "StorageFile.SetSession: %s, %v, %v", id, data, ttl)
path := s.sessionFilePath(id)
content, err := json.Marshal(data)
if err != nil {
return err
}
// Encrypt with AES.
if s.cryptoEnabled {
content, err = gaes.Encrypt(content, DefaultStorageFileCryptoKey)
if err != nil {
return err
}
}
file, err := gfile.OpenWithFlagPerm(
path, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, os.ModePerm,
)
if err != nil {
return err
}
defer file.Close()
if _, err = file.Write(gbinary.EncodeInt64(gtime.TimestampMilli())); err != nil {
return err
}
if _, err = file.Write(content); err != nil {
return err
}
return nil
}
// UpdateTTL updates the TTL for specified session id.
// This function is called ever after session, which is not dirty, is closed.
// It just adds the session id to the async handling queue.
func (s *StorageFile) UpdateTTL(ctx context.Context, id string, ttl time.Duration) error {
intlog.Printf(ctx, "StorageFile.UpdateTTL: %s, %v", id, ttl)
if ttl >= DefaultStorageFileLoopInterval {
s.updatingIdSet.Add(id)
}
return nil
}
// updateSessionTTL updates the TTL for specified session id.
func (s *StorageFile) updateSessionTTl(ctx context.Context, id string) error {
intlog.Printf(ctx, "StorageFile.updateSession: %s", id)
path := s.sessionFilePath(id)
file, err := gfile.OpenWithFlag(path, os.O_WRONLY)
if err != nil {
return err
}
if _, err = file.WriteAt(gbinary.EncodeInt64(gtime.TimestampMilli()), 0); err != nil {
return err
}
return file.Close()
}