message_cache.go 23 KB

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