message_cache.go 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837
  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. migrate9To10UpdateMessageExpiryQuery = `UPDATE messages SET expires = time + ?`
  204. )
  205. var (
  206. migrations = map[int]func(db *sql.DB, cacheDuration time.Duration) error{
  207. 0: migrateFrom0,
  208. 1: migrateFrom1,
  209. 2: migrateFrom2,
  210. 3: migrateFrom3,
  211. 4: migrateFrom4,
  212. 5: migrateFrom5,
  213. 6: migrateFrom6,
  214. 7: migrateFrom7,
  215. 8: migrateFrom8,
  216. 9: migrateFrom9,
  217. }
  218. )
  219. type messageCache struct {
  220. db *sql.DB
  221. queue *util.BatchingQueue[*message]
  222. nop bool
  223. }
  224. // newSqliteCache creates a SQLite file-backed cache
  225. func newSqliteCache(filename, startupQueries string, cacheDuration time.Duration, batchSize int, batchTimeout time.Duration, nop bool) (*messageCache, error) {
  226. db, err := sql.Open("sqlite3", filename)
  227. if err != nil {
  228. return nil, err
  229. }
  230. if err := setupDB(db, startupQueries, cacheDuration); err != nil {
  231. return nil, err
  232. }
  233. var queue *util.BatchingQueue[*message]
  234. if batchSize > 0 || batchTimeout > 0 {
  235. queue = util.NewBatchingQueue[*message](batchSize, batchTimeout)
  236. }
  237. cache := &messageCache{
  238. db: db,
  239. queue: queue,
  240. nop: nop,
  241. }
  242. go cache.processMessageBatches()
  243. return cache, nil
  244. }
  245. // newMemCache creates an in-memory cache
  246. func newMemCache() (*messageCache, error) {
  247. return newSqliteCache(createMemoryFilename(), "", 0, 0, 0, false)
  248. }
  249. // newNopCache creates an in-memory cache that discards all messages;
  250. // it is always empty and can be used if caching is entirely disabled
  251. func newNopCache() (*messageCache, error) {
  252. return newSqliteCache(createMemoryFilename(), "", 0, 0, 0, true)
  253. }
  254. // createMemoryFilename creates a unique memory filename to use for the SQLite backend.
  255. // From mattn/go-sqlite3: "Each connection to ":memory:" opens a brand new in-memory
  256. // sql database, so if the stdlib's sql engine happens to open another connection and
  257. // you've only specified ":memory:", that connection will see a brand new database.
  258. // A workaround is to use "file::memory:?cache=shared" (or "file:foobar?mode=memory&cache=shared").
  259. // Every connection to this string will point to the same in-memory database."
  260. func createMemoryFilename() string {
  261. return fmt.Sprintf("file:%s?mode=memory&cache=shared", util.RandomString(10))
  262. }
  263. // AddMessage stores a message to the message cache synchronously, or queues it to be stored at a later date asyncronously.
  264. // The message is queued only if "batchSize" or "batchTimeout" are passed to the constructor.
  265. func (c *messageCache) AddMessage(m *message) error {
  266. if c.queue != nil {
  267. c.queue.Enqueue(m)
  268. return nil
  269. }
  270. return c.addMessages([]*message{m})
  271. }
  272. // addMessages synchronously stores a match of messages. If the database is locked, the transaction waits until
  273. // SQLite's busy_timeout is exceeded before erroring out.
  274. func (c *messageCache) addMessages(ms []*message) error {
  275. if c.nop {
  276. return nil
  277. }
  278. if len(ms) == 0 {
  279. return nil
  280. }
  281. start := time.Now()
  282. tx, err := c.db.Begin()
  283. if err != nil {
  284. return err
  285. }
  286. defer tx.Rollback()
  287. stmt, err := tx.Prepare(insertMessageQuery)
  288. if err != nil {
  289. return err
  290. }
  291. defer stmt.Close()
  292. for _, m := range ms {
  293. if m.Event != messageEvent {
  294. return errUnexpectedMessageType
  295. }
  296. published := m.Time <= time.Now().Unix()
  297. tags := strings.Join(m.Tags, ",")
  298. var attachmentName, attachmentType, attachmentURL string
  299. var attachmentSize, attachmentExpires, attachmentDeleted int64
  300. if m.Attachment != nil {
  301. attachmentName = m.Attachment.Name
  302. attachmentType = m.Attachment.Type
  303. attachmentSize = m.Attachment.Size
  304. attachmentExpires = m.Attachment.Expires
  305. attachmentURL = m.Attachment.URL
  306. }
  307. var actionsStr string
  308. if len(m.Actions) > 0 {
  309. actionsBytes, err := json.Marshal(m.Actions)
  310. if err != nil {
  311. return err
  312. }
  313. actionsStr = string(actionsBytes)
  314. }
  315. var sender string
  316. if m.Sender.IsValid() {
  317. sender = m.Sender.String()
  318. }
  319. _, err := stmt.Exec(
  320. m.ID,
  321. m.Time,
  322. m.Expires,
  323. m.Topic,
  324. m.Message,
  325. m.Title,
  326. m.Priority,
  327. tags,
  328. m.Click,
  329. m.Icon,
  330. actionsStr,
  331. attachmentName,
  332. attachmentType,
  333. attachmentSize,
  334. attachmentExpires,
  335. attachmentURL,
  336. attachmentDeleted, // Always zero
  337. sender,
  338. m.User,
  339. m.Encoding,
  340. published,
  341. )
  342. if err != nil {
  343. return err
  344. }
  345. }
  346. if err := tx.Commit(); err != nil {
  347. log.Error("Message Cache: Writing %d message(s) failed (took %v)", len(ms), time.Since(start))
  348. return err
  349. }
  350. log.Debug("Message Cache: Wrote %d message(s) in %v", len(ms), time.Since(start))
  351. return nil
  352. }
  353. func (c *messageCache) Messages(topic string, since sinceMarker, scheduled bool) ([]*message, error) {
  354. if since.IsNone() {
  355. return make([]*message, 0), nil
  356. } else if since.IsID() {
  357. return c.messagesSinceID(topic, since, scheduled)
  358. }
  359. return c.messagesSinceTime(topic, since, scheduled)
  360. }
  361. func (c *messageCache) messagesSinceTime(topic string, since sinceMarker, scheduled bool) ([]*message, error) {
  362. var rows *sql.Rows
  363. var err error
  364. if scheduled {
  365. rows, err = c.db.Query(selectMessagesSinceTimeIncludeScheduledQuery, topic, since.Time().Unix())
  366. } else {
  367. rows, err = c.db.Query(selectMessagesSinceTimeQuery, topic, since.Time().Unix())
  368. }
  369. if err != nil {
  370. return nil, err
  371. }
  372. return readMessages(rows)
  373. }
  374. func (c *messageCache) messagesSinceID(topic string, since sinceMarker, scheduled bool) ([]*message, error) {
  375. idrows, err := c.db.Query(selectRowIDFromMessageID, since.ID())
  376. if err != nil {
  377. return nil, err
  378. }
  379. defer idrows.Close()
  380. if !idrows.Next() {
  381. return c.messagesSinceTime(topic, sinceAllMessages, scheduled)
  382. }
  383. var rowID int64
  384. if err := idrows.Scan(&rowID); err != nil {
  385. return nil, err
  386. }
  387. idrows.Close()
  388. var rows *sql.Rows
  389. if scheduled {
  390. rows, err = c.db.Query(selectMessagesSinceIDIncludeScheduledQuery, topic, rowID)
  391. } else {
  392. rows, err = c.db.Query(selectMessagesSinceIDQuery, topic, rowID)
  393. }
  394. if err != nil {
  395. return nil, err
  396. }
  397. return readMessages(rows)
  398. }
  399. func (c *messageCache) MessagesDue() ([]*message, error) {
  400. rows, err := c.db.Query(selectMessagesDueQuery, time.Now().Unix())
  401. if err != nil {
  402. return nil, err
  403. }
  404. return readMessages(rows)
  405. }
  406. func (c *messageCache) MessagesExpired() ([]*message, error) {
  407. rows, err := c.db.Query(selectMessagesExpiredQuery, time.Now().Unix())
  408. if err != nil {
  409. return nil, err
  410. }
  411. return readMessages(rows)
  412. }
  413. func (c *messageCache) MarkPublished(m *message) error {
  414. _, err := c.db.Exec(updateMessagePublishedQuery, m.ID)
  415. return err
  416. }
  417. func (c *messageCache) MessageCounts() (map[string]int, error) {
  418. rows, err := c.db.Query(selectMessageCountPerTopicQuery)
  419. if err != nil {
  420. return nil, err
  421. }
  422. defer rows.Close()
  423. var topic string
  424. var count int
  425. counts := make(map[string]int)
  426. for rows.Next() {
  427. if err := rows.Scan(&topic, &count); err != nil {
  428. return nil, err
  429. } else if err := rows.Err(); err != nil {
  430. return nil, err
  431. }
  432. counts[topic] = count
  433. }
  434. return counts, nil
  435. }
  436. func (c *messageCache) Topics() (map[string]*topic, error) {
  437. rows, err := c.db.Query(selectTopicsQuery)
  438. if err != nil {
  439. return nil, err
  440. }
  441. defer rows.Close()
  442. topics := make(map[string]*topic)
  443. for rows.Next() {
  444. var id string
  445. if err := rows.Scan(&id); err != nil {
  446. return nil, err
  447. }
  448. topics[id] = newTopic(id)
  449. }
  450. if err := rows.Err(); err != nil {
  451. return nil, err
  452. }
  453. return topics, nil
  454. }
  455. func (c *messageCache) DeleteMessages(ids ...string) error {
  456. tx, err := c.db.Begin()
  457. if err != nil {
  458. return err
  459. }
  460. defer tx.Rollback()
  461. for _, id := range ids {
  462. if _, err := tx.Exec(deleteMessageQuery, id); err != nil {
  463. return err
  464. }
  465. }
  466. return tx.Commit()
  467. }
  468. func (c *messageCache) AttachmentsExpired() ([]string, error) {
  469. rows, err := c.db.Query(selectAttachmentsExpiredQuery, time.Now().Unix())
  470. if err != nil {
  471. return nil, err
  472. }
  473. defer rows.Close()
  474. ids := make([]string, 0)
  475. for rows.Next() {
  476. var id string
  477. if err := rows.Scan(&id); err != nil {
  478. return nil, err
  479. }
  480. ids = append(ids, id)
  481. }
  482. if err := rows.Err(); err != nil {
  483. return nil, err
  484. }
  485. return ids, nil
  486. }
  487. func (c *messageCache) MarkAttachmentsDeleted(ids ...string) error {
  488. tx, err := c.db.Begin()
  489. if err != nil {
  490. return err
  491. }
  492. defer tx.Rollback()
  493. for _, id := range ids {
  494. if _, err := tx.Exec(updateAttachmentDeleted, id); err != nil {
  495. return err
  496. }
  497. }
  498. return tx.Commit()
  499. }
  500. func (c *messageCache) AttachmentBytesUsedBySender(sender string) (int64, error) {
  501. rows, err := c.db.Query(selectAttachmentsSizeBySenderQuery, sender, time.Now().Unix())
  502. if err != nil {
  503. return 0, err
  504. }
  505. return c.readAttachmentBytesUsed(rows)
  506. }
  507. func (c *messageCache) AttachmentBytesUsedByUser(user string) (int64, error) {
  508. rows, err := c.db.Query(selectAttachmentsSizeByUserQuery, user, time.Now().Unix())
  509. if err != nil {
  510. return 0, err
  511. }
  512. return c.readAttachmentBytesUsed(rows)
  513. }
  514. func (c *messageCache) readAttachmentBytesUsed(rows *sql.Rows) (int64, error) {
  515. defer rows.Close()
  516. var size int64
  517. if !rows.Next() {
  518. return 0, errors.New("no rows found")
  519. }
  520. if err := rows.Scan(&size); err != nil {
  521. return 0, err
  522. } else if err := rows.Err(); err != nil {
  523. return 0, err
  524. }
  525. return size, nil
  526. }
  527. func (c *messageCache) processMessageBatches() {
  528. if c.queue == nil {
  529. return
  530. }
  531. for messages := range c.queue.Dequeue() {
  532. if err := c.addMessages(messages); err != nil {
  533. log.Error("Message Cache: %s", err.Error())
  534. }
  535. }
  536. }
  537. func readMessages(rows *sql.Rows) ([]*message, error) {
  538. defer rows.Close()
  539. messages := make([]*message, 0)
  540. for rows.Next() {
  541. var timestamp, expires, attachmentSize, attachmentExpires int64
  542. var priority int
  543. var id, topic, msg, title, tagsStr, click, icon, actionsStr, attachmentName, attachmentType, attachmentURL, sender, user, encoding string
  544. err := rows.Scan(
  545. &id,
  546. &timestamp,
  547. &expires,
  548. &topic,
  549. &msg,
  550. &title,
  551. &priority,
  552. &tagsStr,
  553. &click,
  554. &icon,
  555. &actionsStr,
  556. &attachmentName,
  557. &attachmentType,
  558. &attachmentSize,
  559. &attachmentExpires,
  560. &attachmentURL,
  561. &sender,
  562. &user,
  563. &encoding,
  564. )
  565. if err != nil {
  566. return nil, err
  567. }
  568. var tags []string
  569. if tagsStr != "" {
  570. tags = strings.Split(tagsStr, ",")
  571. }
  572. var actions []*action
  573. if actionsStr != "" {
  574. if err := json.Unmarshal([]byte(actionsStr), &actions); err != nil {
  575. return nil, err
  576. }
  577. }
  578. senderIP, err := netip.ParseAddr(sender)
  579. if err != nil {
  580. senderIP = netip.Addr{} // if no IP stored in database, return invalid address
  581. }
  582. var att *attachment
  583. if attachmentName != "" && attachmentURL != "" {
  584. att = &attachment{
  585. Name: attachmentName,
  586. Type: attachmentType,
  587. Size: attachmentSize,
  588. Expires: attachmentExpires,
  589. URL: attachmentURL,
  590. }
  591. }
  592. messages = append(messages, &message{
  593. ID: id,
  594. Time: timestamp,
  595. Expires: expires,
  596. Event: messageEvent,
  597. Topic: topic,
  598. Message: msg,
  599. Title: title,
  600. Priority: priority,
  601. Tags: tags,
  602. Click: click,
  603. Icon: icon,
  604. Actions: actions,
  605. Attachment: att,
  606. Sender: senderIP, // Must parse assuming database must be correct
  607. User: user,
  608. Encoding: encoding,
  609. })
  610. }
  611. if err := rows.Err(); err != nil {
  612. return nil, err
  613. }
  614. return messages, nil
  615. }
  616. func setupDB(db *sql.DB, startupQueries string, cacheDuration time.Duration) error {
  617. // Run startup queries
  618. if startupQueries != "" {
  619. if _, err := db.Exec(startupQueries); err != nil {
  620. return err
  621. }
  622. }
  623. // If 'messages' table does not exist, this must be a new database
  624. rowsMC, err := db.Query(selectMessagesCountQuery)
  625. if err != nil {
  626. return setupNewCacheDB(db)
  627. }
  628. rowsMC.Close()
  629. // If 'messages' table exists, check 'schemaVersion' table
  630. schemaVersion := 0
  631. rowsSV, err := db.Query(selectSchemaVersionQuery)
  632. if err == nil {
  633. defer rowsSV.Close()
  634. if !rowsSV.Next() {
  635. return errors.New("cannot determine schema version: cache file may be corrupt")
  636. }
  637. if err := rowsSV.Scan(&schemaVersion); err != nil {
  638. return err
  639. }
  640. rowsSV.Close()
  641. }
  642. // Do migrations
  643. if schemaVersion == currentSchemaVersion {
  644. return nil
  645. } else if schemaVersion > currentSchemaVersion {
  646. return fmt.Errorf("unexpected schema version: version %d is higher than current version %d", schemaVersion, currentSchemaVersion)
  647. }
  648. for i := schemaVersion; i < currentSchemaVersion; i++ {
  649. fn, ok := migrations[i]
  650. if !ok {
  651. return fmt.Errorf("cannot find migration step from schema version %d to %d", i, i+1)
  652. } else if err := fn(db, cacheDuration); err != nil {
  653. return err
  654. }
  655. }
  656. return nil
  657. }
  658. func setupNewCacheDB(db *sql.DB) error {
  659. if _, err := db.Exec(createMessagesTableQuery); err != nil {
  660. return err
  661. }
  662. if _, err := db.Exec(createSchemaVersionTableQuery); err != nil {
  663. return err
  664. }
  665. if _, err := db.Exec(insertSchemaVersion, currentSchemaVersion); err != nil {
  666. return err
  667. }
  668. return nil
  669. }
  670. func migrateFrom0(db *sql.DB, _ time.Duration) error {
  671. log.Info("Migrating cache database schema: from 0 to 1")
  672. if _, err := db.Exec(migrate0To1AlterMessagesTableQuery); err != nil {
  673. return err
  674. }
  675. if _, err := db.Exec(createSchemaVersionTableQuery); err != nil {
  676. return err
  677. }
  678. if _, err := db.Exec(insertSchemaVersion, 1); err != nil {
  679. return err
  680. }
  681. return nil
  682. }
  683. func migrateFrom1(db *sql.DB, _ time.Duration) error {
  684. log.Info("Migrating cache database schema: from 1 to 2")
  685. if _, err := db.Exec(migrate1To2AlterMessagesTableQuery); err != nil {
  686. return err
  687. }
  688. if _, err := db.Exec(updateSchemaVersion, 2); err != nil {
  689. return err
  690. }
  691. return nil
  692. }
  693. func migrateFrom2(db *sql.DB, _ time.Duration) error {
  694. log.Info("Migrating cache database schema: from 2 to 3")
  695. if _, err := db.Exec(migrate2To3AlterMessagesTableQuery); err != nil {
  696. return err
  697. }
  698. if _, err := db.Exec(updateSchemaVersion, 3); err != nil {
  699. return err
  700. }
  701. return nil
  702. }
  703. func migrateFrom3(db *sql.DB, _ time.Duration) error {
  704. log.Info("Migrating cache database schema: from 3 to 4")
  705. if _, err := db.Exec(migrate3To4AlterMessagesTableQuery); err != nil {
  706. return err
  707. }
  708. if _, err := db.Exec(updateSchemaVersion, 4); err != nil {
  709. return err
  710. }
  711. return nil
  712. }
  713. func migrateFrom4(db *sql.DB, _ time.Duration) error {
  714. log.Info("Migrating cache database schema: from 4 to 5")
  715. if _, err := db.Exec(migrate4To5AlterMessagesTableQuery); err != nil {
  716. return err
  717. }
  718. if _, err := db.Exec(updateSchemaVersion, 5); err != nil {
  719. return err
  720. }
  721. return nil
  722. }
  723. func migrateFrom5(db *sql.DB, _ time.Duration) error {
  724. log.Info("Migrating cache database schema: from 5 to 6")
  725. if _, err := db.Exec(migrate5To6AlterMessagesTableQuery); err != nil {
  726. return err
  727. }
  728. if _, err := db.Exec(updateSchemaVersion, 6); err != nil {
  729. return err
  730. }
  731. return nil
  732. }
  733. func migrateFrom6(db *sql.DB, _ time.Duration) error {
  734. log.Info("Migrating cache database schema: from 6 to 7")
  735. if _, err := db.Exec(migrate6To7AlterMessagesTableQuery); err != nil {
  736. return err
  737. }
  738. if _, err := db.Exec(updateSchemaVersion, 7); err != nil {
  739. return err
  740. }
  741. return nil
  742. }
  743. func migrateFrom7(db *sql.DB, _ time.Duration) error {
  744. log.Info("Migrating cache database schema: from 7 to 8")
  745. if _, err := db.Exec(migrate7To8AlterMessagesTableQuery); err != nil {
  746. return err
  747. }
  748. if _, err := db.Exec(updateSchemaVersion, 8); err != nil {
  749. return err
  750. }
  751. return nil
  752. }
  753. func migrateFrom8(db *sql.DB, _ time.Duration) error {
  754. log.Info("Migrating cache database schema: from 8 to 9")
  755. if _, err := db.Exec(migrate8To9AlterMessagesTableQuery); err != nil {
  756. return err
  757. }
  758. if _, err := db.Exec(updateSchemaVersion, 9); err != nil {
  759. return err
  760. }
  761. return nil
  762. }
  763. func migrateFrom9(db *sql.DB, cacheDuration time.Duration) error {
  764. log.Info("Migrating cache database schema: from 9 to 10")
  765. tx, err := db.Begin()
  766. if err != nil {
  767. return err
  768. }
  769. defer tx.Rollback()
  770. if _, err := tx.Exec(migrate9To10AlterMessagesTableQuery); err != nil {
  771. return err
  772. }
  773. if _, err := tx.Exec(migrate9To10UpdateMessageExpiryQuery, int64(cacheDuration.Seconds())); err != nil {
  774. return err
  775. }
  776. if _, err := tx.Exec(updateSchemaVersion, 10); err != nil {
  777. return err
  778. }
  779. if err := tx.Commit(); err != nil {
  780. return err
  781. }
  782. return nil // Update this when a new version is added
  783. }