-
Notifications
You must be signed in to change notification settings - Fork 11
/
mysql.go
414 lines (374 loc) · 10.4 KB
/
mysql.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
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
package mysql
import (
"database/sql"
"encoding/base32"
"fmt"
"log"
"strings"
"sync"
"time"
"github.com/admpub/errors"
"github.com/admpub/null"
"github.com/admpub/securecookie"
"github.com/admpub/sessions"
"github.com/go-sql-driver/mysql"
"github.com/webx-top/echo"
"github.com/webx-top/echo/encoding/dbconfig"
ss "github.com/webx-top/echo/middleware/session/engine"
"github.com/webx-top/echo/middleware/session/engine/file"
)
var DefaultMaxReconnect = 5
func New(cfg *Options) sessions.Store {
cfg.Config.Engine = `mysql`
eng, err := NewMySQLStore(cfg)
if err != nil {
retries := cfg.MaxReconnect
if retries <= 0 {
retries = DefaultMaxReconnect
}
for i := 1; i < retries; i++ {
log.Println(`[sessions]`, err.Error())
wait := time.Second
log.Printf(`[sessions] (%d/%d) reconnect mysql after %v`, i, retries, wait)
time.Sleep(wait)
eng, err = NewMySQLStore(cfg)
if err == nil {
log.Println(`[sessions] reconnect mysql successfully`)
return eng
}
}
}
if err != nil {
log.Println("sessions: Operation MySQL failed:", err)
return file.NewFilesystemStore(&file.FileOptions{
SavePath: ``,
KeyPairs: cfg.KeyPairs,
CheckInterval: cfg.CheckInterval,
})
}
return eng
}
func Reg(store sessions.Store, args ...string) {
name := `mysql`
if len(args) > 0 {
name = args[0]
}
ss.Reg(name, store)
}
func RegWithOptions(opts *Options, args ...string) sessions.Store {
store := New(opts)
Reg(store, args...)
return store
}
type Options struct {
Config dbconfig.Config `json:"-"`
Table string `json:"table"`
KeyPairs [][]byte `json:"-"`
MaxAge int `json:"maxAge"`
MaxLength int `json:"maxLength"`
CheckInterval time.Duration `json:"checkInterval"`
MaxReconnect int `json:"maxReconnect"`
}
type MySQLStore struct {
db *sql.DB
stmtInsert *sql.Stmt
stmtDelete *sql.Stmt
stmtUpdate *sql.Stmt
stmtSelect *sql.Stmt
Codecs []securecookie.Codec
table string
maxAge int
checkInterval time.Duration
quiteC chan<- struct{}
doneC <-chan struct{}
once sync.Once
}
const DDL = "CREATE TABLE IF NOT EXISTS %s (" +
" `id` char(64) NOT NULL," +
" `data` longblob NOT NULL," +
" `created` int(11) unsigned NOT NULL DEFAULT '0'," +
" `modified` int(11) unsigned NOT NULL DEFAULT '0'," +
" `expires` int(11) unsigned NOT NULL DEFAULT '0'," +
" PRIMARY KEY (`id`)" +
" ) ENGINE=InnoDB;"
var (
DefaultKeyPrefix = `_`
)
type sessionRow struct {
id null.String
data null.Bytes
created null.Int64
modified null.Int64
expires null.Int64
}
// NewMySQLStore takes the following paramaters
// endpoint - A sql.Open style endpoint
// tableName - table where sessions are to be saved. Required fields are created automatically if the table doesnot exist.
// path - path for Set-Cookie header
// maxAge
// codecs
func NewMySQLStore(cfg *Options) (*MySQLStore, error) {
db, err := sql.Open("mysql", cfg.Config.String())
if err != nil {
return nil, err
}
return NewMySQLStoreFromConnection(db, cfg)
}
// NewMySQLStoreFromConnection .
func NewMySQLStoreFromConnection(db *sql.DB, cfg *Options) (*MySQLStore, error) {
// Make sure table name is enclosed.
tableName := "`" + strings.Trim(cfg.Table, "`") + "`"
cTableQ := fmt.Sprintf(DDL, tableName)
if _, err := db.Exec(cTableQ); err != nil {
switch verr := err.(type) {
case *mysql.MySQLError:
// Error 1142 means permission denied for create command
if verr.Number == 1142 {
break
} else {
return nil, errors.Wrap(err, cTableQ)
}
default:
return nil, err
}
}
insQ := "REPLACE INTO " + tableName +
"(id, data, created, modified, expires) VALUES (?, ?, ?, ?, ?)"
stmtInsert, stmtErr := db.Prepare(insQ)
if stmtErr != nil {
return nil, errors.Wrap(stmtErr, insQ)
}
delQ := "DELETE FROM " + tableName + " WHERE id = ?"
stmtDelete, stmtErr := db.Prepare(delQ)
if stmtErr != nil {
return nil, errors.Wrap(stmtErr, delQ)
}
updQ := "UPDATE " + tableName + " SET data = ?, created = ?, expires = ? " +
"WHERE id = ?"
stmtUpdate, stmtErr := db.Prepare(updQ)
if stmtErr != nil {
return nil, errors.Wrap(stmtErr, updQ)
}
selQ := "SELECT id, data, created, modified, expires from " +
tableName + " WHERE id = ?"
stmtSelect, stmtErr := db.Prepare(selQ)
if stmtErr != nil {
return nil, errors.Wrap(stmtErr, selQ)
}
s := &MySQLStore{
db: db,
stmtInsert: stmtInsert,
stmtDelete: stmtDelete,
stmtUpdate: stmtUpdate,
stmtSelect: stmtSelect,
Codecs: securecookie.CodecsFromPairs(cfg.KeyPairs...),
table: tableName,
maxAge: cfg.MaxAge,
checkInterval: cfg.CheckInterval,
}
if cfg.MaxLength > 0 {
s.MaxLength(cfg.MaxLength)
}
return s, nil
}
func (m *MySQLStore) Close() (err error) {
m.stmtSelect.Close()
m.stmtUpdate.Close()
m.stmtDelete.Close()
m.stmtInsert.Close()
err = m.db.Close()
m.closeCleanup()
return
}
func (m *MySQLStore) Get(ctx echo.Context, name string) (*sessions.Session, error) {
m.Init()
return sessions.GetRegistry(ctx).Get(m, name)
}
func (m *MySQLStore) New(ctx echo.Context, name string) (*sessions.Session, error) {
session := sessions.NewSession(m, name)
session.IsNew = true
var err error
value := ctx.GetCookie(name)
if len(value) == 0 {
return session, err
}
err = securecookie.DecodeMulti(name, value, &session.ID, m.Codecs...)
if err != nil {
return session, err
}
err = m.load(ctx, session)
if err == nil {
session.IsNew = false
} else if err == sql.ErrNoRows || err == errSessionExpired {
err = nil
}
return session, err
}
func (m *MySQLStore) Reload(ctx echo.Context, session *sessions.Session) error {
err := m.load(ctx, session)
if err == nil {
session.IsNew = false
} else if err == sql.ErrNoRows || err == errSessionExpired {
err = nil
}
return err
}
func (m *MySQLStore) Save(ctx echo.Context, session *sessions.Session) error {
var err error
// Delete if max-age is < 0
if ctx.CookieOptions().MaxAge < 0 {
return m.Delete(ctx, session)
}
if len(session.ID) == 0 {
// generate random session ID key suitable for storage in the db
session.ID = strings.TrimRight(
base32.StdEncoding.EncodeToString(
securecookie.GenerateRandomKey(32)), "=")
if err = m.insert(ctx, session); err != nil {
return err
}
} else if err = m.save(ctx, session); err != nil {
return err
}
encoded, err := securecookie.EncodeMulti(session.Name(), session.ID, m.Codecs...)
if err != nil {
return err
}
sessions.SetCookie(ctx, session.Name(), encoded)
return nil
}
func (m *MySQLStore) Remove(sessionID string) error {
if len(sessionID) == 0 {
return nil
}
_, delErr := m.stmtDelete.Exec(sessionID)
if delErr != nil {
return delErr
}
return nil
}
func (m *MySQLStore) insert(ctx echo.Context, session *sessions.Session) error {
var modifiedAt int64
var createdAt int64
var expiredAt int64
nowTs := time.Now().Unix()
created := session.Values[DefaultKeyPrefix+"created"]
if created == nil {
createdAt = nowTs
} else {
createdAt = created.(int64)
}
modifiedAt = createdAt
expires := session.Values[DefaultKeyPrefix+"expires"]
if expires == nil {
expiredAt = nowTs + int64(m.MaxAge(ctx))
} else {
expiredAt = expires.(int64)
}
delete(session.Values, DefaultKeyPrefix+"created")
delete(session.Values, DefaultKeyPrefix+"expires")
delete(session.Values, DefaultKeyPrefix+"modified")
encoded, err := securecookie.Gob.Serialize(session.Values)
if err != nil {
return err
}
_, insErr := m.stmtInsert.Exec(session.ID, encoded, createdAt, modifiedAt, expiredAt)
return insErr
}
func (m *MySQLStore) Delete(ctx echo.Context, session *sessions.Session) error {
sessions.SetCookie(ctx, session.Name(), ``, -1)
// Clear session values.
for k := range session.Values {
delete(session.Values, k)
}
return m.Remove(session.ID)
}
func (n *MySQLStore) MaxAge(ctx echo.Context) int {
maxAge := ctx.CookieOptions().MaxAge
if maxAge == 0 {
if n.maxAge > 0 {
maxAge = n.maxAge
} else {
maxAge = ss.DefaultMaxAge
}
}
return maxAge
}
// MaxLength restricts the maximum length of new sessions to l.
// If l is 0 there is no limit to the size of a session, use with caution.
// The default for a new FilesystemStore is 4096.
func (s *MySQLStore) MaxLength(l int) {
securecookie.SetMaxLength(s.Codecs, l)
}
func (m *MySQLStore) save(ctx echo.Context, session *sessions.Session) error {
if session.IsNew {
return m.insert(ctx, session)
}
var createdAt int64
var expiredAt int64
nowTs := time.Now().Unix()
created := session.Values[DefaultKeyPrefix+"created"]
if created == nil {
createdAt = nowTs
} else {
createdAt = created.(int64)
}
expires := session.Values[DefaultKeyPrefix+"expires"]
maxAge := int64(m.MaxAge(ctx))
if expires == nil {
expiredAt = nowTs + maxAge
} else {
expiredAt = expires.(int64)
expiresTs := nowTs + maxAge
if expiredAt < expiresTs {
expiredAt = expiresTs
}
}
delete(session.Values, DefaultKeyPrefix+"created")
delete(session.Values, DefaultKeyPrefix+"expires")
delete(session.Values, DefaultKeyPrefix+"modified")
encoded, err := securecookie.Gob.Serialize(session.Values)
if err != nil {
return err
}
//encoded := string(b)
_, updErr := m.stmtUpdate.Exec(encoded, createdAt, expiredAt, session.ID)
if updErr != nil {
return updErr
}
return nil
}
var errSessionExpired = errors.New("Session expired")
func (m *MySQLStore) load(ctx echo.Context, session *sessions.Session) error {
row := m.stmtSelect.QueryRow(session.ID)
sess := sessionRow{}
scanErr := row.Scan(&sess.id, &sess.data, &sess.created, &sess.modified, &sess.expires)
if scanErr != nil {
return scanErr
}
if sess.expires.Int64 < time.Now().Unix() {
log.Printf("Session expired on %s, but it is %s now.", time.Unix(sess.expires.Int64, 0), time.Now())
return errSessionExpired
}
err := securecookie.Gob.Deserialize(sess.data.Bytes, &session.Values)
if err != nil {
return err
}
session.Values[DefaultKeyPrefix+"created"] = sess.created.Int64
session.Values[DefaultKeyPrefix+"modified"] = sess.modified.Int64
session.Values[DefaultKeyPrefix+"expires"] = sess.expires.Int64
return nil
}
func (m *MySQLStore) closeCleanup() {
// Invoke a reaper which checks and removes expired sessions periodically.
if m.quiteC != nil && m.doneC != nil {
m.StopCleanup(m.quiteC, m.doneC)
}
}
func (m *MySQLStore) Init() {
m.once.Do(m.init)
}
func (m *MySQLStore) init() {
m.closeCleanup()
m.quiteC, m.doneC = m.Cleanup(m.checkInterval)
}