message_cache.go 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752
  1. package server
  2. import (
  3. "database/sql"
  4. "encoding/json"
  5. "errors"
  6. "fmt"
  7. "net/netip"
  8. "strings"
  9. "time"
  10. _ "github.com/mattn/go-sqlite3" // SQLite driver
  11. "heckel.io/ntfy/log"
  12. "heckel.io/ntfy/util"
  13. )
  14. var (
  15. errUnexpectedMessageType = errors.New("unexpected message type")
  16. )
  17. // Messages cache
  18. const (
  19. createMessagesTableQuery = `
  20. BEGIN;
  21. CREATE TABLE IF NOT EXISTS messages (
  22. id INTEGER PRIMARY KEY AUTOINCREMENT,
  23. mid TEXT NOT NULL,
  24. time INT NOT NULL,
  25. topic TEXT NOT NULL,
  26. message TEXT NOT NULL,
  27. title TEXT NOT NULL,
  28. priority INT NOT NULL,
  29. tags TEXT NOT NULL,
  30. click TEXT NOT NULL,
  31. icon TEXT NOT NULL,
  32. actions TEXT NOT NULL,
  33. attachment_name TEXT NOT NULL,
  34. attachment_type TEXT NOT NULL,
  35. attachment_size INT NOT NULL,
  36. attachment_expires INT NOT NULL,
  37. attachment_url TEXT NOT NULL,
  38. sender TEXT NOT NULL,
  39. user TEXT NOT NULL,
  40. encoding TEXT NOT NULL,
  41. published INT NOT NULL
  42. );
  43. CREATE INDEX IF NOT EXISTS idx_mid ON messages (mid);
  44. CREATE INDEX IF NOT EXISTS idx_time ON messages (time);
  45. CREATE INDEX IF NOT EXISTS idx_topic ON messages (topic);
  46. COMMIT;
  47. `
  48. insertMessageQuery = `
  49. INSERT INTO messages (mid, time, topic, message, title, priority, tags, click, icon, actions, attachment_name, attachment_type, attachment_size, attachment_expires, attachment_url, sender, user, encoding, published)
  50. VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
  51. `
  52. pruneMessagesQuery = `DELETE FROM messages WHERE time < ? AND published = 1`
  53. selectRowIDFromMessageID = `SELECT id FROM messages WHERE mid = ?` // Do not include topic, see #336 and TestServer_PollSinceID_MultipleTopics
  54. selectMessagesSinceTimeQuery = `
  55. SELECT mid, time, topic, message, title, priority, tags, click, icon, actions, attachment_name, attachment_type, attachment_size, attachment_expires, attachment_url, sender, user, encoding
  56. FROM messages
  57. WHERE topic = ? AND time >= ? AND published = 1
  58. ORDER BY time, id
  59. `
  60. selectMessagesSinceTimeIncludeScheduledQuery = `
  61. SELECT mid, time, topic, message, title, priority, tags, click, icon, actions, attachment_name, attachment_type, attachment_size, attachment_expires, attachment_url, sender, user, encoding
  62. FROM messages
  63. WHERE topic = ? AND time >= ?
  64. ORDER BY time, id
  65. `
  66. selectMessagesSinceIDQuery = `
  67. SELECT mid, time, topic, message, title, priority, tags, click, icon, actions, attachment_name, attachment_type, attachment_size, attachment_expires, attachment_url, sender, user, encoding
  68. FROM messages
  69. WHERE topic = ? AND id > ? AND published = 1
  70. ORDER BY time, id
  71. `
  72. selectMessagesSinceIDIncludeScheduledQuery = `
  73. SELECT mid, time, topic, message, title, priority, tags, click, icon, actions, attachment_name, attachment_type, attachment_size, attachment_expires, attachment_url, sender, user, encoding
  74. FROM messages
  75. WHERE topic = ? AND (id > ? OR published = 0)
  76. ORDER BY time, id
  77. `
  78. selectMessagesDueQuery = `
  79. SELECT mid, time, topic, message, title, priority, tags, click, icon, actions, attachment_name, attachment_type, attachment_size, attachment_expires, attachment_url, sender, user, encoding
  80. FROM messages
  81. WHERE time <= ? AND published = 0
  82. ORDER BY time, id
  83. `
  84. updateMessagePublishedQuery = `UPDATE messages SET published = 1 WHERE mid = ?`
  85. selectMessagesCountQuery = `SELECT COUNT(*) FROM messages`
  86. selectMessageCountPerTopicQuery = `SELECT topic, COUNT(*) FROM messages GROUP BY topic`
  87. selectTopicsQuery = `SELECT topic FROM messages GROUP BY topic`
  88. selectAttachmentsSizeBySenderQuery = `SELECT IFNULL(SUM(attachment_size), 0) FROM messages WHERE sender = ? AND attachment_expires >= ?`
  89. selectAttachmentsSizeByUserQuery = `SELECT IFNULL(SUM(attachment_size), 0) FROM messages WHERE user = ? AND attachment_expires >= ?`
  90. )
  91. // Schema management queries
  92. const (
  93. currentSchemaVersion = 10
  94. createSchemaVersionTableQuery = `
  95. CREATE TABLE IF NOT EXISTS schemaVersion (
  96. id INT PRIMARY KEY,
  97. version INT NOT NULL
  98. );
  99. `
  100. insertSchemaVersion = `INSERT INTO schemaVersion VALUES (1, ?)`
  101. updateSchemaVersion = `UPDATE schemaVersion SET version = ? WHERE id = 1`
  102. selectSchemaVersionQuery = `SELECT version FROM schemaVersion WHERE id = 1`
  103. // 0 -> 1
  104. migrate0To1AlterMessagesTableQuery = `
  105. BEGIN;
  106. ALTER TABLE messages ADD COLUMN title TEXT NOT NULL DEFAULT('');
  107. ALTER TABLE messages ADD COLUMN priority INT NOT NULL DEFAULT(0);
  108. ALTER TABLE messages ADD COLUMN tags TEXT NOT NULL DEFAULT('');
  109. COMMIT;
  110. `
  111. // 1 -> 2
  112. migrate1To2AlterMessagesTableQuery = `
  113. ALTER TABLE messages ADD COLUMN published INT NOT NULL DEFAULT(1);
  114. `
  115. // 2 -> 3
  116. migrate2To3AlterMessagesTableQuery = `
  117. BEGIN;
  118. ALTER TABLE messages ADD COLUMN click TEXT NOT NULL DEFAULT('');
  119. ALTER TABLE messages ADD COLUMN attachment_name TEXT NOT NULL DEFAULT('');
  120. ALTER TABLE messages ADD COLUMN attachment_type TEXT NOT NULL DEFAULT('');
  121. ALTER TABLE messages ADD COLUMN attachment_size INT NOT NULL DEFAULT('0');
  122. ALTER TABLE messages ADD COLUMN attachment_expires INT NOT NULL DEFAULT('0');
  123. ALTER TABLE messages ADD COLUMN attachment_owner TEXT NOT NULL DEFAULT('');
  124. ALTER TABLE messages ADD COLUMN attachment_url TEXT NOT NULL DEFAULT('');
  125. COMMIT;
  126. `
  127. // 3 -> 4
  128. migrate3To4AlterMessagesTableQuery = `
  129. ALTER TABLE messages ADD COLUMN encoding TEXT NOT NULL DEFAULT('');
  130. `
  131. // 4 -> 5
  132. migrate4To5AlterMessagesTableQuery = `
  133. BEGIN;
  134. CREATE TABLE IF NOT EXISTS messages_new (
  135. id INTEGER PRIMARY KEY AUTOINCREMENT,
  136. mid TEXT NOT NULL,
  137. time INT NOT NULL,
  138. topic TEXT NOT NULL,
  139. message TEXT NOT NULL,
  140. title TEXT NOT NULL,
  141. priority INT NOT NULL,
  142. tags TEXT NOT NULL,
  143. click TEXT NOT NULL,
  144. attachment_name TEXT NOT NULL,
  145. attachment_type TEXT NOT NULL,
  146. attachment_size INT NOT NULL,
  147. attachment_expires INT NOT NULL,
  148. attachment_url TEXT NOT NULL,
  149. attachment_owner TEXT NOT NULL,
  150. encoding TEXT NOT NULL,
  151. published INT NOT NULL
  152. );
  153. CREATE INDEX IF NOT EXISTS idx_mid ON messages_new (mid);
  154. CREATE INDEX IF NOT EXISTS idx_topic ON messages_new (topic);
  155. INSERT
  156. INTO messages_new (
  157. mid, time, topic, message, title, priority, tags, click, attachment_name, attachment_type,
  158. attachment_size, attachment_expires, attachment_url, attachment_owner, encoding, published)
  159. SELECT
  160. id, time, topic, message, title, priority, tags, click, attachment_name, attachment_type,
  161. attachment_size, attachment_expires, attachment_url, attachment_owner, encoding, published
  162. FROM messages;
  163. DROP TABLE messages;
  164. ALTER TABLE messages_new RENAME TO messages;
  165. COMMIT;
  166. `
  167. // 5 -> 6
  168. migrate5To6AlterMessagesTableQuery = `
  169. ALTER TABLE messages ADD COLUMN actions TEXT NOT NULL DEFAULT('');
  170. `
  171. // 6 -> 7
  172. migrate6To7AlterMessagesTableQuery = `
  173. ALTER TABLE messages RENAME COLUMN attachment_owner TO sender;
  174. `
  175. // 7 -> 8
  176. migrate7To8AlterMessagesTableQuery = `
  177. ALTER TABLE messages ADD COLUMN icon TEXT NOT NULL DEFAULT('');
  178. `
  179. // 8 -> 9
  180. migrate8To9AlterMessagesTableQuery = `
  181. CREATE INDEX IF NOT EXISTS idx_time ON messages (time);
  182. `
  183. // 9 -> 10
  184. migrate9To10AlterMessagesTableQuery = `
  185. ALTER TABLE messages ADD COLUMN user TEXT NOT NULL DEFAULT('');
  186. `
  187. )
  188. type messageCache struct {
  189. db *sql.DB
  190. queue *util.BatchingQueue[*message]
  191. nop bool
  192. }
  193. // newSqliteCache creates a SQLite file-backed cache
  194. func newSqliteCache(filename, startupQueries string, batchSize int, batchTimeout time.Duration, nop bool) (*messageCache, error) {
  195. db, err := sql.Open("sqlite3", filename)
  196. if err != nil {
  197. return nil, err
  198. }
  199. if err := setupCacheDB(db, startupQueries); err != nil {
  200. return nil, err
  201. }
  202. var queue *util.BatchingQueue[*message]
  203. if batchSize > 0 || batchTimeout > 0 {
  204. queue = util.NewBatchingQueue[*message](batchSize, batchTimeout)
  205. }
  206. cache := &messageCache{
  207. db: db,
  208. queue: queue,
  209. nop: nop,
  210. }
  211. go cache.processMessageBatches()
  212. return cache, nil
  213. }
  214. // newMemCache creates an in-memory cache
  215. func newMemCache() (*messageCache, error) {
  216. return newSqliteCache(createMemoryFilename(), "", 0, 0, false)
  217. }
  218. // newNopCache creates an in-memory cache that discards all messages;
  219. // it is always empty and can be used if caching is entirely disabled
  220. func newNopCache() (*messageCache, error) {
  221. return newSqliteCache(createMemoryFilename(), "", 0, 0, true)
  222. }
  223. // createMemoryFilename creates a unique memory filename to use for the SQLite backend.
  224. // From mattn/go-sqlite3: "Each connection to ":memory:" opens a brand new in-memory
  225. // sql database, so if the stdlib's sql engine happens to open another connection and
  226. // you've only specified ":memory:", that connection will see a brand new database.
  227. // A workaround is to use "file::memory:?cache=shared" (or "file:foobar?mode=memory&cache=shared").
  228. // Every connection to this string will point to the same in-memory database."
  229. func createMemoryFilename() string {
  230. return fmt.Sprintf("file:%s?mode=memory&cache=shared", util.RandomString(10))
  231. }
  232. // AddMessage stores a message to the message cache synchronously, or queues it to be stored at a later date asyncronously.
  233. // The message is queued only if "batchSize" or "batchTimeout" are passed to the constructor.
  234. func (c *messageCache) AddMessage(m *message) error {
  235. if c.queue != nil {
  236. c.queue.Enqueue(m)
  237. return nil
  238. }
  239. return c.addMessages([]*message{m})
  240. }
  241. // addMessages synchronously stores a match of messages. If the database is locked, the transaction waits until
  242. // SQLite's busy_timeout is exceeded before erroring out.
  243. func (c *messageCache) addMessages(ms []*message) error {
  244. if c.nop {
  245. return nil
  246. }
  247. if len(ms) == 0 {
  248. return nil
  249. }
  250. start := time.Now()
  251. tx, err := c.db.Begin()
  252. if err != nil {
  253. return err
  254. }
  255. defer tx.Rollback()
  256. stmt, err := tx.Prepare(insertMessageQuery)
  257. if err != nil {
  258. return err
  259. }
  260. defer stmt.Close()
  261. for _, m := range ms {
  262. if m.Event != messageEvent {
  263. return errUnexpectedMessageType
  264. }
  265. published := m.Time <= time.Now().Unix()
  266. tags := strings.Join(m.Tags, ",")
  267. var attachmentName, attachmentType, attachmentURL string
  268. var attachmentSize, attachmentExpires int64
  269. if m.Attachment != nil {
  270. attachmentName = m.Attachment.Name
  271. attachmentType = m.Attachment.Type
  272. attachmentSize = m.Attachment.Size
  273. attachmentExpires = m.Attachment.Expires
  274. attachmentURL = m.Attachment.URL
  275. }
  276. var actionsStr string
  277. if len(m.Actions) > 0 {
  278. actionsBytes, err := json.Marshal(m.Actions)
  279. if err != nil {
  280. return err
  281. }
  282. actionsStr = string(actionsBytes)
  283. }
  284. var sender string
  285. if m.Sender.IsValid() {
  286. sender = m.Sender.String()
  287. }
  288. _, err := stmt.Exec(
  289. m.ID,
  290. m.Time,
  291. m.Topic,
  292. m.Message,
  293. m.Title,
  294. m.Priority,
  295. tags,
  296. m.Click,
  297. m.Icon,
  298. actionsStr,
  299. attachmentName,
  300. attachmentType,
  301. attachmentSize,
  302. attachmentExpires,
  303. attachmentURL,
  304. sender,
  305. m.User,
  306. m.Encoding,
  307. published,
  308. )
  309. if err != nil {
  310. return err
  311. }
  312. }
  313. if err := tx.Commit(); err != nil {
  314. log.Error("Cache: Writing %d message(s) failed (took %v)", len(ms), time.Since(start))
  315. return err
  316. }
  317. log.Debug("Cache: Wrote %d message(s) in %v", len(ms), time.Since(start))
  318. return nil
  319. }
  320. func (c *messageCache) Messages(topic string, since sinceMarker, scheduled bool) ([]*message, error) {
  321. if since.IsNone() {
  322. return make([]*message, 0), nil
  323. } else if since.IsID() {
  324. return c.messagesSinceID(topic, since, scheduled)
  325. }
  326. return c.messagesSinceTime(topic, since, scheduled)
  327. }
  328. func (c *messageCache) messagesSinceTime(topic string, since sinceMarker, scheduled bool) ([]*message, error) {
  329. var rows *sql.Rows
  330. var err error
  331. if scheduled {
  332. rows, err = c.db.Query(selectMessagesSinceTimeIncludeScheduledQuery, topic, since.Time().Unix())
  333. } else {
  334. rows, err = c.db.Query(selectMessagesSinceTimeQuery, topic, since.Time().Unix())
  335. }
  336. if err != nil {
  337. return nil, err
  338. }
  339. return readMessages(rows)
  340. }
  341. func (c *messageCache) messagesSinceID(topic string, since sinceMarker, scheduled bool) ([]*message, error) {
  342. idrows, err := c.db.Query(selectRowIDFromMessageID, since.ID())
  343. if err != nil {
  344. return nil, err
  345. }
  346. defer idrows.Close()
  347. if !idrows.Next() {
  348. return c.messagesSinceTime(topic, sinceAllMessages, scheduled)
  349. }
  350. var rowID int64
  351. if err := idrows.Scan(&rowID); err != nil {
  352. return nil, err
  353. }
  354. idrows.Close()
  355. var rows *sql.Rows
  356. if scheduled {
  357. rows, err = c.db.Query(selectMessagesSinceIDIncludeScheduledQuery, topic, rowID)
  358. } else {
  359. rows, err = c.db.Query(selectMessagesSinceIDQuery, topic, rowID)
  360. }
  361. if err != nil {
  362. return nil, err
  363. }
  364. return readMessages(rows)
  365. }
  366. func (c *messageCache) MessagesDue() ([]*message, error) {
  367. rows, err := c.db.Query(selectMessagesDueQuery, time.Now().Unix())
  368. if err != nil {
  369. return nil, err
  370. }
  371. return readMessages(rows)
  372. }
  373. func (c *messageCache) MarkPublished(m *message) error {
  374. _, err := c.db.Exec(updateMessagePublishedQuery, m.ID)
  375. return err
  376. }
  377. func (c *messageCache) MessageCounts() (map[string]int, error) {
  378. rows, err := c.db.Query(selectMessageCountPerTopicQuery)
  379. if err != nil {
  380. return nil, err
  381. }
  382. defer rows.Close()
  383. var topic string
  384. var count int
  385. counts := make(map[string]int)
  386. for rows.Next() {
  387. if err := rows.Scan(&topic, &count); err != nil {
  388. return nil, err
  389. } else if err := rows.Err(); err != nil {
  390. return nil, err
  391. }
  392. counts[topic] = count
  393. }
  394. return counts, nil
  395. }
  396. func (c *messageCache) Topics() (map[string]*topic, error) {
  397. rows, err := c.db.Query(selectTopicsQuery)
  398. if err != nil {
  399. return nil, err
  400. }
  401. defer rows.Close()
  402. topics := make(map[string]*topic)
  403. for rows.Next() {
  404. var id string
  405. if err := rows.Scan(&id); err != nil {
  406. return nil, err
  407. }
  408. topics[id] = newTopic(id)
  409. }
  410. if err := rows.Err(); err != nil {
  411. return nil, err
  412. }
  413. return topics, nil
  414. }
  415. func (c *messageCache) Prune(olderThan time.Time) error {
  416. start := time.Now()
  417. if _, err := c.db.Exec(pruneMessagesQuery, olderThan.Unix()); err != nil {
  418. log.Warn("Cache: Pruning failed (after %v): %s", time.Since(start), err.Error())
  419. }
  420. log.Debug("Cache: Pruning successful (took %v)", time.Since(start))
  421. return nil
  422. }
  423. func (c *messageCache) AttachmentBytesUsedBySender(sender string) (int64, error) {
  424. rows, err := c.db.Query(selectAttachmentsSizeBySenderQuery, sender, time.Now().Unix())
  425. if err != nil {
  426. return 0, err
  427. }
  428. return c.readAttachmentBytesUsed(rows)
  429. }
  430. func (c *messageCache) AttachmentBytesUsedByUser(user string) (int64, error) {
  431. rows, err := c.db.Query(selectAttachmentsSizeByUserQuery, user, time.Now().Unix())
  432. if err != nil {
  433. return 0, err
  434. }
  435. return c.readAttachmentBytesUsed(rows)
  436. }
  437. func (c *messageCache) readAttachmentBytesUsed(rows *sql.Rows) (int64, error) {
  438. defer rows.Close()
  439. var size int64
  440. if !rows.Next() {
  441. return 0, errors.New("no rows found")
  442. }
  443. if err := rows.Scan(&size); err != nil {
  444. return 0, err
  445. } else if err := rows.Err(); err != nil {
  446. return 0, err
  447. }
  448. return size, nil
  449. }
  450. func (c *messageCache) processMessageBatches() {
  451. if c.queue == nil {
  452. return
  453. }
  454. for messages := range c.queue.Dequeue() {
  455. if err := c.addMessages(messages); err != nil {
  456. log.Error("Cache: %s", err.Error())
  457. }
  458. }
  459. }
  460. func readMessages(rows *sql.Rows) ([]*message, error) {
  461. defer rows.Close()
  462. messages := make([]*message, 0)
  463. for rows.Next() {
  464. var timestamp, attachmentSize, attachmentExpires int64
  465. var priority int
  466. var id, topic, msg, title, tagsStr, click, icon, actionsStr, attachmentName, attachmentType, attachmentURL, sender, user, encoding string
  467. err := rows.Scan(
  468. &id,
  469. &timestamp,
  470. &topic,
  471. &msg,
  472. &title,
  473. &priority,
  474. &tagsStr,
  475. &click,
  476. &icon,
  477. &actionsStr,
  478. &attachmentName,
  479. &attachmentType,
  480. &attachmentSize,
  481. &attachmentExpires,
  482. &attachmentURL,
  483. &sender,
  484. &user,
  485. &encoding,
  486. )
  487. if err != nil {
  488. return nil, err
  489. }
  490. var tags []string
  491. if tagsStr != "" {
  492. tags = strings.Split(tagsStr, ",")
  493. }
  494. var actions []*action
  495. if actionsStr != "" {
  496. if err := json.Unmarshal([]byte(actionsStr), &actions); err != nil {
  497. return nil, err
  498. }
  499. }
  500. senderIP, err := netip.ParseAddr(sender)
  501. if err != nil {
  502. senderIP = netip.Addr{} // if no IP stored in database, return invalid address
  503. }
  504. var att *attachment
  505. if attachmentName != "" && attachmentURL != "" {
  506. att = &attachment{
  507. Name: attachmentName,
  508. Type: attachmentType,
  509. Size: attachmentSize,
  510. Expires: attachmentExpires,
  511. URL: attachmentURL,
  512. }
  513. }
  514. messages = append(messages, &message{
  515. ID: id,
  516. Time: timestamp,
  517. Event: messageEvent,
  518. Topic: topic,
  519. Message: msg,
  520. Title: title,
  521. Priority: priority,
  522. Tags: tags,
  523. Click: click,
  524. Icon: icon,
  525. Actions: actions,
  526. Attachment: att,
  527. Sender: senderIP, // Must parse assuming database must be correct
  528. User: user,
  529. Encoding: encoding,
  530. })
  531. }
  532. if err := rows.Err(); err != nil {
  533. return nil, err
  534. }
  535. return messages, nil
  536. }
  537. func setupCacheDB(db *sql.DB, startupQueries string) error {
  538. // Run startup queries
  539. if startupQueries != "" {
  540. if _, err := db.Exec(startupQueries); err != nil {
  541. return err
  542. }
  543. }
  544. // If 'messages' table does not exist, this must be a new database
  545. rowsMC, err := db.Query(selectMessagesCountQuery)
  546. if err != nil {
  547. return setupNewCacheDB(db)
  548. }
  549. rowsMC.Close()
  550. // If 'messages' table exists, check 'schemaVersion' table
  551. schemaVersion := 0
  552. rowsSV, err := db.Query(selectSchemaVersionQuery)
  553. if err == nil {
  554. defer rowsSV.Close()
  555. if !rowsSV.Next() {
  556. return errors.New("cannot determine schema version: cache file may be corrupt")
  557. }
  558. if err := rowsSV.Scan(&schemaVersion); err != nil {
  559. return err
  560. }
  561. rowsSV.Close()
  562. }
  563. // Do migrations
  564. if schemaVersion == currentSchemaVersion {
  565. return nil
  566. } else if schemaVersion == 0 {
  567. return migrateFrom0(db)
  568. } else if schemaVersion == 1 {
  569. return migrateFrom1(db)
  570. } else if schemaVersion == 2 {
  571. return migrateFrom2(db)
  572. } else if schemaVersion == 3 {
  573. return migrateFrom3(db)
  574. } else if schemaVersion == 4 {
  575. return migrateFrom4(db)
  576. } else if schemaVersion == 5 {
  577. return migrateFrom5(db)
  578. } else if schemaVersion == 6 {
  579. return migrateFrom6(db)
  580. } else if schemaVersion == 7 {
  581. return migrateFrom7(db)
  582. } else if schemaVersion == 8 {
  583. return migrateFrom8(db)
  584. } else if schemaVersion == 9 {
  585. return migrateFrom9(db)
  586. }
  587. return fmt.Errorf("unexpected schema version found: %d", schemaVersion)
  588. }
  589. func setupNewCacheDB(db *sql.DB) error {
  590. if _, err := db.Exec(createMessagesTableQuery); err != nil {
  591. return err
  592. }
  593. if _, err := db.Exec(createSchemaVersionTableQuery); err != nil {
  594. return err
  595. }
  596. if _, err := db.Exec(insertSchemaVersion, currentSchemaVersion); err != nil {
  597. return err
  598. }
  599. return nil
  600. }
  601. func migrateFrom0(db *sql.DB) error {
  602. log.Info("Migrating cache database schema: from 0 to 1")
  603. if _, err := db.Exec(migrate0To1AlterMessagesTableQuery); err != nil {
  604. return err
  605. }
  606. if _, err := db.Exec(createSchemaVersionTableQuery); err != nil {
  607. return err
  608. }
  609. if _, err := db.Exec(insertSchemaVersion, 1); err != nil {
  610. return err
  611. }
  612. return migrateFrom1(db)
  613. }
  614. func migrateFrom1(db *sql.DB) error {
  615. log.Info("Migrating cache database schema: from 1 to 2")
  616. if _, err := db.Exec(migrate1To2AlterMessagesTableQuery); err != nil {
  617. return err
  618. }
  619. if _, err := db.Exec(updateSchemaVersion, 2); err != nil {
  620. return err
  621. }
  622. return migrateFrom2(db)
  623. }
  624. func migrateFrom2(db *sql.DB) error {
  625. log.Info("Migrating cache database schema: from 2 to 3")
  626. if _, err := db.Exec(migrate2To3AlterMessagesTableQuery); err != nil {
  627. return err
  628. }
  629. if _, err := db.Exec(updateSchemaVersion, 3); err != nil {
  630. return err
  631. }
  632. return migrateFrom3(db)
  633. }
  634. func migrateFrom3(db *sql.DB) error {
  635. log.Info("Migrating cache database schema: from 3 to 4")
  636. if _, err := db.Exec(migrate3To4AlterMessagesTableQuery); err != nil {
  637. return err
  638. }
  639. if _, err := db.Exec(updateSchemaVersion, 4); err != nil {
  640. return err
  641. }
  642. return migrateFrom4(db)
  643. }
  644. func migrateFrom4(db *sql.DB) error {
  645. log.Info("Migrating cache database schema: from 4 to 5")
  646. if _, err := db.Exec(migrate4To5AlterMessagesTableQuery); err != nil {
  647. return err
  648. }
  649. if _, err := db.Exec(updateSchemaVersion, 5); err != nil {
  650. return err
  651. }
  652. return migrateFrom5(db)
  653. }
  654. func migrateFrom5(db *sql.DB) error {
  655. log.Info("Migrating cache database schema: from 5 to 6")
  656. if _, err := db.Exec(migrate5To6AlterMessagesTableQuery); err != nil {
  657. return err
  658. }
  659. if _, err := db.Exec(updateSchemaVersion, 6); err != nil {
  660. return err
  661. }
  662. return migrateFrom6(db)
  663. }
  664. func migrateFrom6(db *sql.DB) error {
  665. log.Info("Migrating cache database schema: from 6 to 7")
  666. if _, err := db.Exec(migrate6To7AlterMessagesTableQuery); err != nil {
  667. return err
  668. }
  669. if _, err := db.Exec(updateSchemaVersion, 7); err != nil {
  670. return err
  671. }
  672. return migrateFrom7(db)
  673. }
  674. func migrateFrom7(db *sql.DB) error {
  675. log.Info("Migrating cache database schema: from 7 to 8")
  676. if _, err := db.Exec(migrate7To8AlterMessagesTableQuery); err != nil {
  677. return err
  678. }
  679. if _, err := db.Exec(updateSchemaVersion, 8); err != nil {
  680. return err
  681. }
  682. return migrateFrom8(db)
  683. }
  684. func migrateFrom8(db *sql.DB) error {
  685. log.Info("Migrating cache database schema: from 8 to 9")
  686. if _, err := db.Exec(migrate8To9AlterMessagesTableQuery); err != nil {
  687. return err
  688. }
  689. if _, err := db.Exec(updateSchemaVersion, 9); err != nil {
  690. return err
  691. }
  692. return migrateFrom9(db)
  693. }
  694. func migrateFrom9(db *sql.DB) error {
  695. log.Info("Migrating cache database schema: from 9 to 10")
  696. if _, err := db.Exec(migrate9To10AlterMessagesTableQuery); err != nil {
  697. return err
  698. }
  699. if _, err := db.Exec(updateSchemaVersion, 10); err != nil {
  700. return err
  701. }
  702. return nil // Update this when a new version is added
  703. }