message_cache.go 24 KB

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