forked from keybase/client
-
Notifications
You must be signed in to change notification settings - Fork 0
/
settings_db.go
224 lines (198 loc) · 6 KB
/
settings_db.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
package libkbfs
import (
"os"
"path"
"strconv"
"sync"
"github.com/keybase/client/go/kbfs/idutil"
"github.com/keybase/client/go/kbfs/ldbutils"
"github.com/keybase/client/go/libkb"
"github.com/keybase/client/go/logger"
"github.com/keybase/client/go/protocol/keybase1"
"github.com/pkg/errors"
"github.com/syndtr/goleveldb/leveldb"
"github.com/syndtr/goleveldb/leveldb/opt"
"github.com/syndtr/goleveldb/leveldb/storage"
"golang.org/x/net/context"
)
const (
// Where in config.StorageRoot() we store settings information.
settingsDBDir = "kbfs_settings"
settingsDBVersionString = "v1"
settingsDBName = "kbfsSettings.leveldb"
// Settings keys
spaceAvailableNotificationThresholdKey = "spaceAvailableNotificationThreshold"
sfmiBannerDismissedKey = "sfmiBannerDismissed"
)
// ErrNoSettingsDB is returned when there is no settings DB potentially due to
// multiple concurrent KBFS instances.
var ErrNoSettingsDB = errors.New("no settings DB")
var errNoSession = errors.New("no session")
type currentSessionGetter interface {
CurrentSessionGetter() idutil.CurrentSessionGetter
}
// SettingsDB stores KBFS user settings for a given device.
type SettingsDB struct {
*ldbutils.LevelDb
sessionGetter currentSessionGetter
logger logger.Logger
vlogger *libkb.VDebugLog
lock sync.RWMutex
cache map[string][]byte
}
func openSettingsDBInternal(config Config) (*ldbutils.LevelDb, error) {
if config.IsTestMode() {
return ldbutils.OpenLevelDb(storage.NewMemStorage(), config.Mode())
}
dbPath := path.Join(config.StorageRoot(), settingsDBDir,
settingsDBVersionString)
err := os.MkdirAll(dbPath, os.ModePerm)
if err != nil {
return nil, err
}
stor, err := storage.OpenFile(path.Join(dbPath, settingsDBName), false)
if err != nil {
return nil, err
}
return ldbutils.OpenLevelDb(stor, config.Mode())
}
func openSettingsDB(config Config) *SettingsDB {
logger := config.MakeLogger("SDB")
vlogger := config.MakeVLogger(logger)
db, err := openSettingsDBInternal(config)
if err != nil {
logger.CWarningf(context.Background(),
"Could not open settings DB. "+
"Perhaps multiple KBFS instances are being run concurrently"+
"? Error: %+v", err)
if db != nil {
db.Close()
}
return nil
}
return &SettingsDB{
LevelDb: db,
sessionGetter: config,
logger: logger,
vlogger: vlogger,
cache: make(map[string][]byte),
}
}
func (db *SettingsDB) getUID(ctx context.Context) keybase1.UID {
if db.sessionGetter == nil || db.sessionGetter.CurrentSessionGetter() == nil {
return keybase1.UID("")
}
si, err := db.sessionGetter.CurrentSessionGetter().GetCurrentSession(ctx)
if err != nil {
return keybase1.UID("")
}
return si.UID
}
func getSettingsDbKey(uid keybase1.UID, key string) []byte {
return append([]byte(uid), []byte(key)...)
}
func (db *SettingsDB) getFromCache(key string) (val []byte, isCached bool) {
db.lock.RLock()
defer db.lock.RUnlock()
val, isCached = db.cache[key]
return val, isCached
}
func (db *SettingsDB) updateCache(key string, val []byte) {
db.lock.Lock()
defer db.lock.Unlock()
if val == nil {
delete(db.cache, key)
} else {
db.cache[key] = val
}
}
// Get overrides (*LevelDb).Get to cache values in memory.
func (db *SettingsDB) Get(key []byte, ro *opt.ReadOptions) ([]byte, error) {
val, isCached := db.getFromCache(string(key))
if isCached {
return val, nil
}
val, err := db.LevelDb.Get(key, ro)
if err == nil {
db.updateCache(string(key), val)
}
return val, err
}
// Put overrides (*LevelDb).Put to cache values in memory.
func (db *SettingsDB) Put(key []byte, val []byte, wo *opt.WriteOptions) error {
err := db.LevelDb.Put(key, val, wo)
if err != nil {
db.updateCache(string(key), nil)
} else {
db.updateCache(string(key), val)
}
return err
}
// Settings returns the logged-in user's settings as a keybase1.FSSettings.
func (db *SettingsDB) Settings(ctx context.Context) (keybase1.FSSettings, error) {
uid := db.getUID(ctx)
if uid == keybase1.UID("") {
return keybase1.FSSettings{}, errNoSession
}
var notificationThreshold int64
notificationThresholdBytes, err :=
db.Get(getSettingsDbKey(uid, spaceAvailableNotificationThresholdKey), nil)
switch errors.Cause(err) {
case leveldb.ErrNotFound:
db.logger.CDebugf(ctx,
"notificationThreshold not set; using default value")
case nil:
notificationThreshold, err =
strconv.ParseInt(string(notificationThresholdBytes), 10, 64)
if err != nil {
return keybase1.FSSettings{}, err
}
default:
db.logger.CWarningf(ctx,
"reading notificationThreshold from leveldb error: %+v", err)
return keybase1.FSSettings{}, err
}
var sfmiBannerDismissed bool
sfmiBannerDismissedBytes, err :=
db.Get(getSettingsDbKey(uid, sfmiBannerDismissedKey), nil)
switch errors.Cause(err) {
case leveldb.ErrNotFound:
db.vlogger.CLogf(ctx, libkb.VLog1,
"sfmiBannerDismissed not set; using default value")
case nil:
sfmiBannerDismissed, err =
strconv.ParseBool(string(sfmiBannerDismissedBytes))
if err != nil {
return keybase1.FSSettings{}, err
}
default:
db.logger.CWarningf(ctx,
"reading sfmiBannerDismissed from leveldb error: %+v", err)
return keybase1.FSSettings{}, err
}
return keybase1.FSSettings{
SpaceAvailableNotificationThreshold: notificationThreshold,
SfmiBannerDismissed: sfmiBannerDismissed,
}, nil
}
// SetNotificationThreshold sets the notification threshold setting for the
// logged-in user.
func (db *SettingsDB) SetNotificationThreshold(
ctx context.Context, threshold int64) error {
uid := db.getUID(ctx)
if uid == keybase1.UID("") {
return errNoSession
}
return db.Put(getSettingsDbKey(uid, spaceAvailableNotificationThresholdKey),
[]byte(strconv.FormatInt(threshold, 10)), nil)
}
// SetSfmiBannerDismissed hello from this comment
func (db *SettingsDB) SetSfmiBannerDismissed(
ctx context.Context, dismissed bool) error {
uid := db.getUID(ctx)
if uid == keybase1.UID("") {
return errNoSession
}
return db.Put(getSettingsDbKey(uid, sfmiBannerDismissedKey),
[]byte(strconv.FormatBool(dismissed)), nil)
}