-
Notifications
You must be signed in to change notification settings - Fork 25
/
sqlitedb.go
488 lines (426 loc) · 11.1 KB
/
sqlitedb.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
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
// Copyright 2020 Dmitry Ermolov
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package datastore
import (
"database/sql"
"encoding/json"
"fmt"
"log"
"github.com/dim-an/cod/util"
_ "github.com/mattn/go-sqlite3"
)
var CurrentSchemaVersion = 1
type Storage interface {
GetCommandPolicy(args []string) (policy Policy, err error)
GetAllCompletions() (pages []HelpPage, err error)
GetCompletions(path string) (completions []Completion, err error)
AddHelpPage(helpPage *HelpPage, policy Policy) (status AddHelpPageStatus, err error)
// NB. This command might return null pointers in case some help page is broken.
ListCommands() (result map[int64]*Command, err error)
RemoveHelpPage(commandId int64) (path string, err error)
Close() error
}
func NewSqliteStorage(fileName string) (storage Storage, err error) {
db, err := sql.Open("sqlite3", fileName)
if err != nil {
return
}
err = db.Ping()
if err != nil {
return
}
err = updateSchema(db)
if err != nil {
return
}
var foreignKey string
err = db.QueryRow("pragma foreign_keys;").Scan(&foreignKey)
if err != nil {
return
}
if foreignKey == "" {
err = fmt.Errorf("sqlite doesn't support foreign keys")
return
}
_, err = db.Exec("pragma foreign_keys = on;")
if err != nil {
return
}
storage = &sqliteStorage{
db: db,
}
return
}
func withTransaction(db *sql.DB, f func(tx *sql.Tx) error) (err error) {
tx, err := db.Begin()
if err != nil {
return
}
err = f(tx)
if err != nil {
err2 := tx.Rollback()
if err2 != nil {
log.Printf("error occurred while transaction rollback: %v", err2)
}
return
}
err = tx.Commit()
return
}
func getCompletionsForExecutable(tx *sql.Tx, executablePath string) (completions []Completion, err error) {
completionRows, err := tx.Query(`
select Completion.Flag, Completion.Context
from Completion inner join HelpPage on Completion.HelpPageId = HelpPage.HelpPageId
where HelpPage.ExecutablePath = ?
`, executablePath)
if err != nil {
return
}
defer func() {
_ = completionRows.Close()
}()
for completionRows.Next() {
var contextBytes sql.NullString
completion := Completion{}
err = completionRows.Scan(&completion.Flag, &contextBytes)
util.VerifyPanic(err)
if contextBytes.Valid {
err = json.Unmarshal([]byte(contextBytes.String), &completion.Context)
if err != nil {
return
}
}
completions = append(completions, completion)
}
err = completionRows.Err()
return
}
func (s *sqliteStorage) GetCompletions(executablePath string) (completions []Completion, err error) {
err = withTransaction(s.db, func(tx *sql.Tx) (err error) {
var cur []Completion
cur, err = getCompletionsForExecutable(tx, executablePath)
if err != nil {
return
}
completions = append(completions, cur...)
return
})
return
}
func (s *sqliteStorage) AddHelpPage(helpPage *HelpPage, policy Policy) (status AddHelpPageStatus, err error) {
err = CheckHelpPage(helpPage)
if err != nil {
return
}
err = withTransaction(s.db, func(tx *sql.Tx) (err error) {
commandChecksum := util.HashStrings(helpPage.Command.Args)
if policy == PolicyUnknown {
checkSum := util.HashStrings(helpPage.Command.Args)
err = s.db.QueryRow(
`select Policy from HelpPage where CommandArgsCheckSum = ?`,
checkSum,
).Scan(&policy)
if err == sql.ErrNoRows {
err = nil
policy = PolicyUnknown
} else if err != nil {
return
}
}
var rowIdToReplace *int64
rowIdToReplace, err = removeAndMergeConflicting(tx, helpPage.ExecutablePath, commandChecksum, helpPage)
if err != nil {
return
}
err = insertHelpPage(tx, helpPage.ExecutablePath, rowIdToReplace, commandChecksum, helpPage, policy)
if err != nil {
return
}
if rowIdToReplace == nil {
status = AddHelpPageStatusNew
} else {
status = AddHelpPageStatusUpdated
}
return
})
return
}
func (s *sqliteStorage) ListCommands() (result map[int64]*Command, err error) {
rows, err := s.db.Query(`
select HelpPageId, CommandJson from HelpPage
`)
if err != nil {
return
}
defer func() {
_ = rows.Close()
}()
result = make(map[int64]*Command)
for rows.Next() {
var helpPageId int64
var commandJson []byte
err = rows.Scan(&helpPageId, &commandJson)
if err != nil {
return
}
var command Command
err = json.Unmarshal(commandJson, &command)
if err != nil {
log.Printf("HelpPage %v has broken commandJson field: %v", helpPageId, err)
result[helpPageId] = nil
} else {
result[helpPageId] = &command
}
}
err = rows.Err()
return
}
func (s *sqliteStorage) RemoveHelpPage(helpPageId int64) (executablePath string, err error) {
err = withTransaction(s.db, func(tx *sql.Tx) (err error) {
err = removeHelpPage(tx, helpPageId)
if err != nil {
return
}
return
})
return
}
func (s *sqliteStorage) GetCommandPolicy(args []string) (policy Policy, err error) {
checkSum := util.HashStrings(args)
err = s.db.QueryRow(`select Policy from HelpPage where CommandArgsCheckSum = ?`, checkSum).Scan(&policy)
if err == sql.ErrNoRows {
err = nil
policy = PolicyUnknown
} else if err != nil {
return
}
return
}
func (s *sqliteStorage) GetAllCompletions() (pages []HelpPage, err error) {
rows, err := s.db.Query(`
select HelpPage.ExecutablePath, Completion.Flag
from Completion
inner join HelpPage on (HelpPage.HelpPageId = Completion.HelpPageId)
`)
if err != nil {
return
}
helpPageMap := make(map[string]*HelpPage)
for rows.Next() {
var executablePath, flag string
err = rows.Scan(&executablePath, &flag)
if err != nil {
return
}
helpPage, ok := helpPageMap[executablePath]
if !ok {
helpPage = &HelpPage{
ExecutablePath: executablePath,
}
helpPageMap[executablePath] = helpPage
}
helpPage.Completions = append(
helpPage.Completions,
Completion{
Flag: flag,
},
)
}
err = rows.Err()
if err != nil {
return
}
for _, p := range helpPageMap {
pages = append(pages, *p)
}
return
}
func (s *sqliteStorage) Close() error {
return s.db.Close()
}
type sqliteStorage struct {
db *sql.DB
}
func insertCompletions(tx *sql.Tx, helpPageId int64, completions []Completion) (err error) {
completionStatement, err := tx.Prepare(`
insert into Completion(HelpPageId, Flag, Context) values (?, ?, ?)
`)
if err != nil {
return
}
for _, completion := range completions {
var contextBytes []byte
contextBytes, err = json.Marshal(completion.Context)
if err != nil {
return
}
_, err = completionStatement.Exec(helpPageId, completion.Flag, contextBytes)
if err != nil {
return
}
}
return
}
func commandToJson(command Command) (s string, err error) {
helpPageCommandJsonBytes, err := json.Marshal(command)
if err != nil {
return
}
s = string(helpPageCommandJsonBytes)
return
}
func removeAndMergeConflicting(tx *sql.Tx, executablePath string, commandCheckSum string, helpPage *HelpPage) (rowIdToReuse *int64, err error) {
var helpPageId int64
var oldCommandJson string
err = tx.QueryRow(`
select HelpPageId, CommandJson from HelpPage where ExecutablePath = ? and HelpTextCheckSum = ?
`, executablePath, helpPage.CheckSum,
).Scan(&helpPageId, &oldCommandJson)
if err == nil {
var curCommandJson string
curCommandJson, err = commandToJson(helpPage.Command)
if err != nil {
return
}
var oldCommand Command
err = json.Unmarshal([]byte(oldCommandJson), &oldCommand)
if err != nil {
return
}
if len(curCommandJson) > len(oldCommandJson) {
helpPage.Command = oldCommand
}
var tmp = helpPageId
rowIdToReuse = &tmp
err = removeHelpPage(tx, helpPageId)
if err != nil {
return
}
} else if err == sql.ErrNoRows {
err = nil
} else {
return
}
err = tx.QueryRow(`
select HelpPageId from HelpPage where ExecutablePath = ? and CommandArgsCheckSum = ?
`, executablePath, commandCheckSum,
).Scan(&helpPageId)
if err == nil {
if rowIdToReuse == nil || *rowIdToReuse > helpPageId {
var tmp = helpPageId
rowIdToReuse = &tmp
}
err = removeHelpPage(tx, helpPageId)
if err != nil {
return
}
} else if err == sql.ErrNoRows {
err = nil
} else {
return
}
return
}
func insertHelpPage(tx *sql.Tx, executablePath string, rowIdToReplace *int64, commandChecksum string, helpPage *HelpPage, policy Policy) (err error) {
helpPageCommandJson, err := commandToJson(helpPage.Command)
if err != nil {
return
}
res, err := tx.Exec(`
insert into HelpPage(
HelpPageId,
ExecutablePath,
HelpTextCheckSum,
CommandArgsCheckSum,
CommandJson,
Policy
) values (?, ?, ?, ?, ?, ?)
`, rowIdToReplace,
executablePath,
helpPage.CheckSum,
commandChecksum,
helpPageCommandJson,
policy)
if err != nil {
return
}
var helpPageId int64
helpPageId, err = res.LastInsertId()
if err != nil {
return
}
err = insertCompletions(tx, helpPageId, helpPage.Completions)
if err != nil {
return
}
return
}
func removeHelpPage(tx *sql.Tx, helpPageId int64) (err error) {
_, err = tx.Exec("delete from Completion where HelpPageId = ?", helpPageId)
if err != nil {
return
}
_, err = tx.Exec("delete from HelpPage where HelpPageId = ?", helpPageId)
if err != nil {
return
}
return
}
func updateSchema(db *sql.DB) (err error) {
userVersion := -1
err = db.QueryRow("PRAGMA user_version;").Scan(&userVersion)
if err != nil {
return
}
if userVersion != 0 {
err = migrateSchema(userVersion, db)
return
}
_, err = db.Exec(`
begin;
create table Completion (
CompletionId integer not null primary key autoincrement,
HelpPageId integer not null,
Flag text not null,
Context text,
foreign key (HelpPageId) references HelpPage(HelpPageId)
);
create index Completion_SourceId ON Completion (HelpPageId);
create table HelpPage (
HelpPageId integer not null primary key autoincrement,
ExecutablePath text,
HelpTextCheckSum text,
CommandArgsCheckSum text,
CommandJson text,
Policy text,
unique (ExecutablePath, HelpTextCheckSum),
unique (ExecutablePath, CommandArgsCheckSum)
);
create index HelpPage_ExecutablePath ON HelpPage (ExecutablePath);
create index HelpPage_ExecutablePath_HelpTextCheckSum ON HelpPage (ExecutablePath, HelpTextCheckSum);
create index HelpPage_ExecutablePath_CommandArgsCheckSum ON HelpPage (ExecutablePath, CommandArgsCheckSum);
PRAGMA user_version = 1;
commit;
`, userVersion)
return
}
func migrateSchema(userVersion int, _ *sql.DB) (err error) {
switch userVersion {
case CurrentSchemaVersion:
break
default:
panic(fmt.Errorf("unknown db version: %v", userVersion))
}
return
}