manager.go 56 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617
  1. // Package user deals with authentication and authorization against topics
  2. package user
  3. import (
  4. "database/sql"
  5. "encoding/json"
  6. "errors"
  7. "fmt"
  8. _ "github.com/mattn/go-sqlite3" // SQLite driver
  9. "github.com/stripe/stripe-go/v74"
  10. "golang.org/x/crypto/bcrypt"
  11. "heckel.io/ntfy/log"
  12. "heckel.io/ntfy/util"
  13. "net/netip"
  14. "strings"
  15. "sync"
  16. "time"
  17. )
  18. const (
  19. tierIDPrefix = "ti_"
  20. tierIDLength = 8
  21. syncTopicPrefix = "st_"
  22. syncTopicLength = 16
  23. userIDPrefix = "u_"
  24. userIDLength = 12
  25. userAuthIntentionalSlowDownHash = "$2a$10$YFCQvqQDwIIwnJM1xkAYOeih0dg17UVGanaTStnrSzC8NCWxcLDwy" // Cost should match DefaultUserPasswordBcryptCost
  26. userHardDeleteAfterDuration = 7 * 24 * time.Hour
  27. tokenPrefix = "tk_"
  28. tokenLength = 32
  29. tokenMaxCount = 20 // Only keep this many tokens in the table per user
  30. tag = "user_manager"
  31. )
  32. // Default constants that may be overridden by configs
  33. const (
  34. DefaultUserStatsQueueWriterInterval = 33 * time.Second
  35. DefaultUserPasswordBcryptCost = 10
  36. )
  37. var (
  38. errNoTokenProvided = errors.New("no token provided")
  39. errTopicOwnedByOthers = errors.New("topic owned by others")
  40. errNoRows = errors.New("no rows found")
  41. )
  42. // Manager-related queries
  43. const (
  44. createTablesQueries = `
  45. BEGIN;
  46. CREATE TABLE IF NOT EXISTS tier (
  47. id TEXT PRIMARY KEY,
  48. code TEXT NOT NULL,
  49. name TEXT NOT NULL,
  50. messages_limit INT NOT NULL,
  51. messages_expiry_duration INT NOT NULL,
  52. emails_limit INT NOT NULL,
  53. sms_limit INT NOT NULL,
  54. calls_limit INT NOT NULL,
  55. reservations_limit INT NOT NULL,
  56. attachment_file_size_limit INT NOT NULL,
  57. attachment_total_size_limit INT NOT NULL,
  58. attachment_expiry_duration INT NOT NULL,
  59. attachment_bandwidth_limit INT NOT NULL,
  60. stripe_monthly_price_id TEXT,
  61. stripe_yearly_price_id TEXT
  62. );
  63. CREATE UNIQUE INDEX idx_tier_code ON tier (code);
  64. CREATE UNIQUE INDEX idx_tier_stripe_monthly_price_id ON tier (stripe_monthly_price_id);
  65. CREATE UNIQUE INDEX idx_tier_stripe_yearly_price_id ON tier (stripe_yearly_price_id);
  66. CREATE TABLE IF NOT EXISTS user (
  67. id TEXT PRIMARY KEY,
  68. tier_id TEXT,
  69. user TEXT NOT NULL,
  70. pass TEXT NOT NULL,
  71. role TEXT CHECK (role IN ('anonymous', 'admin', 'user')) NOT NULL,
  72. prefs JSON NOT NULL DEFAULT '{}',
  73. sync_topic TEXT NOT NULL,
  74. stats_messages INT NOT NULL DEFAULT (0),
  75. stats_emails INT NOT NULL DEFAULT (0),
  76. stats_sms INT NOT NULL DEFAULT (0),
  77. stats_calls INT NOT NULL DEFAULT (0),
  78. stripe_customer_id TEXT,
  79. stripe_subscription_id TEXT,
  80. stripe_subscription_status TEXT,
  81. stripe_subscription_interval TEXT,
  82. stripe_subscription_paid_until INT,
  83. stripe_subscription_cancel_at INT,
  84. created INT NOT NULL,
  85. deleted INT,
  86. FOREIGN KEY (tier_id) REFERENCES tier (id)
  87. );
  88. CREATE UNIQUE INDEX idx_user ON user (user);
  89. CREATE UNIQUE INDEX idx_user_stripe_customer_id ON user (stripe_customer_id);
  90. CREATE UNIQUE INDEX idx_user_stripe_subscription_id ON user (stripe_subscription_id);
  91. CREATE TABLE IF NOT EXISTS user_access (
  92. user_id TEXT NOT NULL,
  93. topic TEXT NOT NULL,
  94. read INT NOT NULL,
  95. write INT NOT NULL,
  96. owner_user_id INT,
  97. PRIMARY KEY (user_id, topic),
  98. FOREIGN KEY (user_id) REFERENCES user (id) ON DELETE CASCADE,
  99. FOREIGN KEY (owner_user_id) REFERENCES user (id) ON DELETE CASCADE
  100. );
  101. CREATE TABLE IF NOT EXISTS user_token (
  102. user_id TEXT NOT NULL,
  103. token TEXT NOT NULL,
  104. label TEXT NOT NULL,
  105. last_access INT NOT NULL,
  106. last_origin TEXT NOT NULL,
  107. expires INT NOT NULL,
  108. PRIMARY KEY (user_id, token),
  109. FOREIGN KEY (user_id) REFERENCES user (id) ON DELETE CASCADE
  110. );
  111. CREATE TABLE IF NOT EXISTS user_phone (
  112. user_id TEXT NOT NULL,
  113. phone_number TEXT NOT NULL,
  114. verified INT NOT NULL,
  115. PRIMARY KEY (user_id, phone_number),
  116. FOREIGN KEY (user_id) REFERENCES user (id) ON DELETE CASCADE
  117. );
  118. CREATE UNIQUE INDEX idx_user_phone_number ON user_phone (phone_number);
  119. CREATE TABLE IF NOT EXISTS schemaVersion (
  120. id INT PRIMARY KEY,
  121. version INT NOT NULL
  122. );
  123. INSERT INTO user (id, user, pass, role, sync_topic, created)
  124. VALUES ('` + everyoneID + `', '*', '', 'anonymous', '', UNIXEPOCH())
  125. ON CONFLICT (id) DO NOTHING;
  126. COMMIT;
  127. `
  128. builtinStartupQueries = `
  129. PRAGMA foreign_keys = ON;
  130. `
  131. selectUserByIDQuery = `
  132. SELECT u.id, u.user, u.pass, u.role, u.prefs, u.sync_topic, u.stats_messages, u.stats_emails, u.stats_sms, u.stats_calls, u.stripe_customer_id, u.stripe_subscription_id, u.stripe_subscription_status, u.stripe_subscription_interval, u.stripe_subscription_paid_until, u.stripe_subscription_cancel_at, deleted, t.id, t.code, t.name, t.messages_limit, t.messages_expiry_duration, t.emails_limit, t.sms_limit, t.calls_limit, t.reservations_limit, t.attachment_file_size_limit, t.attachment_total_size_limit, t.attachment_expiry_duration, t.attachment_bandwidth_limit, t.stripe_monthly_price_id, t.stripe_yearly_price_id
  133. FROM user u
  134. LEFT JOIN tier t on t.id = u.tier_id
  135. WHERE u.id = ?
  136. `
  137. selectUserByNameQuery = `
  138. SELECT u.id, u.user, u.pass, u.role, u.prefs, u.sync_topic, u.stats_messages, u.stats_emails, u.stats_sms, u.stats_calls, u.stripe_customer_id, u.stripe_subscription_id, u.stripe_subscription_status, u.stripe_subscription_interval, u.stripe_subscription_paid_until, u.stripe_subscription_cancel_at, deleted, t.id, t.code, t.name, t.messages_limit, t.messages_expiry_duration, t.emails_limit, t.sms_limit, t.calls_limit, t.reservations_limit, t.attachment_file_size_limit, t.attachment_total_size_limit, t.attachment_expiry_duration, t.attachment_bandwidth_limit, t.stripe_monthly_price_id, t.stripe_yearly_price_id
  139. FROM user u
  140. LEFT JOIN tier t on t.id = u.tier_id
  141. WHERE user = ?
  142. `
  143. selectUserByTokenQuery = `
  144. SELECT u.id, u.user, u.pass, u.role, u.prefs, u.sync_topic, u.stats_messages, u.stats_emails, u.stats_sms, u.stats_calls, u.stripe_customer_id, u.stripe_subscription_id, u.stripe_subscription_status, u.stripe_subscription_interval, u.stripe_subscription_paid_until, u.stripe_subscription_cancel_at, deleted, t.id, t.code, t.name, t.messages_limit, t.messages_expiry_duration, t.emails_limit, t.sms_limit, t.calls_limit, t.reservations_limit, t.attachment_file_size_limit, t.attachment_total_size_limit, t.attachment_expiry_duration, t.attachment_bandwidth_limit, t.stripe_monthly_price_id, t.stripe_yearly_price_id
  145. FROM user u
  146. JOIN user_token tk on u.id = tk.user_id
  147. LEFT JOIN tier t on t.id = u.tier_id
  148. WHERE tk.token = ? AND (tk.expires = 0 OR tk.expires >= ?)
  149. `
  150. selectUserByStripeCustomerIDQuery = `
  151. SELECT u.id, u.user, u.pass, u.role, u.prefs, u.sync_topic, u.stats_messages, u.stats_emails, u.stats_sms, u.stats_calls, u.stripe_customer_id, u.stripe_subscription_id, u.stripe_subscription_status, u.stripe_subscription_interval, u.stripe_subscription_paid_until, u.stripe_subscription_cancel_at, deleted, t.id, t.code, t.name, t.messages_limit, t.messages_expiry_duration, t.emails_limit, t.sms_limit, t.calls_limit, t.reservations_limit, t.attachment_file_size_limit, t.attachment_total_size_limit, t.attachment_expiry_duration, t.attachment_bandwidth_limit, t.stripe_monthly_price_id, t.stripe_yearly_price_id
  152. FROM user u
  153. LEFT JOIN tier t on t.id = u.tier_id
  154. WHERE u.stripe_customer_id = ?
  155. `
  156. selectTopicPermsQuery = `
  157. SELECT read, write
  158. FROM user_access a
  159. JOIN user u ON u.id = a.user_id
  160. WHERE (u.user = ? OR u.user = ?) AND ? LIKE a.topic
  161. ORDER BY u.user DESC
  162. `
  163. insertUserQuery = `
  164. INSERT INTO user (id, user, pass, role, sync_topic, created)
  165. VALUES (?, ?, ?, ?, ?, ?)
  166. `
  167. selectUsernamesQuery = `
  168. SELECT user
  169. FROM user
  170. ORDER BY
  171. CASE role
  172. WHEN 'admin' THEN 1
  173. WHEN 'anonymous' THEN 3
  174. ELSE 2
  175. END, user
  176. `
  177. selectUserCountQuery = `SELECT COUNT(*) FROM user`
  178. updateUserPassQuery = `UPDATE user SET pass = ? WHERE user = ?`
  179. updateUserRoleQuery = `UPDATE user SET role = ? WHERE user = ?`
  180. updateUserPrefsQuery = `UPDATE user SET prefs = ? WHERE id = ?`
  181. updateUserStatsQuery = `UPDATE user SET stats_messages = ?, stats_emails = ?, stats_sms = ?, stats_calls = ? WHERE id = ?`
  182. updateUserStatsResetAllQuery = `UPDATE user SET stats_messages = 0, stats_emails = 0, stats_sms = 0, stats_calls = 0`
  183. updateUserDeletedQuery = `UPDATE user SET deleted = ? WHERE id = ?`
  184. deleteUsersMarkedQuery = `DELETE FROM user WHERE deleted < ?`
  185. deleteUserQuery = `DELETE FROM user WHERE user = ?`
  186. upsertUserAccessQuery = `
  187. INSERT INTO user_access (user_id, topic, read, write, owner_user_id)
  188. VALUES ((SELECT id FROM user WHERE user = ?), ?, ?, ?, (SELECT IIF(?='',NULL,(SELECT id FROM user WHERE user=?))))
  189. ON CONFLICT (user_id, topic)
  190. DO UPDATE SET read=excluded.read, write=excluded.write, owner_user_id=excluded.owner_user_id
  191. `
  192. selectUserAccessQuery = `
  193. SELECT topic, read, write
  194. FROM user_access
  195. WHERE user_id = (SELECT id FROM user WHERE user = ?)
  196. ORDER BY write DESC, read DESC, topic
  197. `
  198. selectUserReservationsQuery = `
  199. SELECT a_user.topic, a_user.read, a_user.write, a_everyone.read AS everyone_read, a_everyone.write AS everyone_write
  200. FROM user_access a_user
  201. LEFT JOIN user_access a_everyone ON a_user.topic = a_everyone.topic AND a_everyone.user_id = (SELECT id FROM user WHERE user = ?)
  202. WHERE a_user.user_id = a_user.owner_user_id
  203. AND a_user.owner_user_id = (SELECT id FROM user WHERE user = ?)
  204. ORDER BY a_user.topic
  205. `
  206. selectUserReservationsCountQuery = `
  207. SELECT COUNT(*)
  208. FROM user_access
  209. WHERE user_id = owner_user_id
  210. AND owner_user_id = (SELECT id FROM user WHERE user = ?)
  211. `
  212. selectUserReservationsOwnerQuery = `
  213. SELECT owner_user_id
  214. FROM user_access
  215. WHERE topic = ?
  216. AND user_id = owner_user_id
  217. `
  218. selectUserHasReservationQuery = `
  219. SELECT COUNT(*)
  220. FROM user_access
  221. WHERE user_id = owner_user_id
  222. AND owner_user_id = (SELECT id FROM user WHERE user = ?)
  223. AND topic = ?
  224. `
  225. selectOtherAccessCountQuery = `
  226. SELECT COUNT(*)
  227. FROM user_access
  228. WHERE (topic = ? OR ? LIKE topic)
  229. AND (owner_user_id IS NULL OR owner_user_id != (SELECT id FROM user WHERE user = ?))
  230. `
  231. deleteAllAccessQuery = `DELETE FROM user_access`
  232. deleteUserAccessQuery = `
  233. DELETE FROM user_access
  234. WHERE user_id = (SELECT id FROM user WHERE user = ?)
  235. OR owner_user_id = (SELECT id FROM user WHERE user = ?)
  236. `
  237. deleteTopicAccessQuery = `
  238. DELETE FROM user_access
  239. WHERE (user_id = (SELECT id FROM user WHERE user = ?) OR owner_user_id = (SELECT id FROM user WHERE user = ?))
  240. AND topic = ?
  241. `
  242. selectTokenCountQuery = `SELECT COUNT(*) FROM user_token WHERE user_id = ?`
  243. selectTokensQuery = `SELECT token, label, last_access, last_origin, expires FROM user_token WHERE user_id = ?`
  244. selectTokenQuery = `SELECT token, label, last_access, last_origin, expires FROM user_token WHERE user_id = ? AND token = ?`
  245. insertTokenQuery = `INSERT INTO user_token (user_id, token, label, last_access, last_origin, expires) VALUES (?, ?, ?, ?, ?, ?)`
  246. updateTokenExpiryQuery = `UPDATE user_token SET expires = ? WHERE user_id = ? AND token = ?`
  247. updateTokenLabelQuery = `UPDATE user_token SET label = ? WHERE user_id = ? AND token = ?`
  248. updateTokenLastAccessQuery = `UPDATE user_token SET last_access = ?, last_origin = ? WHERE token = ?`
  249. deleteTokenQuery = `DELETE FROM user_token WHERE user_id = ? AND token = ?`
  250. deleteAllTokenQuery = `DELETE FROM user_token WHERE user_id = ?`
  251. deleteExpiredTokensQuery = `DELETE FROM user_token WHERE expires > 0 AND expires < ?`
  252. deleteExcessTokensQuery = `
  253. DELETE FROM user_token
  254. WHERE (user_id, token) NOT IN (
  255. SELECT user_id, token
  256. FROM user_token
  257. WHERE user_id = ?
  258. ORDER BY expires DESC
  259. LIMIT ?
  260. )
  261. `
  262. selectPhoneNumbersQuery = `SELECT phone_number, verified FROM user_phone WHERE user_id = ?`
  263. insertPhoneNumberQuery = `INSERT INTO user_phone (user_id, phone_number, verified) VALUES (?, ?, 0)`
  264. updatePhoneNumberVerifiedQuery = `UPDATE user_phone SET verified=1 WHERE user_id = ? AND phone_number = ?`
  265. insertTierQuery = `
  266. INSERT INTO tier (id, code, name, messages_limit, messages_expiry_duration, emails_limit, sms_limit, calls_limit, reservations_limit, attachment_file_size_limit, attachment_total_size_limit, attachment_expiry_duration, attachment_bandwidth_limit, stripe_monthly_price_id, stripe_yearly_price_id)
  267. VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
  268. `
  269. updateTierQuery = `
  270. UPDATE tier
  271. SET name = ?, messages_limit = ?, messages_expiry_duration = ?, emails_limit = ?, sms_limit = ?, calls_limit = ?, reservations_limit = ?, attachment_file_size_limit = ?, attachment_total_size_limit = ?, attachment_expiry_duration = ?, attachment_bandwidth_limit = ?, stripe_monthly_price_id = ?, stripe_yearly_price_id = ?
  272. WHERE code = ?
  273. `
  274. selectTiersQuery = `
  275. SELECT id, code, name, messages_limit, messages_expiry_duration, emails_limit, sms_limit, calls_limit, reservations_limit, attachment_file_size_limit, attachment_total_size_limit, attachment_expiry_duration, attachment_bandwidth_limit, stripe_monthly_price_id, stripe_yearly_price_id
  276. FROM tier
  277. `
  278. selectTierByCodeQuery = `
  279. SELECT id, code, name, messages_limit, messages_expiry_duration, emails_limit, sms_limit, calls_limit, reservations_limit, attachment_file_size_limit, attachment_total_size_limit, attachment_expiry_duration, attachment_bandwidth_limit, stripe_monthly_price_id, stripe_yearly_price_id
  280. FROM tier
  281. WHERE code = ?
  282. `
  283. selectTierByPriceIDQuery = `
  284. SELECT id, code, name, messages_limit, messages_expiry_duration, emails_limit, sms_limit, calls_limit, reservations_limit, attachment_file_size_limit, attachment_total_size_limit, attachment_expiry_duration, attachment_bandwidth_limit, stripe_monthly_price_id, stripe_yearly_price_id
  285. FROM tier
  286. WHERE (stripe_monthly_price_id = ? OR stripe_yearly_price_id = ?)
  287. `
  288. updateUserTierQuery = `UPDATE user SET tier_id = (SELECT id FROM tier WHERE code = ?) WHERE user = ?`
  289. deleteUserTierQuery = `UPDATE user SET tier_id = null WHERE user = ?`
  290. deleteTierQuery = `DELETE FROM tier WHERE code = ?`
  291. updateBillingQuery = `
  292. UPDATE user
  293. SET stripe_customer_id = ?, stripe_subscription_id = ?, stripe_subscription_status = ?, stripe_subscription_interval = ?, stripe_subscription_paid_until = ?, stripe_subscription_cancel_at = ?
  294. WHERE user = ?
  295. `
  296. )
  297. // Schema management queries
  298. const (
  299. currentSchemaVersion = 4
  300. insertSchemaVersion = `INSERT INTO schemaVersion VALUES (1, ?)`
  301. updateSchemaVersion = `UPDATE schemaVersion SET version = ? WHERE id = 1`
  302. selectSchemaVersionQuery = `SELECT version FROM schemaVersion WHERE id = 1`
  303. // 1 -> 2 (complex migration!)
  304. migrate1To2CreateTablesQueries = `
  305. ALTER TABLE user RENAME TO user_old;
  306. CREATE TABLE IF NOT EXISTS tier (
  307. id TEXT PRIMARY KEY,
  308. code TEXT NOT NULL,
  309. name TEXT NOT NULL,
  310. messages_limit INT NOT NULL,
  311. messages_expiry_duration INT NOT NULL,
  312. emails_limit INT NOT NULL,
  313. reservations_limit INT NOT NULL,
  314. attachment_file_size_limit INT NOT NULL,
  315. attachment_total_size_limit INT NOT NULL,
  316. attachment_expiry_duration INT NOT NULL,
  317. attachment_bandwidth_limit INT NOT NULL,
  318. stripe_price_id TEXT
  319. );
  320. CREATE UNIQUE INDEX idx_tier_code ON tier (code);
  321. CREATE UNIQUE INDEX idx_tier_price_id ON tier (stripe_price_id);
  322. CREATE TABLE IF NOT EXISTS user (
  323. id TEXT PRIMARY KEY,
  324. tier_id TEXT,
  325. user TEXT NOT NULL,
  326. pass TEXT NOT NULL,
  327. role TEXT CHECK (role IN ('anonymous', 'admin', 'user')) NOT NULL,
  328. prefs JSON NOT NULL DEFAULT '{}',
  329. sync_topic TEXT NOT NULL,
  330. stats_messages INT NOT NULL DEFAULT (0),
  331. stats_emails INT NOT NULL DEFAULT (0),
  332. stripe_customer_id TEXT,
  333. stripe_subscription_id TEXT,
  334. stripe_subscription_status TEXT,
  335. stripe_subscription_paid_until INT,
  336. stripe_subscription_cancel_at INT,
  337. created INT NOT NULL,
  338. deleted INT,
  339. FOREIGN KEY (tier_id) REFERENCES tier (id)
  340. );
  341. CREATE UNIQUE INDEX idx_user ON user (user);
  342. CREATE UNIQUE INDEX idx_user_stripe_customer_id ON user (stripe_customer_id);
  343. CREATE UNIQUE INDEX idx_user_stripe_subscription_id ON user (stripe_subscription_id);
  344. CREATE TABLE IF NOT EXISTS user_access (
  345. user_id TEXT NOT NULL,
  346. topic TEXT NOT NULL,
  347. read INT NOT NULL,
  348. write INT NOT NULL,
  349. owner_user_id INT,
  350. PRIMARY KEY (user_id, topic),
  351. FOREIGN KEY (user_id) REFERENCES user (id) ON DELETE CASCADE,
  352. FOREIGN KEY (owner_user_id) REFERENCES user (id) ON DELETE CASCADE
  353. );
  354. CREATE TABLE IF NOT EXISTS user_token (
  355. user_id TEXT NOT NULL,
  356. token TEXT NOT NULL,
  357. label TEXT NOT NULL,
  358. last_access INT NOT NULL,
  359. last_origin TEXT NOT NULL,
  360. expires INT NOT NULL,
  361. PRIMARY KEY (user_id, token),
  362. FOREIGN KEY (user_id) REFERENCES user (id) ON DELETE CASCADE
  363. );
  364. CREATE TABLE IF NOT EXISTS schemaVersion (
  365. id INT PRIMARY KEY,
  366. version INT NOT NULL
  367. );
  368. INSERT INTO user (id, user, pass, role, sync_topic, created)
  369. VALUES ('u_everyone', '*', '', 'anonymous', '', UNIXEPOCH())
  370. ON CONFLICT (id) DO NOTHING;
  371. `
  372. migrate1To2SelectAllOldUsernamesNoTx = `SELECT user FROM user_old`
  373. migrate1To2InsertUserNoTx = `
  374. INSERT INTO user (id, user, pass, role, sync_topic, created)
  375. SELECT ?, user, pass, role, ?, UNIXEPOCH() FROM user_old WHERE user = ?
  376. `
  377. migrate1To2InsertFromOldTablesAndDropNoTx = `
  378. INSERT INTO user_access (user_id, topic, read, write)
  379. SELECT u.id, a.topic, a.read, a.write
  380. FROM user u
  381. JOIN access a ON u.user = a.user;
  382. DROP TABLE access;
  383. DROP TABLE user_old;
  384. `
  385. // 2 -> 3
  386. migrate2To3UpdateQueries = `
  387. ALTER TABLE user ADD COLUMN stripe_subscription_interval TEXT;
  388. ALTER TABLE tier RENAME COLUMN stripe_price_id TO stripe_monthly_price_id;
  389. ALTER TABLE tier ADD COLUMN stripe_yearly_price_id TEXT;
  390. DROP INDEX IF EXISTS idx_tier_price_id;
  391. CREATE UNIQUE INDEX idx_tier_stripe_monthly_price_id ON tier (stripe_monthly_price_id);
  392. CREATE UNIQUE INDEX idx_tier_stripe_yearly_price_id ON tier (stripe_yearly_price_id);
  393. `
  394. // 3 -> 4
  395. migrate3To4UpdateQueries = `
  396. ALTER TABLE tier ADD COLUMN sms_limit INT NOT NULL DEFAULT (0);
  397. ALTER TABLE tier ADD COLUMN calls_limit INT NOT NULL DEFAULT (0);
  398. ALTER TABLE user ADD COLUMN stats_sms INT NOT NULL DEFAULT (0);
  399. ALTER TABLE user ADD COLUMN stats_calls INT NOT NULL DEFAULT (0);
  400. CREATE TABLE IF NOT EXISTS user_phone (
  401. user_id TEXT NOT NULL,
  402. phone_number TEXT NOT NULL,
  403. verified INT NOT NULL,
  404. PRIMARY KEY (user_id, phone_number),
  405. FOREIGN KEY (user_id) REFERENCES user (id) ON DELETE CASCADE
  406. );
  407. CREATE UNIQUE INDEX idx_user_phone_number ON user_phone (phone_number);
  408. `
  409. )
  410. var (
  411. migrations = map[int]func(db *sql.DB) error{
  412. 1: migrateFrom1,
  413. 2: migrateFrom2,
  414. 3: migrateFrom3,
  415. }
  416. )
  417. // Manager is an implementation of Manager. It stores users and access control list
  418. // in a SQLite database.
  419. type Manager struct {
  420. db *sql.DB
  421. defaultAccess Permission // Default permission if no ACL matches
  422. statsQueue map[string]*Stats // "Queue" to asynchronously write user stats to the database (UserID -> Stats)
  423. tokenQueue map[string]*TokenUpdate // "Queue" to asynchronously write token access stats to the database (Token ID -> TokenUpdate)
  424. bcryptCost int // Makes testing easier
  425. mu sync.Mutex
  426. }
  427. var _ Auther = (*Manager)(nil)
  428. // NewManager creates a new Manager instance
  429. func NewManager(filename, startupQueries string, defaultAccess Permission, bcryptCost int, queueWriterInterval time.Duration) (*Manager, error) {
  430. db, err := sql.Open("sqlite3", filename)
  431. if err != nil {
  432. return nil, err
  433. }
  434. if err := setupDB(db); err != nil {
  435. return nil, err
  436. }
  437. if err := runStartupQueries(db, startupQueries); err != nil {
  438. return nil, err
  439. }
  440. manager := &Manager{
  441. db: db,
  442. defaultAccess: defaultAccess,
  443. statsQueue: make(map[string]*Stats),
  444. tokenQueue: make(map[string]*TokenUpdate),
  445. bcryptCost: bcryptCost,
  446. }
  447. go manager.asyncQueueWriter(queueWriterInterval)
  448. return manager, nil
  449. }
  450. // Authenticate checks username and password and returns a User if correct, and the user has not been
  451. // marked as deleted. The method returns in constant-ish time, regardless of whether the user exists or
  452. // the password is correct or incorrect.
  453. func (a *Manager) Authenticate(username, password string) (*User, error) {
  454. if username == Everyone {
  455. return nil, ErrUnauthenticated
  456. }
  457. user, err := a.User(username)
  458. if err != nil {
  459. log.Tag(tag).Field("user_name", username).Err(err).Trace("Authentication of user failed (1)")
  460. bcrypt.CompareHashAndPassword([]byte(userAuthIntentionalSlowDownHash), []byte("intentional slow-down to avoid timing attacks"))
  461. return nil, ErrUnauthenticated
  462. } else if user.Deleted {
  463. log.Tag(tag).Field("user_name", username).Trace("Authentication of user failed (2): user marked deleted")
  464. bcrypt.CompareHashAndPassword([]byte(userAuthIntentionalSlowDownHash), []byte("intentional slow-down to avoid timing attacks"))
  465. return nil, ErrUnauthenticated
  466. } else if err := bcrypt.CompareHashAndPassword([]byte(user.Hash), []byte(password)); err != nil {
  467. log.Tag(tag).Field("user_name", username).Err(err).Trace("Authentication of user failed (3)")
  468. return nil, ErrUnauthenticated
  469. }
  470. return user, nil
  471. }
  472. // AuthenticateToken checks if the token exists and returns the associated User if it does.
  473. // The method sets the User.Token value to the token that was used for authentication.
  474. func (a *Manager) AuthenticateToken(token string) (*User, error) {
  475. if len(token) != tokenLength {
  476. return nil, ErrUnauthenticated
  477. }
  478. user, err := a.userByToken(token)
  479. if err != nil {
  480. log.Tag(tag).Field("token", token).Err(err).Trace("Authentication of token failed")
  481. return nil, ErrUnauthenticated
  482. }
  483. user.Token = token
  484. return user, nil
  485. }
  486. // CreateToken generates a random token for the given user and returns it. The token expires
  487. // after a fixed duration unless ChangeToken is called. This function also prunes tokens for the
  488. // given user, if there are too many of them.
  489. func (a *Manager) CreateToken(userID, label string, expires time.Time, origin netip.Addr) (*Token, error) {
  490. token := util.RandomStringPrefix(tokenPrefix, tokenLength)
  491. tx, err := a.db.Begin()
  492. if err != nil {
  493. return nil, err
  494. }
  495. defer tx.Rollback()
  496. access := time.Now()
  497. if _, err := tx.Exec(insertTokenQuery, userID, token, label, access.Unix(), origin.String(), expires.Unix()); err != nil {
  498. return nil, err
  499. }
  500. rows, err := tx.Query(selectTokenCountQuery, userID)
  501. if err != nil {
  502. return nil, err
  503. }
  504. defer rows.Close()
  505. if !rows.Next() {
  506. return nil, errNoRows
  507. }
  508. var tokenCount int
  509. if err := rows.Scan(&tokenCount); err != nil {
  510. return nil, err
  511. }
  512. if tokenCount >= tokenMaxCount {
  513. // This pruning logic is done in two queries for efficiency. The SELECT above is a lookup
  514. // on two indices, whereas the query below is a full table scan.
  515. if _, err := tx.Exec(deleteExcessTokensQuery, userID, tokenMaxCount); err != nil {
  516. return nil, err
  517. }
  518. }
  519. if err := tx.Commit(); err != nil {
  520. return nil, err
  521. }
  522. return &Token{
  523. Value: token,
  524. Label: label,
  525. LastAccess: access,
  526. LastOrigin: origin,
  527. Expires: expires,
  528. }, nil
  529. }
  530. // Tokens returns all existing tokens for the user with the given user ID
  531. func (a *Manager) Tokens(userID string) ([]*Token, error) {
  532. rows, err := a.db.Query(selectTokensQuery, userID)
  533. if err != nil {
  534. return nil, err
  535. }
  536. defer rows.Close()
  537. tokens := make([]*Token, 0)
  538. for {
  539. token, err := a.readToken(rows)
  540. if err == ErrTokenNotFound {
  541. break
  542. } else if err != nil {
  543. return nil, err
  544. }
  545. tokens = append(tokens, token)
  546. }
  547. return tokens, nil
  548. }
  549. // Token returns a specific token for a user
  550. func (a *Manager) Token(userID, token string) (*Token, error) {
  551. rows, err := a.db.Query(selectTokenQuery, userID, token)
  552. if err != nil {
  553. return nil, err
  554. }
  555. defer rows.Close()
  556. return a.readToken(rows)
  557. }
  558. func (a *Manager) readToken(rows *sql.Rows) (*Token, error) {
  559. var token, label, lastOrigin string
  560. var lastAccess, expires int64
  561. if !rows.Next() {
  562. return nil, ErrTokenNotFound
  563. }
  564. if err := rows.Scan(&token, &label, &lastAccess, &lastOrigin, &expires); err != nil {
  565. return nil, err
  566. } else if err := rows.Err(); err != nil {
  567. return nil, err
  568. }
  569. lastOriginIP, err := netip.ParseAddr(lastOrigin)
  570. if err != nil {
  571. lastOriginIP = netip.IPv4Unspecified()
  572. }
  573. return &Token{
  574. Value: token,
  575. Label: label,
  576. LastAccess: time.Unix(lastAccess, 0),
  577. LastOrigin: lastOriginIP,
  578. Expires: time.Unix(expires, 0),
  579. }, nil
  580. }
  581. // ChangeToken updates a token's label and/or expiry date
  582. func (a *Manager) ChangeToken(userID, token string, label *string, expires *time.Time) (*Token, error) {
  583. if token == "" {
  584. return nil, errNoTokenProvided
  585. }
  586. tx, err := a.db.Begin()
  587. if err != nil {
  588. return nil, err
  589. }
  590. defer tx.Rollback()
  591. if label != nil {
  592. if _, err := tx.Exec(updateTokenLabelQuery, *label, userID, token); err != nil {
  593. return nil, err
  594. }
  595. }
  596. if expires != nil {
  597. if _, err := tx.Exec(updateTokenExpiryQuery, expires.Unix(), userID, token); err != nil {
  598. return nil, err
  599. }
  600. }
  601. if err := tx.Commit(); err != nil {
  602. return nil, err
  603. }
  604. return a.Token(userID, token)
  605. }
  606. // RemoveToken deletes the token defined in User.Token
  607. func (a *Manager) RemoveToken(userID, token string) error {
  608. if token == "" {
  609. return errNoTokenProvided
  610. }
  611. if _, err := a.db.Exec(deleteTokenQuery, userID, token); err != nil {
  612. return err
  613. }
  614. return nil
  615. }
  616. // RemoveExpiredTokens deletes all expired tokens from the database
  617. func (a *Manager) RemoveExpiredTokens() error {
  618. if _, err := a.db.Exec(deleteExpiredTokensQuery, time.Now().Unix()); err != nil {
  619. return err
  620. }
  621. return nil
  622. }
  623. func (a *Manager) PhoneNumbers(userID string) ([]*PhoneNumber, error) {
  624. rows, err := a.db.Query(selectPhoneNumbersQuery, userID)
  625. if err != nil {
  626. return nil, err
  627. }
  628. defer rows.Close()
  629. phoneNumbers := make([]*PhoneNumber, 0)
  630. for {
  631. phoneNumber, err := a.readPhoneNumber(rows)
  632. if err == ErrPhoneNumberNotFound {
  633. break
  634. } else if err != nil {
  635. return nil, err
  636. }
  637. phoneNumbers = append(phoneNumbers, phoneNumber)
  638. }
  639. return phoneNumbers, nil
  640. }
  641. func (a *Manager) readPhoneNumber(rows *sql.Rows) (*PhoneNumber, error) {
  642. var phoneNumber string
  643. var verified bool
  644. if !rows.Next() {
  645. return nil, ErrPhoneNumberNotFound
  646. }
  647. if err := rows.Scan(&phoneNumber, &verified); err != nil {
  648. return nil, err
  649. } else if err := rows.Err(); err != nil {
  650. return nil, err
  651. }
  652. return &PhoneNumber{
  653. Number: phoneNumber,
  654. Verified: verified,
  655. }, nil
  656. }
  657. func (a *Manager) AddPhoneNumber(userID string, phoneNumber string) error {
  658. if _, err := a.db.Exec(insertPhoneNumberQuery, userID, phoneNumber); err != nil {
  659. return err
  660. }
  661. return nil
  662. }
  663. func (a *Manager) MarkPhoneNumberVerified(userID string, phoneNumber string) error {
  664. if _, err := a.db.Exec(updatePhoneNumberVerifiedQuery, userID, phoneNumber); err != nil {
  665. return err
  666. }
  667. return nil
  668. }
  669. // RemoveDeletedUsers deletes all users that have been marked deleted for
  670. func (a *Manager) RemoveDeletedUsers() error {
  671. if _, err := a.db.Exec(deleteUsersMarkedQuery, time.Now().Unix()); err != nil {
  672. return err
  673. }
  674. return nil
  675. }
  676. // ChangeSettings persists the user settings
  677. func (a *Manager) ChangeSettings(userID string, prefs *Prefs) error {
  678. b, err := json.Marshal(prefs)
  679. if err != nil {
  680. return err
  681. }
  682. if _, err := a.db.Exec(updateUserPrefsQuery, string(b), userID); err != nil {
  683. return err
  684. }
  685. return nil
  686. }
  687. // ResetStats resets all user stats in the user database. This touches all users.
  688. func (a *Manager) ResetStats() error {
  689. a.mu.Lock() // Includes database query to avoid races!
  690. defer a.mu.Unlock()
  691. if _, err := a.db.Exec(updateUserStatsResetAllQuery); err != nil {
  692. return err
  693. }
  694. a.statsQueue = make(map[string]*Stats)
  695. return nil
  696. }
  697. // EnqueueUserStats adds the user to a queue which writes out user stats (messages, emails, ..) in
  698. // batches at a regular interval
  699. func (a *Manager) EnqueueUserStats(userID string, stats *Stats) {
  700. a.mu.Lock()
  701. defer a.mu.Unlock()
  702. a.statsQueue[userID] = stats
  703. }
  704. // EnqueueTokenUpdate adds the token update to a queue which writes out token access times
  705. // in batches at a regular interval
  706. func (a *Manager) EnqueueTokenUpdate(tokenID string, update *TokenUpdate) {
  707. a.mu.Lock()
  708. defer a.mu.Unlock()
  709. a.tokenQueue[tokenID] = update
  710. }
  711. func (a *Manager) asyncQueueWriter(interval time.Duration) {
  712. ticker := time.NewTicker(interval)
  713. for range ticker.C {
  714. if err := a.writeUserStatsQueue(); err != nil {
  715. log.Tag(tag).Err(err).Warn("Writing user stats queue failed")
  716. }
  717. if err := a.writeTokenUpdateQueue(); err != nil {
  718. log.Tag(tag).Err(err).Warn("Writing token update queue failed")
  719. }
  720. }
  721. }
  722. func (a *Manager) writeUserStatsQueue() error {
  723. a.mu.Lock()
  724. if len(a.statsQueue) == 0 {
  725. a.mu.Unlock()
  726. log.Tag(tag).Trace("No user stats updates to commit")
  727. return nil
  728. }
  729. statsQueue := a.statsQueue
  730. a.statsQueue = make(map[string]*Stats)
  731. a.mu.Unlock()
  732. tx, err := a.db.Begin()
  733. if err != nil {
  734. return err
  735. }
  736. defer tx.Rollback()
  737. log.Tag(tag).Debug("Writing user stats queue for %d user(s)", len(statsQueue))
  738. for userID, update := range statsQueue {
  739. log.
  740. Tag(tag).
  741. Fields(log.Context{
  742. "user_id": userID,
  743. "messages_count": update.Messages,
  744. "emails_count": update.Emails,
  745. "sms_count": update.SMS,
  746. "calls_count": update.Calls,
  747. }).
  748. Trace("Updating stats for user %s", userID)
  749. if _, err := tx.Exec(updateUserStatsQuery, update.Messages, update.Emails, update.SMS, update.Calls, userID); err != nil {
  750. return err
  751. }
  752. }
  753. return tx.Commit()
  754. }
  755. func (a *Manager) writeTokenUpdateQueue() error {
  756. a.mu.Lock()
  757. if len(a.tokenQueue) == 0 {
  758. a.mu.Unlock()
  759. log.Tag(tag).Trace("No token updates to commit")
  760. return nil
  761. }
  762. tokenQueue := a.tokenQueue
  763. a.tokenQueue = make(map[string]*TokenUpdate)
  764. a.mu.Unlock()
  765. tx, err := a.db.Begin()
  766. if err != nil {
  767. return err
  768. }
  769. defer tx.Rollback()
  770. log.Tag(tag).Debug("Writing token update queue for %d token(s)", len(tokenQueue))
  771. for tokenID, update := range tokenQueue {
  772. log.Tag(tag).Trace("Updating token %s with last access time %v", tokenID, update.LastAccess.Unix())
  773. if _, err := tx.Exec(updateTokenLastAccessQuery, update.LastAccess.Unix(), update.LastOrigin.String(), tokenID); err != nil {
  774. return err
  775. }
  776. }
  777. return tx.Commit()
  778. }
  779. // Authorize returns nil if the given user has access to the given topic using the desired
  780. // permission. The user param may be nil to signal an anonymous user.
  781. func (a *Manager) Authorize(user *User, topic string, perm Permission) error {
  782. if user != nil && user.Role == RoleAdmin {
  783. return nil // Admin can do everything
  784. }
  785. username := Everyone
  786. if user != nil {
  787. username = user.Name
  788. }
  789. // Select the read/write permissions for this user/topic combo. The query may return two
  790. // rows (one for everyone, and one for the user), but prioritizes the user.
  791. rows, err := a.db.Query(selectTopicPermsQuery, Everyone, username, topic)
  792. if err != nil {
  793. return err
  794. }
  795. defer rows.Close()
  796. if !rows.Next() {
  797. return a.resolvePerms(a.defaultAccess, perm)
  798. }
  799. var read, write bool
  800. if err := rows.Scan(&read, &write); err != nil {
  801. return err
  802. } else if err := rows.Err(); err != nil {
  803. return err
  804. }
  805. return a.resolvePerms(NewPermission(read, write), perm)
  806. }
  807. func (a *Manager) resolvePerms(base, perm Permission) error {
  808. if perm == PermissionRead && base.IsRead() {
  809. return nil
  810. } else if perm == PermissionWrite && base.IsWrite() {
  811. return nil
  812. }
  813. return ErrUnauthorized
  814. }
  815. // AddUser adds a user with the given username, password and role
  816. func (a *Manager) AddUser(username, password string, role Role) error {
  817. if !AllowedUsername(username) || !AllowedRole(role) {
  818. return ErrInvalidArgument
  819. }
  820. hash, err := bcrypt.GenerateFromPassword([]byte(password), a.bcryptCost)
  821. if err != nil {
  822. return err
  823. }
  824. userID := util.RandomStringPrefix(userIDPrefix, userIDLength)
  825. syncTopic, now := util.RandomStringPrefix(syncTopicPrefix, syncTopicLength), time.Now().Unix()
  826. if _, err = a.db.Exec(insertUserQuery, userID, username, hash, role, syncTopic, now); err != nil {
  827. return err
  828. }
  829. return nil
  830. }
  831. // RemoveUser deletes the user with the given username. The function returns nil on success, even
  832. // if the user did not exist in the first place.
  833. func (a *Manager) RemoveUser(username string) error {
  834. if !AllowedUsername(username) {
  835. return ErrInvalidArgument
  836. }
  837. // Rows in user_access, user_token, etc. are deleted via foreign keys
  838. if _, err := a.db.Exec(deleteUserQuery, username); err != nil {
  839. return err
  840. }
  841. return nil
  842. }
  843. // MarkUserRemoved sets the deleted flag on the user, and deletes all access tokens. This prevents
  844. // successful auth via Authenticate. A background process will delete the user at a later date.
  845. func (a *Manager) MarkUserRemoved(user *User) error {
  846. if !AllowedUsername(user.Name) {
  847. return ErrInvalidArgument
  848. }
  849. tx, err := a.db.Begin()
  850. if err != nil {
  851. return err
  852. }
  853. defer tx.Rollback()
  854. if _, err := tx.Exec(deleteUserAccessQuery, user.Name, user.Name); err != nil {
  855. return err
  856. }
  857. if _, err := tx.Exec(deleteAllTokenQuery, user.ID); err != nil {
  858. return err
  859. }
  860. if _, err := tx.Exec(updateUserDeletedQuery, time.Now().Add(userHardDeleteAfterDuration).Unix(), user.ID); err != nil {
  861. return err
  862. }
  863. return tx.Commit()
  864. }
  865. // Users returns a list of users. It always also returns the Everyone user ("*").
  866. func (a *Manager) Users() ([]*User, error) {
  867. rows, err := a.db.Query(selectUsernamesQuery)
  868. if err != nil {
  869. return nil, err
  870. }
  871. defer rows.Close()
  872. usernames := make([]string, 0)
  873. for rows.Next() {
  874. var username string
  875. if err := rows.Scan(&username); err != nil {
  876. return nil, err
  877. } else if err := rows.Err(); err != nil {
  878. return nil, err
  879. }
  880. usernames = append(usernames, username)
  881. }
  882. rows.Close()
  883. users := make([]*User, 0)
  884. for _, username := range usernames {
  885. user, err := a.User(username)
  886. if err != nil {
  887. return nil, err
  888. }
  889. users = append(users, user)
  890. }
  891. return users, nil
  892. }
  893. // UsersCount returns the number of users in the databsae
  894. func (a *Manager) UsersCount() (int64, error) {
  895. rows, err := a.db.Query(selectUserCountQuery)
  896. if err != nil {
  897. return 0, err
  898. }
  899. defer rows.Close()
  900. if !rows.Next() {
  901. return 0, errNoRows
  902. }
  903. var count int64
  904. if err := rows.Scan(&count); err != nil {
  905. return 0, err
  906. }
  907. return count, nil
  908. }
  909. // User returns the user with the given username if it exists, or ErrUserNotFound otherwise.
  910. // You may also pass Everyone to retrieve the anonymous user and its Grant list.
  911. func (a *Manager) User(username string) (*User, error) {
  912. rows, err := a.db.Query(selectUserByNameQuery, username)
  913. if err != nil {
  914. return nil, err
  915. }
  916. return a.readUser(rows)
  917. }
  918. // UserByID returns the user with the given ID if it exists, or ErrUserNotFound otherwise
  919. func (a *Manager) UserByID(id string) (*User, error) {
  920. rows, err := a.db.Query(selectUserByIDQuery, id)
  921. if err != nil {
  922. return nil, err
  923. }
  924. return a.readUser(rows)
  925. }
  926. // UserByStripeCustomer returns the user with the given Stripe customer ID if it exists, or ErrUserNotFound otherwise.
  927. func (a *Manager) UserByStripeCustomer(stripeCustomerID string) (*User, error) {
  928. rows, err := a.db.Query(selectUserByStripeCustomerIDQuery, stripeCustomerID)
  929. if err != nil {
  930. return nil, err
  931. }
  932. return a.readUser(rows)
  933. }
  934. func (a *Manager) userByToken(token string) (*User, error) {
  935. rows, err := a.db.Query(selectUserByTokenQuery, token, time.Now().Unix())
  936. if err != nil {
  937. return nil, err
  938. }
  939. return a.readUser(rows)
  940. }
  941. func (a *Manager) readUser(rows *sql.Rows) (*User, error) {
  942. defer rows.Close()
  943. var id, username, hash, role, prefs, syncTopic string
  944. var stripeCustomerID, stripeSubscriptionID, stripeSubscriptionStatus, stripeSubscriptionInterval, stripeMonthlyPriceID, stripeYearlyPriceID, tierID, tierCode, tierName sql.NullString
  945. var messages, emails, sms, calls int64
  946. var messagesLimit, messagesExpiryDuration, emailsLimit, smsLimit, callsLimit, reservationsLimit, attachmentFileSizeLimit, attachmentTotalSizeLimit, attachmentExpiryDuration, attachmentBandwidthLimit, stripeSubscriptionPaidUntil, stripeSubscriptionCancelAt, deleted sql.NullInt64
  947. if !rows.Next() {
  948. return nil, ErrUserNotFound
  949. }
  950. if err := rows.Scan(&id, &username, &hash, &role, &prefs, &syncTopic, &messages, &emails, &sms, &calls, &stripeCustomerID, &stripeSubscriptionID, &stripeSubscriptionStatus, &stripeSubscriptionInterval, &stripeSubscriptionPaidUntil, &stripeSubscriptionCancelAt, &deleted, &tierID, &tierCode, &tierName, &messagesLimit, &messagesExpiryDuration, &emailsLimit, &smsLimit, &callsLimit, &reservationsLimit, &attachmentFileSizeLimit, &attachmentTotalSizeLimit, &attachmentExpiryDuration, &attachmentBandwidthLimit, &stripeMonthlyPriceID, &stripeYearlyPriceID); err != nil {
  951. return nil, err
  952. } else if err := rows.Err(); err != nil {
  953. return nil, err
  954. }
  955. user := &User{
  956. ID: id,
  957. Name: username,
  958. Hash: hash,
  959. Role: Role(role),
  960. Prefs: &Prefs{},
  961. SyncTopic: syncTopic,
  962. Stats: &Stats{
  963. Messages: messages,
  964. Emails: emails,
  965. SMS: sms,
  966. Calls: calls,
  967. },
  968. Billing: &Billing{
  969. StripeCustomerID: stripeCustomerID.String, // May be empty
  970. StripeSubscriptionID: stripeSubscriptionID.String, // May be empty
  971. StripeSubscriptionStatus: stripe.SubscriptionStatus(stripeSubscriptionStatus.String), // May be empty
  972. StripeSubscriptionInterval: stripe.PriceRecurringInterval(stripeSubscriptionInterval.String), // May be empty
  973. StripeSubscriptionPaidUntil: time.Unix(stripeSubscriptionPaidUntil.Int64, 0), // May be zero
  974. StripeSubscriptionCancelAt: time.Unix(stripeSubscriptionCancelAt.Int64, 0), // May be zero
  975. },
  976. Deleted: deleted.Valid,
  977. }
  978. if err := json.Unmarshal([]byte(prefs), user.Prefs); err != nil {
  979. return nil, err
  980. }
  981. if tierCode.Valid {
  982. // See readTier() when this is changed!
  983. user.Tier = &Tier{
  984. ID: tierID.String,
  985. Code: tierCode.String,
  986. Name: tierName.String,
  987. MessageLimit: messagesLimit.Int64,
  988. MessageExpiryDuration: time.Duration(messagesExpiryDuration.Int64) * time.Second,
  989. EmailLimit: emailsLimit.Int64,
  990. SMSLimit: smsLimit.Int64,
  991. CallLimit: callsLimit.Int64,
  992. ReservationLimit: reservationsLimit.Int64,
  993. AttachmentFileSizeLimit: attachmentFileSizeLimit.Int64,
  994. AttachmentTotalSizeLimit: attachmentTotalSizeLimit.Int64,
  995. AttachmentExpiryDuration: time.Duration(attachmentExpiryDuration.Int64) * time.Second,
  996. AttachmentBandwidthLimit: attachmentBandwidthLimit.Int64,
  997. StripeMonthlyPriceID: stripeMonthlyPriceID.String, // May be empty
  998. StripeYearlyPriceID: stripeYearlyPriceID.String, // May be empty
  999. }
  1000. }
  1001. return user, nil
  1002. }
  1003. // Grants returns all user-specific access control entries
  1004. func (a *Manager) Grants(username string) ([]Grant, error) {
  1005. rows, err := a.db.Query(selectUserAccessQuery, username)
  1006. if err != nil {
  1007. return nil, err
  1008. }
  1009. defer rows.Close()
  1010. grants := make([]Grant, 0)
  1011. for rows.Next() {
  1012. var topic string
  1013. var read, write bool
  1014. if err := rows.Scan(&topic, &read, &write); err != nil {
  1015. return nil, err
  1016. } else if err := rows.Err(); err != nil {
  1017. return nil, err
  1018. }
  1019. grants = append(grants, Grant{
  1020. TopicPattern: fromSQLWildcard(topic),
  1021. Allow: NewPermission(read, write),
  1022. })
  1023. }
  1024. return grants, nil
  1025. }
  1026. // Reservations returns all user-owned topics, and the associated everyone-access
  1027. func (a *Manager) Reservations(username string) ([]Reservation, error) {
  1028. rows, err := a.db.Query(selectUserReservationsQuery, Everyone, username)
  1029. if err != nil {
  1030. return nil, err
  1031. }
  1032. defer rows.Close()
  1033. reservations := make([]Reservation, 0)
  1034. for rows.Next() {
  1035. var topic string
  1036. var ownerRead, ownerWrite bool
  1037. var everyoneRead, everyoneWrite sql.NullBool
  1038. if err := rows.Scan(&topic, &ownerRead, &ownerWrite, &everyoneRead, &everyoneWrite); err != nil {
  1039. return nil, err
  1040. } else if err := rows.Err(); err != nil {
  1041. return nil, err
  1042. }
  1043. reservations = append(reservations, Reservation{
  1044. Topic: topic,
  1045. Owner: NewPermission(ownerRead, ownerWrite),
  1046. Everyone: NewPermission(everyoneRead.Bool, everyoneWrite.Bool), // false if null
  1047. })
  1048. }
  1049. return reservations, nil
  1050. }
  1051. // HasReservation returns true if the given topic access is owned by the user
  1052. func (a *Manager) HasReservation(username, topic string) (bool, error) {
  1053. rows, err := a.db.Query(selectUserHasReservationQuery, username, topic)
  1054. if err != nil {
  1055. return false, err
  1056. }
  1057. defer rows.Close()
  1058. if !rows.Next() {
  1059. return false, errNoRows
  1060. }
  1061. var count int64
  1062. if err := rows.Scan(&count); err != nil {
  1063. return false, err
  1064. }
  1065. return count > 0, nil
  1066. }
  1067. // ReservationsCount returns the number of reservations owned by this user
  1068. func (a *Manager) ReservationsCount(username string) (int64, error) {
  1069. rows, err := a.db.Query(selectUserReservationsCountQuery, username)
  1070. if err != nil {
  1071. return 0, err
  1072. }
  1073. defer rows.Close()
  1074. if !rows.Next() {
  1075. return 0, errNoRows
  1076. }
  1077. var count int64
  1078. if err := rows.Scan(&count); err != nil {
  1079. return 0, err
  1080. }
  1081. return count, nil
  1082. }
  1083. // ReservationOwner returns user ID of the user that owns this topic, or an
  1084. // empty string if it's not owned by anyone
  1085. func (a *Manager) ReservationOwner(topic string) (string, error) {
  1086. rows, err := a.db.Query(selectUserReservationsOwnerQuery, topic)
  1087. if err != nil {
  1088. return "", err
  1089. }
  1090. defer rows.Close()
  1091. if !rows.Next() {
  1092. return "", nil
  1093. }
  1094. var ownerUserID string
  1095. if err := rows.Scan(&ownerUserID); err != nil {
  1096. return "", err
  1097. }
  1098. return ownerUserID, nil
  1099. }
  1100. // ChangePassword changes a user's password
  1101. func (a *Manager) ChangePassword(username, password string) error {
  1102. hash, err := bcrypt.GenerateFromPassword([]byte(password), a.bcryptCost)
  1103. if err != nil {
  1104. return err
  1105. }
  1106. if _, err := a.db.Exec(updateUserPassQuery, hash, username); err != nil {
  1107. return err
  1108. }
  1109. return nil
  1110. }
  1111. // ChangeRole changes a user's role. When a role is changed from RoleUser to RoleAdmin,
  1112. // all existing access control entries (Grant) are removed, since they are no longer needed.
  1113. func (a *Manager) ChangeRole(username string, role Role) error {
  1114. if !AllowedUsername(username) || !AllowedRole(role) {
  1115. return ErrInvalidArgument
  1116. }
  1117. if _, err := a.db.Exec(updateUserRoleQuery, string(role), username); err != nil {
  1118. return err
  1119. }
  1120. if role == RoleAdmin {
  1121. if _, err := a.db.Exec(deleteUserAccessQuery, username, username); err != nil {
  1122. return err
  1123. }
  1124. }
  1125. return nil
  1126. }
  1127. // ChangeTier changes a user's tier using the tier code. This function does not delete reservations, messages,
  1128. // or attachments, even if the new tier has lower limits in this regard. That has to be done elsewhere.
  1129. func (a *Manager) ChangeTier(username, tier string) error {
  1130. if !AllowedUsername(username) {
  1131. return ErrInvalidArgument
  1132. }
  1133. t, err := a.Tier(tier)
  1134. if err != nil {
  1135. return err
  1136. } else if err := a.checkReservationsLimit(username, t.ReservationLimit); err != nil {
  1137. return err
  1138. }
  1139. if _, err := a.db.Exec(updateUserTierQuery, tier, username); err != nil {
  1140. return err
  1141. }
  1142. return nil
  1143. }
  1144. // ResetTier removes the tier from the given user
  1145. func (a *Manager) ResetTier(username string) error {
  1146. if !AllowedUsername(username) && username != Everyone && username != "" {
  1147. return ErrInvalidArgument
  1148. } else if err := a.checkReservationsLimit(username, 0); err != nil {
  1149. return err
  1150. }
  1151. _, err := a.db.Exec(deleteUserTierQuery, username)
  1152. return err
  1153. }
  1154. func (a *Manager) checkReservationsLimit(username string, reservationsLimit int64) error {
  1155. u, err := a.User(username)
  1156. if err != nil {
  1157. return err
  1158. }
  1159. if u.Tier != nil && reservationsLimit < u.Tier.ReservationLimit {
  1160. reservations, err := a.Reservations(username)
  1161. if err != nil {
  1162. return err
  1163. } else if int64(len(reservations)) > reservationsLimit {
  1164. return ErrTooManyReservations
  1165. }
  1166. }
  1167. return nil
  1168. }
  1169. // AllowReservation tests if a user may create an access control entry for the given topic.
  1170. // If there are any ACL entries that are not owned by the user, an error is returned.
  1171. func (a *Manager) AllowReservation(username string, topic string) error {
  1172. if (!AllowedUsername(username) && username != Everyone) || !AllowedTopic(topic) {
  1173. return ErrInvalidArgument
  1174. }
  1175. rows, err := a.db.Query(selectOtherAccessCountQuery, topic, topic, username)
  1176. if err != nil {
  1177. return err
  1178. }
  1179. defer rows.Close()
  1180. if !rows.Next() {
  1181. return errNoRows
  1182. }
  1183. var otherCount int
  1184. if err := rows.Scan(&otherCount); err != nil {
  1185. return err
  1186. }
  1187. if otherCount > 0 {
  1188. return errTopicOwnedByOthers
  1189. }
  1190. return nil
  1191. }
  1192. // AllowAccess adds or updates an entry in th access control list for a specific user. It controls
  1193. // read/write access to a topic. The parameter topicPattern may include wildcards (*). The ACL entry
  1194. // owner may either be a user (username), or the system (empty).
  1195. func (a *Manager) AllowAccess(username string, topicPattern string, permission Permission) error {
  1196. if !AllowedUsername(username) && username != Everyone {
  1197. return ErrInvalidArgument
  1198. } else if !AllowedTopicPattern(topicPattern) {
  1199. return ErrInvalidArgument
  1200. }
  1201. owner := ""
  1202. if _, err := a.db.Exec(upsertUserAccessQuery, username, toSQLWildcard(topicPattern), permission.IsRead(), permission.IsWrite(), owner, owner); err != nil {
  1203. return err
  1204. }
  1205. return nil
  1206. }
  1207. // ResetAccess removes an access control list entry for a specific username/topic, or (if topic is
  1208. // empty) for an entire user. The parameter topicPattern may include wildcards (*).
  1209. func (a *Manager) ResetAccess(username string, topicPattern string) error {
  1210. if !AllowedUsername(username) && username != Everyone && username != "" {
  1211. return ErrInvalidArgument
  1212. } else if !AllowedTopicPattern(topicPattern) && topicPattern != "" {
  1213. return ErrInvalidArgument
  1214. }
  1215. if username == "" && topicPattern == "" {
  1216. _, err := a.db.Exec(deleteAllAccessQuery, username)
  1217. return err
  1218. } else if topicPattern == "" {
  1219. _, err := a.db.Exec(deleteUserAccessQuery, username, username)
  1220. return err
  1221. }
  1222. _, err := a.db.Exec(deleteTopicAccessQuery, username, username, toSQLWildcard(topicPattern))
  1223. return err
  1224. }
  1225. // AddReservation creates two access control entries for the given topic: one with full read/write access for the
  1226. // given user, and one for Everyone with the permission passed as everyone. The user also owns the entries, and
  1227. // can modify or delete them.
  1228. func (a *Manager) AddReservation(username string, topic string, everyone Permission) error {
  1229. if !AllowedUsername(username) || username == Everyone || !AllowedTopic(topic) {
  1230. return ErrInvalidArgument
  1231. }
  1232. tx, err := a.db.Begin()
  1233. if err != nil {
  1234. return err
  1235. }
  1236. defer tx.Rollback()
  1237. if _, err := tx.Exec(upsertUserAccessQuery, username, topic, true, true, username, username); err != nil {
  1238. return err
  1239. }
  1240. if _, err := tx.Exec(upsertUserAccessQuery, Everyone, topic, everyone.IsRead(), everyone.IsWrite(), username, username); err != nil {
  1241. return err
  1242. }
  1243. return tx.Commit()
  1244. }
  1245. // RemoveReservations deletes the access control entries associated with the given username/topic, as
  1246. // well as all entries with Everyone/topic. This is the counterpart for AddReservation.
  1247. func (a *Manager) RemoveReservations(username string, topics ...string) error {
  1248. if !AllowedUsername(username) || username == Everyone || len(topics) == 0 {
  1249. return ErrInvalidArgument
  1250. }
  1251. for _, topic := range topics {
  1252. if !AllowedTopic(topic) {
  1253. return ErrInvalidArgument
  1254. }
  1255. }
  1256. tx, err := a.db.Begin()
  1257. if err != nil {
  1258. return err
  1259. }
  1260. defer tx.Rollback()
  1261. for _, topic := range topics {
  1262. if _, err := tx.Exec(deleteTopicAccessQuery, username, username, topic); err != nil {
  1263. return err
  1264. }
  1265. if _, err := tx.Exec(deleteTopicAccessQuery, Everyone, Everyone, topic); err != nil {
  1266. return err
  1267. }
  1268. }
  1269. return tx.Commit()
  1270. }
  1271. // DefaultAccess returns the default read/write access if no access control entry matches
  1272. func (a *Manager) DefaultAccess() Permission {
  1273. return a.defaultAccess
  1274. }
  1275. // AddTier creates a new tier in the database
  1276. func (a *Manager) AddTier(tier *Tier) error {
  1277. if tier.ID == "" {
  1278. tier.ID = util.RandomStringPrefix(tierIDPrefix, tierIDLength)
  1279. }
  1280. if _, err := a.db.Exec(insertTierQuery, tier.ID, tier.Code, tier.Name, tier.MessageLimit, int64(tier.MessageExpiryDuration.Seconds()), tier.EmailLimit, tier.SMSLimit, tier.CallLimit, tier.ReservationLimit, tier.AttachmentFileSizeLimit, tier.AttachmentTotalSizeLimit, int64(tier.AttachmentExpiryDuration.Seconds()), tier.AttachmentBandwidthLimit, nullString(tier.StripeMonthlyPriceID), nullString(tier.StripeYearlyPriceID)); err != nil {
  1281. return err
  1282. }
  1283. return nil
  1284. }
  1285. // UpdateTier updates a tier's properties in the database
  1286. func (a *Manager) UpdateTier(tier *Tier) error {
  1287. if _, err := a.db.Exec(updateTierQuery, tier.Name, tier.MessageLimit, int64(tier.MessageExpiryDuration.Seconds()), tier.EmailLimit, tier.SMSLimit, tier.CallLimit, tier.ReservationLimit, tier.AttachmentFileSizeLimit, tier.AttachmentTotalSizeLimit, int64(tier.AttachmentExpiryDuration.Seconds()), tier.AttachmentBandwidthLimit, nullString(tier.StripeMonthlyPriceID), nullString(tier.StripeYearlyPriceID), tier.Code); err != nil {
  1288. return err
  1289. }
  1290. return nil
  1291. }
  1292. // RemoveTier deletes the tier with the given code
  1293. func (a *Manager) RemoveTier(code string) error {
  1294. if !AllowedTier(code) {
  1295. return ErrInvalidArgument
  1296. }
  1297. // This fails if any user has this tier
  1298. if _, err := a.db.Exec(deleteTierQuery, code); err != nil {
  1299. return err
  1300. }
  1301. return nil
  1302. }
  1303. // ChangeBilling updates a user's billing fields, namely the Stripe customer ID, and subscription information
  1304. func (a *Manager) ChangeBilling(username string, billing *Billing) error {
  1305. if _, err := a.db.Exec(updateBillingQuery, nullString(billing.StripeCustomerID), nullString(billing.StripeSubscriptionID), nullString(string(billing.StripeSubscriptionStatus)), nullString(string(billing.StripeSubscriptionInterval)), nullInt64(billing.StripeSubscriptionPaidUntil.Unix()), nullInt64(billing.StripeSubscriptionCancelAt.Unix()), username); err != nil {
  1306. return err
  1307. }
  1308. return nil
  1309. }
  1310. // Tiers returns a list of all Tier structs
  1311. func (a *Manager) Tiers() ([]*Tier, error) {
  1312. rows, err := a.db.Query(selectTiersQuery)
  1313. if err != nil {
  1314. return nil, err
  1315. }
  1316. defer rows.Close()
  1317. tiers := make([]*Tier, 0)
  1318. for {
  1319. tier, err := a.readTier(rows)
  1320. if err == ErrTierNotFound {
  1321. break
  1322. } else if err != nil {
  1323. return nil, err
  1324. }
  1325. tiers = append(tiers, tier)
  1326. }
  1327. return tiers, nil
  1328. }
  1329. // Tier returns a Tier based on the code, or ErrTierNotFound if it does not exist
  1330. func (a *Manager) Tier(code string) (*Tier, error) {
  1331. rows, err := a.db.Query(selectTierByCodeQuery, code)
  1332. if err != nil {
  1333. return nil, err
  1334. }
  1335. defer rows.Close()
  1336. return a.readTier(rows)
  1337. }
  1338. // TierByStripePrice returns a Tier based on the Stripe price ID, or ErrTierNotFound if it does not exist
  1339. func (a *Manager) TierByStripePrice(priceID string) (*Tier, error) {
  1340. rows, err := a.db.Query(selectTierByPriceIDQuery, priceID, priceID)
  1341. if err != nil {
  1342. return nil, err
  1343. }
  1344. defer rows.Close()
  1345. return a.readTier(rows)
  1346. }
  1347. func (a *Manager) readTier(rows *sql.Rows) (*Tier, error) {
  1348. var id, code, name string
  1349. var stripeMonthlyPriceID, stripeYearlyPriceID sql.NullString
  1350. var messagesLimit, messagesExpiryDuration, emailsLimit, smsLimit, callsLimit, reservationsLimit, attachmentFileSizeLimit, attachmentTotalSizeLimit, attachmentExpiryDuration, attachmentBandwidthLimit sql.NullInt64
  1351. if !rows.Next() {
  1352. return nil, ErrTierNotFound
  1353. }
  1354. if err := rows.Scan(&id, &code, &name, &messagesLimit, &messagesExpiryDuration, &emailsLimit, &smsLimit, &callsLimit, &reservationsLimit, &attachmentFileSizeLimit, &attachmentTotalSizeLimit, &attachmentExpiryDuration, &attachmentBandwidthLimit, &stripeMonthlyPriceID, &stripeYearlyPriceID); err != nil {
  1355. return nil, err
  1356. } else if err := rows.Err(); err != nil {
  1357. return nil, err
  1358. }
  1359. // When changed, note readUser() as well
  1360. return &Tier{
  1361. ID: id,
  1362. Code: code,
  1363. Name: name,
  1364. MessageLimit: messagesLimit.Int64,
  1365. MessageExpiryDuration: time.Duration(messagesExpiryDuration.Int64) * time.Second,
  1366. EmailLimit: emailsLimit.Int64,
  1367. SMSLimit: smsLimit.Int64,
  1368. CallLimit: callsLimit.Int64,
  1369. ReservationLimit: reservationsLimit.Int64,
  1370. AttachmentFileSizeLimit: attachmentFileSizeLimit.Int64,
  1371. AttachmentTotalSizeLimit: attachmentTotalSizeLimit.Int64,
  1372. AttachmentExpiryDuration: time.Duration(attachmentExpiryDuration.Int64) * time.Second,
  1373. AttachmentBandwidthLimit: attachmentBandwidthLimit.Int64,
  1374. StripeMonthlyPriceID: stripeMonthlyPriceID.String, // May be empty
  1375. StripeYearlyPriceID: stripeYearlyPriceID.String, // May be empty
  1376. }, nil
  1377. }
  1378. // Close closes the underlying database
  1379. func (a *Manager) Close() error {
  1380. return a.db.Close()
  1381. }
  1382. func toSQLWildcard(s string) string {
  1383. return strings.ReplaceAll(s, "*", "%")
  1384. }
  1385. func fromSQLWildcard(s string) string {
  1386. return strings.ReplaceAll(s, "%", "*")
  1387. }
  1388. func runStartupQueries(db *sql.DB, startupQueries string) error {
  1389. if _, err := db.Exec(startupQueries); err != nil {
  1390. return err
  1391. }
  1392. if _, err := db.Exec(builtinStartupQueries); err != nil {
  1393. return err
  1394. }
  1395. return nil
  1396. }
  1397. func setupDB(db *sql.DB) error {
  1398. // If 'schemaVersion' table does not exist, this must be a new database
  1399. rowsSV, err := db.Query(selectSchemaVersionQuery)
  1400. if err != nil {
  1401. return setupNewDB(db)
  1402. }
  1403. defer rowsSV.Close()
  1404. // If 'schemaVersion' table exists, read version and potentially upgrade
  1405. schemaVersion := 0
  1406. if !rowsSV.Next() {
  1407. return errors.New("cannot determine schema version: database file may be corrupt")
  1408. }
  1409. if err := rowsSV.Scan(&schemaVersion); err != nil {
  1410. return err
  1411. }
  1412. rowsSV.Close()
  1413. // Do migrations
  1414. if schemaVersion == currentSchemaVersion {
  1415. return nil
  1416. } else if schemaVersion > currentSchemaVersion {
  1417. return fmt.Errorf("unexpected schema version: version %d is higher than current version %d", schemaVersion, currentSchemaVersion)
  1418. }
  1419. for i := schemaVersion; i < currentSchemaVersion; i++ {
  1420. fn, ok := migrations[i]
  1421. if !ok {
  1422. return fmt.Errorf("cannot find migration step from schema version %d to %d", i, i+1)
  1423. } else if err := fn(db); err != nil {
  1424. return err
  1425. }
  1426. }
  1427. return nil
  1428. }
  1429. func setupNewDB(db *sql.DB) error {
  1430. if _, err := db.Exec(createTablesQueries); err != nil {
  1431. return err
  1432. }
  1433. if _, err := db.Exec(insertSchemaVersion, currentSchemaVersion); err != nil {
  1434. return err
  1435. }
  1436. return nil
  1437. }
  1438. func migrateFrom1(db *sql.DB) error {
  1439. log.Tag(tag).Info("Migrating user database schema: from 1 to 2")
  1440. tx, err := db.Begin()
  1441. if err != nil {
  1442. return err
  1443. }
  1444. defer tx.Rollback()
  1445. // Rename user -> user_old, and create new tables
  1446. if _, err := tx.Exec(migrate1To2CreateTablesQueries); err != nil {
  1447. return err
  1448. }
  1449. // Insert users from user_old into new user table, with ID and sync_topic
  1450. rows, err := tx.Query(migrate1To2SelectAllOldUsernamesNoTx)
  1451. if err != nil {
  1452. return err
  1453. }
  1454. defer rows.Close()
  1455. usernames := make([]string, 0)
  1456. for rows.Next() {
  1457. var username string
  1458. if err := rows.Scan(&username); err != nil {
  1459. return err
  1460. }
  1461. usernames = append(usernames, username)
  1462. }
  1463. if err := rows.Close(); err != nil {
  1464. return err
  1465. }
  1466. for _, username := range usernames {
  1467. userID := util.RandomStringPrefix(userIDPrefix, userIDLength)
  1468. syncTopic := util.RandomStringPrefix(syncTopicPrefix, syncTopicLength)
  1469. if _, err := tx.Exec(migrate1To2InsertUserNoTx, userID, syncTopic, username); err != nil {
  1470. return err
  1471. }
  1472. }
  1473. // Migrate old "access" table to "user_access" and drop "access" and "user_old"
  1474. if _, err := tx.Exec(migrate1To2InsertFromOldTablesAndDropNoTx); err != nil {
  1475. return err
  1476. }
  1477. if _, err := tx.Exec(updateSchemaVersion, 2); err != nil {
  1478. return err
  1479. }
  1480. if err := tx.Commit(); err != nil {
  1481. return err
  1482. }
  1483. return nil
  1484. }
  1485. func migrateFrom2(db *sql.DB) error {
  1486. log.Tag(tag).Info("Migrating user database schema: from 2 to 3")
  1487. tx, err := db.Begin()
  1488. if err != nil {
  1489. return err
  1490. }
  1491. defer tx.Rollback()
  1492. if _, err := tx.Exec(migrate2To3UpdateQueries); err != nil {
  1493. return err
  1494. }
  1495. if _, err := tx.Exec(updateSchemaVersion, 3); err != nil {
  1496. return err
  1497. }
  1498. return tx.Commit()
  1499. }
  1500. func migrateFrom3(db *sql.DB) error {
  1501. log.Tag(tag).Info("Migrating user database schema: from 3 to 4")
  1502. tx, err := db.Begin()
  1503. if err != nil {
  1504. return err
  1505. }
  1506. defer tx.Rollback()
  1507. if _, err := tx.Exec(migrate3To4UpdateQueries); err != nil {
  1508. return err
  1509. }
  1510. if _, err := tx.Exec(updateSchemaVersion, 4); err != nil {
  1511. return err
  1512. }
  1513. return tx.Commit()
  1514. }
  1515. func nullString(s string) sql.NullString {
  1516. if s == "" {
  1517. return sql.NullString{}
  1518. }
  1519. return sql.NullString{String: s, Valid: true}
  1520. }
  1521. func nullInt64(v int64) sql.NullInt64 {
  1522. if v == 0 {
  1523. return sql.NullInt64{}
  1524. }
  1525. return sql.NullInt64{Int64: v, Valid: true}
  1526. }