forked from alexedwards/scs
/
gormstore.go
160 lines (145 loc) · 4.39 KB
/
gormstore.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
package gormstore
import (
"errors"
"log"
"time"
"gorm.io/gorm"
)
// GORMStore represents the session store.
type GORMStore struct {
db *gorm.DB
stopCleanup chan bool
}
type session struct {
Token string `gorm:"column:token;primaryKey;type:varchar(43)"`
Data []byte `gorm:"column:data"`
Expiry time.Time `gorm:"column:expiry;index"`
}
func (session) TableName() string {
return "sessions"
}
// New returns a new GORMStore instance, with a background cleanup goroutine
// that runs every 5 minutes to remove expired session data.
func New(db *gorm.DB) (*GORMStore, error) {
return NewWithCleanupInterval(db, 5*time.Minute)
}
// NewWithCleanupInterval returns a new GORMStore instance. The cleanupInterval
// parameter controls how frequently expired session data is removed by the
// background cleanup goroutine. Setting it to 0 prevents the cleanup goroutine
// from running (i.e. expired sessions will not be removed).
func NewWithCleanupInterval(db *gorm.DB, cleanupInterval time.Duration) (*GORMStore, error) {
g := &GORMStore{db: db}
if err := g.migrate(); err != nil {
return nil, err
}
if cleanupInterval > 0 {
go g.startCleanup(cleanupInterval)
}
return g, nil
}
// Find returns the data for a given session token from the GORMStore instance.
// If the session token is not found or is expired, the returned exists flag will
// be set to false.
func (g *GORMStore) Find(token string) (b []byte, exists bool, err error) {
s := &session{}
row := g.db.First(s, "token = ? AND expiry >= ?", token, time.Now())
if errors.Is(row.Error, gorm.ErrRecordNotFound) {
return nil, false, nil
} else if row.Error != nil {
return nil, false, row.Error
}
return s.Data, true, nil
}
// Commit adds a session token and data to the GORMStore instance with the
// given expiry time. If the session token already exists, then the data and expiry
// time are updated.
func (g *GORMStore) Commit(token string, b []byte, expiry time.Time) error {
s := &session{}
row := g.db.Where(session{Token: token}).Assign(session{Data: b, Expiry: expiry}).FirstOrCreate(s)
if row.Error != nil {
return row.Error
}
return nil
}
// Delete removes a session token and corresponding data from the GORMStore
// instance.
func (g *GORMStore) Delete(token string) error {
row := g.db.Delete(&session{}, "token = ?", token)
if row.Error != nil {
return row.Error
}
return nil
}
// All returns a map containing the token and data for all active (i.e.
// not expired) sessions in the GORMStore instance.
func (g *GORMStore) All() (map[string][]byte, error) {
rows, err := g.db.Find(&[]session{}, "expiry >= ?", time.Now()).Rows()
if err != nil {
return nil, err
}
defer rows.Close()
ss := make(map[string][]byte)
for rows.Next() {
s := &session{}
err := g.db.ScanRows(rows, s)
if err != nil {
return nil, err
}
ss[s.Token] = s.Data
}
err = rows.Err()
if err != nil {
return nil, err
}
return ss, nil
}
func (g *GORMStore) migrate() error {
var tableOptions string
// Set table options for MySQL database dialect.
if g.db.Dialector.Name() == "mysql" {
tableOptions = "ENGINE=InnoDB CHARSET=utf8mb4"
}
err := g.db.Set("gorm:table_options", tableOptions).AutoMigrate(&session{})
if err != nil {
return err
}
return nil
}
func (g *GORMStore) startCleanup(interval time.Duration) {
g.stopCleanup = make(chan bool)
ticker := time.NewTicker(interval)
for {
select {
case <-ticker.C:
err := g.deleteExpired()
if err != nil {
log.Println(err)
}
case <-g.stopCleanup:
ticker.Stop()
return
}
}
}
// StopCleanup terminates the background cleanup goroutine for the GORMStore
// instance. It's rare to terminate this; generally GORMStore instances and
// their cleanup goroutines are intended to be long-lived and run for the lifetime
// of your application.
//
// There may be occasions though when your use of the GORMStore is transient.
// An example is creating a new GORMStore instance in a test function. In this
// scenario, the cleanup goroutine (which will run forever) will prevent the
// GORMStore object from being garbage collected even after the test function
// has finished. You can prevent this by manually calling StopCleanup.
func (g *GORMStore) StopCleanup() {
if g.stopCleanup != nil {
g.stopCleanup <- true
}
}
func (g *GORMStore) deleteExpired() error {
row := g.db.Delete(&session{}, "expiry < ?", time.Now())
if row.Error != nil {
return row.Error
}
return nil
}