|
| 1 | +// Copyright 2019 The Gitea Authors. All rights reserved. |
| 2 | +// Use of this source code is governed by a MIT-style |
| 3 | +// license that can be found in the LICENSE file. |
| 4 | + |
| 5 | +package session |
| 6 | + |
| 7 | +import ( |
| 8 | + "encoding/json" |
| 9 | + "fmt" |
| 10 | + "sync" |
| 11 | + |
| 12 | + "github.com/go-macaron/session" |
| 13 | + couchbase "github.com/go-macaron/session/couchbase" |
| 14 | + memcache "github.com/go-macaron/session/memcache" |
| 15 | + mysql "github.com/go-macaron/session/mysql" |
| 16 | + nodb "github.com/go-macaron/session/nodb" |
| 17 | + postgres "github.com/go-macaron/session/postgres" |
| 18 | + redis "github.com/go-macaron/session/redis" |
| 19 | +) |
| 20 | + |
| 21 | +// VirtualSessionProvider represents a shadowed session provider implementation. |
| 22 | +type VirtualSessionProvider struct { |
| 23 | + lock sync.RWMutex |
| 24 | + maxlifetime int64 |
| 25 | + rootPath string |
| 26 | + provider session.Provider |
| 27 | +} |
| 28 | + |
| 29 | +// Init initializes the cookie session provider with given root path. |
| 30 | +func (o *VirtualSessionProvider) Init(gclifetime int64, config string) error { |
| 31 | + var opts session.Options |
| 32 | + if err := json.Unmarshal([]byte(config), &opts); err != nil { |
| 33 | + return err |
| 34 | + } |
| 35 | + // Note that these options are unprepared so we can't just use NewManager here. |
| 36 | + // Nor can we access the provider map in session. |
| 37 | + // So we will just have to do this by hand. |
| 38 | + // This is only slightly more wrong than modules/setting/session.go:23 |
| 39 | + switch opts.Provider { |
| 40 | + case "memory": |
| 41 | + o.provider = &session.MemProvider{} |
| 42 | + case "file": |
| 43 | + o.provider = &session.FileProvider{} |
| 44 | + case "redis": |
| 45 | + o.provider = &redis.RedisProvider{} |
| 46 | + case "mysql": |
| 47 | + o.provider = &mysql.MysqlProvider{} |
| 48 | + case "postgres": |
| 49 | + o.provider = &postgres.PostgresProvider{} |
| 50 | + case "couchbase": |
| 51 | + o.provider = &couchbase.CouchbaseProvider{} |
| 52 | + case "memcache": |
| 53 | + o.provider = &memcache.MemcacheProvider{} |
| 54 | + case "nodb": |
| 55 | + o.provider = &nodb.NodbProvider{} |
| 56 | + default: |
| 57 | + return fmt.Errorf("VirtualSessionProvider: Unknown Provider: %s", opts.Provider) |
| 58 | + } |
| 59 | + return o.provider.Init(gclifetime, opts.ProviderConfig) |
| 60 | +} |
| 61 | + |
| 62 | +// Read returns raw session store by session ID. |
| 63 | +func (o *VirtualSessionProvider) Read(sid string) (session.RawStore, error) { |
| 64 | + o.lock.RLock() |
| 65 | + defer o.lock.RUnlock() |
| 66 | + if o.provider.Exist(sid) { |
| 67 | + return o.provider.Read(sid) |
| 68 | + } |
| 69 | + kv := make(map[interface{}]interface{}) |
| 70 | + kv["_old_uid"] = "0" |
| 71 | + return NewVirtualStore(o, sid, kv), nil |
| 72 | +} |
| 73 | + |
| 74 | +// Exist returns true if session with given ID exists. |
| 75 | +func (o *VirtualSessionProvider) Exist(sid string) bool { |
| 76 | + return true |
| 77 | +} |
| 78 | + |
| 79 | +// Destory deletes a session by session ID. |
| 80 | +func (o *VirtualSessionProvider) Destory(sid string) error { |
| 81 | + o.lock.Lock() |
| 82 | + defer o.lock.Unlock() |
| 83 | + return o.provider.Destory(sid) |
| 84 | +} |
| 85 | + |
| 86 | +// Regenerate regenerates a session store from old session ID to new one. |
| 87 | +func (o *VirtualSessionProvider) Regenerate(oldsid, sid string) (session.RawStore, error) { |
| 88 | + o.lock.Lock() |
| 89 | + defer o.lock.Unlock() |
| 90 | + return o.provider.Regenerate(oldsid, sid) |
| 91 | +} |
| 92 | + |
| 93 | +// Count counts and returns number of sessions. |
| 94 | +func (o *VirtualSessionProvider) Count() int { |
| 95 | + o.lock.RLock() |
| 96 | + defer o.lock.RUnlock() |
| 97 | + return o.provider.Count() |
| 98 | +} |
| 99 | + |
| 100 | +// GC calls GC to clean expired sessions. |
| 101 | +func (o *VirtualSessionProvider) GC() { |
| 102 | + o.provider.GC() |
| 103 | +} |
| 104 | + |
| 105 | +func init() { |
| 106 | + session.Register("VirtualSession", &VirtualSessionProvider{}) |
| 107 | +} |
| 108 | + |
| 109 | +// VirtualStore represents a virtual session store implementation. |
| 110 | +type VirtualStore struct { |
| 111 | + p *VirtualSessionProvider |
| 112 | + sid string |
| 113 | + lock sync.RWMutex |
| 114 | + data map[interface{}]interface{} |
| 115 | +} |
| 116 | + |
| 117 | +// NewVirtualStore creates and returns a virtual session store. |
| 118 | +func NewVirtualStore(p *VirtualSessionProvider, sid string, kv map[interface{}]interface{}) *VirtualStore { |
| 119 | + return &VirtualStore{ |
| 120 | + p: p, |
| 121 | + sid: sid, |
| 122 | + data: kv, |
| 123 | + } |
| 124 | +} |
| 125 | + |
| 126 | +// Set sets value to given key in session. |
| 127 | +func (s *VirtualStore) Set(key, val interface{}) error { |
| 128 | + s.lock.Lock() |
| 129 | + defer s.lock.Unlock() |
| 130 | + |
| 131 | + s.data[key] = val |
| 132 | + return nil |
| 133 | +} |
| 134 | + |
| 135 | +// Get gets value by given key in session. |
| 136 | +func (s *VirtualStore) Get(key interface{}) interface{} { |
| 137 | + s.lock.RLock() |
| 138 | + defer s.lock.RUnlock() |
| 139 | + |
| 140 | + return s.data[key] |
| 141 | +} |
| 142 | + |
| 143 | +// Delete delete a key from session. |
| 144 | +func (s *VirtualStore) Delete(key interface{}) error { |
| 145 | + s.lock.Lock() |
| 146 | + defer s.lock.Unlock() |
| 147 | + |
| 148 | + delete(s.data, key) |
| 149 | + return nil |
| 150 | +} |
| 151 | + |
| 152 | +// ID returns current session ID. |
| 153 | +func (s *VirtualStore) ID() string { |
| 154 | + return s.sid |
| 155 | +} |
| 156 | + |
| 157 | +// Release releases resource and save data to provider. |
| 158 | +func (s *VirtualStore) Release() error { |
| 159 | + s.lock.Lock() |
| 160 | + defer s.lock.Unlock() |
| 161 | + // Now need to lock the provider |
| 162 | + s.p.lock.Lock() |
| 163 | + defer s.p.lock.Unlock() |
| 164 | + if oldUID, ok := s.data["_old_uid"]; (ok && (oldUID != "0" || len(s.data) > 1)) || (!ok && len(s.data) > 0) { |
| 165 | + // Now ensure that we don't exist! |
| 166 | + realProvider := s.p.provider |
| 167 | + |
| 168 | + if realProvider.Exist(s.sid) { |
| 169 | + // This is an error! |
| 170 | + return fmt.Errorf("new sid '%s' already exists", s.sid) |
| 171 | + } |
| 172 | + realStore, err := realProvider.Read(s.sid) |
| 173 | + if err != nil { |
| 174 | + return err |
| 175 | + } |
| 176 | + for key, value := range s.data { |
| 177 | + if err := realStore.Set(key, value); err != nil { |
| 178 | + return err |
| 179 | + } |
| 180 | + } |
| 181 | + return realStore.Release() |
| 182 | + } |
| 183 | + return nil |
| 184 | +} |
| 185 | + |
| 186 | +// Flush deletes all session data. |
| 187 | +func (s *VirtualStore) Flush() error { |
| 188 | + s.lock.Lock() |
| 189 | + defer s.lock.Unlock() |
| 190 | + |
| 191 | + s.data = make(map[interface{}]interface{}) |
| 192 | + return nil |
| 193 | +} |
0 commit comments