aboutsummaryrefslogtreecommitdiff
path: root/dbstore/dbstore.go
blob: f432054e2594e99d21855ca9e3657ae0bcebbb27 (plain)
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
// database storage
package dbstore

import (
  "context"
  db_sql "database/sql"
  "embed"
  "fmt"
  _ "github.com/mattn/go-sqlite3"
  "github.com/pablotron/cvez/cpedict"
  "github.com/pablotron/cvez/cpematch"
)

//go:embed sql
var sqlFs embed.FS

// sqlite3 backing store
type DbStore struct {
  db *db_sql.DB
}

// Open database.
//
// This function is called by Open().  It is a separate package-private
// function to make Open() easier to test.
func openFull(dbType, path string) (DbStore, error) {
  var r DbStore

  // init db
  if db, err := db_sql.Open(dbType, path); err != nil {
    return r, err
  } else {
    // save handle
    r.db = db
    return r, nil
  }
}

// Open database
func Open(path string) (DbStore, error) {
  return openFull("sqlite3", path)
}

// initialized database version
const initDbVersion = 314159

func (me DbStore) isInitialized(ctx context.Context) (bool, error) {
  sql := "PRAGMA user_version;"
  // get version
  var version int32
  if err := me.db.QueryRowContext(ctx, sql).Scan(&version); err != nil {
    return false, err
  }

  // return result
  return (version == initDbVersion), nil
}

// initialize database
func (me DbStore) Init(ctx context.Context) error {
  if inited, err := me.isInitialized(ctx); err != nil {
    return err
  } else if inited {
    // already initialized, return success
    return nil
  }

  // read init query
  sql, err := sqlFs.ReadFile("sql/init.sql")
  if err != nil {
    return err
  }

  // exec init query, return result
  _, err = me.db.ExecContext(ctx, string(sql))
  return err
}

// get single query from embedded filesystem
func getQuery(id string) (string, error) {
  // read query
  if data, err := sqlFs.ReadFile(fmt.Sprintf("sql/%s.sql", id)); err != nil {
    return "", err
  } else {
    // return query
    return string(data), nil
  }
}

// return query map
func getQueries(ids []string) (map[string]string, error) {
  r := make(map[string]string)

  for _, id := range(ids) {
    // read query
    if sql, err := getQuery(id); err != nil {
      return r, fmt.Errorf("%s: %s", id, err.Error())
    } else {
      // save query
      r[id] = sql
    }
  }

  // return success
  return r, nil
}

var addCpeDictionaryQueryIds = []string {
  "cpe/insert",
  "cpe/insert-title",
  "cpe/insert-ref",
}

// import CPE dictionary
func (me DbStore) AddCpeDictionary(ctx context.Context, dict cpedict.Dictionary) error {
  // lazy-init db
  if err := me.Init(ctx); err != nil {
    return err
  }

  // build query map
  queries, err := getQueries(addCpeDictionaryQueryIds)
  if err != nil {
    return err
  }

  // begin context
  tx, err := me.db.BeginTx(ctx, nil)
  if err != nil {
    return err
  }

  // build statements
  sts := make(map[string]*db_sql.Stmt)
  for id, sql := range(queries) {
    if st, err := tx.PrepareContext(ctx, sql); err != nil {
      return err
    } else {
      sts[id] = st
      defer sts[id].Close()
    }
  }

  // add items
  for _, item := range(dict.Items) {
    // add cpe
    rs, err := sts["cpe/insert"].ExecContext(ctx, item.CpeUri, item.Cpe23Item.Name)
    if err != nil {
      return err
    }

    // get last row ID
    id, err := rs.LastInsertId()
    if err != nil {
      return err
    }

    // add titles
    for _, title := range(item.Titles) {
      _, err := sts["cpe/insert-title"].ExecContext(ctx, id, title.Lang, title.Text)
      if err != nil {
        return err
      }
    }

    // add refs
    for _, ref := range(item.References) {
      _, err := sts["cpe/insert-ref"].ExecContext(ctx, id, ref.Href, ref.Text)
      if err != nil {
        return err
      }
    }
  }

  // commit changes, return result
  return tx.Commit()
}

// search CPEs
func (me DbStore) CpeSearch(
  ctx context.Context,
  searchType CpeSearchType,
  s string,
) ([]CpeSearchRow, error) {
  var r []CpeSearchRow

  // lazy-init db
  if err := me.Init(ctx); err != nil {
    return r, err
  }

  // get query
  sql, err := getQuery(searchType.String())
  if err != nil {
    return r, err
  }

  // exec search query
  rows, err := me.db.QueryContext(ctx, sql, db_sql.Named("q", s))
  if err != nil {
    return r, err
  }

  // walk results
  for rows.Next() {
    if sr, err := unmarshalCpeSearchRow(rows); err != nil {
      // return error
      return r, err
    } else {
      // append to results
      r = append(r, sr)
    }
  }

  // close rows
  // FIXME: is this correct? i am following the example from the
  // database/sql documentation, but it is messy and it seems
  // counterintuitive to close the row set and then do an additional
  // test for iteration errors...
  if err = rows.Close(); err != nil {
    return r, err
  }

  // check for iteration errors
  if err = rows.Err(); err != nil {
    return r, err
  }

  // return success
  return r, nil
}