1
0

db.go 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849
  1. // Package database provides database initialization, migration, and management utilities
  2. // for the 3x-ui panel using GORM with SQLite or PostgreSQL.
  3. package database
  4. import (
  5. "bytes"
  6. "encoding/json"
  7. "errors"
  8. "io"
  9. "log"
  10. "math"
  11. "os"
  12. "path"
  13. "slices"
  14. "strconv"
  15. "strings"
  16. "time"
  17. "github.com/mhsanaei/3x-ui/v3/config"
  18. "github.com/mhsanaei/3x-ui/v3/database/model"
  19. "github.com/mhsanaei/3x-ui/v3/util/crypto"
  20. "github.com/mhsanaei/3x-ui/v3/util/random"
  21. "github.com/mhsanaei/3x-ui/v3/xray"
  22. "gorm.io/driver/postgres"
  23. "gorm.io/driver/sqlite"
  24. "gorm.io/gorm"
  25. "gorm.io/gorm/logger"
  26. )
  27. var db *gorm.DB
  28. const (
  29. DialectSQLite = "sqlite"
  30. DialectPostgres = "postgres"
  31. )
  32. // IsPostgres reports whether the active connection is a PostgreSQL backend.
  33. func IsPostgres() bool {
  34. if db == nil {
  35. return config.GetDBKind() == "postgres"
  36. }
  37. return db.Dialector.Name() == "postgres"
  38. }
  39. // Dialect returns the active GORM dialect name, or "" if the DB is not open.
  40. func Dialect() string {
  41. if db == nil {
  42. return ""
  43. }
  44. return db.Dialector.Name()
  45. }
  46. const (
  47. defaultUsername = "admin"
  48. defaultPassword = "admin"
  49. )
  50. func initModels() error {
  51. models := []any{
  52. &model.User{},
  53. &model.Inbound{},
  54. &model.OutboundTraffics{},
  55. &model.Setting{},
  56. &model.InboundClientIps{},
  57. &xray.ClientTraffic{},
  58. &model.HistoryOfSeeders{},
  59. &model.CustomGeoResource{},
  60. &model.Node{},
  61. &model.ApiToken{},
  62. &model.ClientRecord{},
  63. &model.ClientInbound{},
  64. &model.ClientGroup{},
  65. &model.InboundFallback{},
  66. &model.NodeClientTraffic{},
  67. }
  68. for _, mdl := range models {
  69. if err := db.AutoMigrate(mdl); err != nil {
  70. if isIgnorableDuplicateColumnErr(err, mdl) {
  71. log.Printf("Ignoring duplicate column during auto migration for %T: %v", mdl, err)
  72. continue
  73. }
  74. log.Printf("Error auto migrating model: %v", err)
  75. return err
  76. }
  77. }
  78. if err := dropLegacyForeignKeys(); err != nil {
  79. return err
  80. }
  81. if err := pruneOrphanedClientInbounds(); err != nil {
  82. return err
  83. }
  84. if IsPostgres() {
  85. if err := resyncPostgresSequences(db, models); err != nil {
  86. log.Printf("Error resyncing postgres sequences: %v", err)
  87. return err
  88. }
  89. }
  90. return nil
  91. }
  92. func dropLegacyForeignKeys() error {
  93. if !IsPostgres() {
  94. return nil
  95. }
  96. if err := db.Exec("ALTER TABLE client_traffics DROP CONSTRAINT IF EXISTS fk_inbounds_client_stats").Error; err != nil {
  97. log.Printf("Error dropping legacy foreign key fk_inbounds_client_stats: %v", err)
  98. return err
  99. }
  100. return nil
  101. }
  102. func pruneOrphanedClientInbounds() error {
  103. res := db.Exec("DELETE FROM client_inbounds WHERE inbound_id NOT IN (SELECT id FROM inbounds)")
  104. if res.Error != nil {
  105. log.Printf("Error pruning orphaned client_inbounds rows: %v", res.Error)
  106. return res.Error
  107. }
  108. if res.RowsAffected > 0 {
  109. log.Printf("Pruned %d orphaned client_inbounds row(s)", res.RowsAffected)
  110. }
  111. return nil
  112. }
  113. func isIgnorableDuplicateColumnErr(err error, mdl any) bool {
  114. if err == nil {
  115. return false
  116. }
  117. errMsg := strings.ToLower(err.Error())
  118. // SQLite: "duplicate column name: foo"
  119. // Postgres: `pq: column "foo" of relation "bar" already exists` / `sqlstate 42701`
  120. const sqlitePrefix = "duplicate column name:"
  121. if _, after, ok := strings.Cut(errMsg, sqlitePrefix); ok {
  122. col := strings.TrimSpace(after)
  123. col = strings.Trim(col, "`\"[]")
  124. return col != "" && db != nil && db.Migrator().HasColumn(mdl, col)
  125. }
  126. if strings.Contains(errMsg, "already exists") && strings.Contains(errMsg, "column ") {
  127. // Best effort: extract the column name between the first pair of double quotes.
  128. if _, after, ok := strings.Cut(errMsg, "column \""); ok {
  129. rest := after
  130. if e := strings.Index(rest, "\""); e > 0 {
  131. col := rest[:e]
  132. return col != "" && db != nil && db.Migrator().HasColumn(mdl, col)
  133. }
  134. }
  135. }
  136. return false
  137. }
  138. // initUser creates a default admin user if the users table is empty.
  139. func initUser() error {
  140. empty, err := isTableEmpty("users")
  141. if err != nil {
  142. log.Printf("Error checking if users table is empty: %v", err)
  143. return err
  144. }
  145. if empty {
  146. hashedPassword, err := crypto.HashPasswordAsBcrypt(defaultPassword)
  147. if err != nil {
  148. log.Printf("Error hashing default password: %v", err)
  149. return err
  150. }
  151. user := &model.User{
  152. Username: defaultUsername,
  153. Password: hashedPassword,
  154. }
  155. return db.Create(user).Error
  156. }
  157. return nil
  158. }
  159. // runSeeders migrates user passwords to bcrypt and records seeder execution to prevent re-running.
  160. func runSeeders(isUsersEmpty bool) error {
  161. empty, err := isTableEmpty("history_of_seeders")
  162. if err != nil {
  163. log.Printf("Error checking if users table is empty: %v", err)
  164. return err
  165. }
  166. if empty && isUsersEmpty {
  167. seeders := []string{"UserPasswordHash", "ClientsTable", "InboundClientsArrayFix", "InboundClientTgIdFix", "InboundClientSubIdFix", "FreedomFinalRulesReverseFix", "ApiTokensHash"}
  168. for _, name := range seeders {
  169. if err := db.Create(&model.HistoryOfSeeders{SeederName: name}).Error; err != nil {
  170. return err
  171. }
  172. }
  173. return seedApiTokens()
  174. }
  175. var seedersHistory []string
  176. if err := db.Model(&model.HistoryOfSeeders{}).Pluck("seeder_name", &seedersHistory).Error; err != nil {
  177. log.Printf("Error fetching seeder history: %v", err)
  178. return err
  179. }
  180. if !slices.Contains(seedersHistory, "UserPasswordHash") && !isUsersEmpty {
  181. var users []model.User
  182. if err := db.Find(&users).Error; err != nil {
  183. log.Printf("Error fetching users for password migration: %v", err)
  184. return err
  185. }
  186. for _, user := range users {
  187. if crypto.IsHashed(user.Password) {
  188. continue
  189. }
  190. hashedPassword, err := crypto.HashPasswordAsBcrypt(user.Password)
  191. if err != nil {
  192. log.Printf("Error hashing password for user '%s': %v", user.Username, err)
  193. return err
  194. }
  195. if err := db.Model(&user).Update("password", hashedPassword).Error; err != nil {
  196. log.Printf("Error updating password for user '%s': %v", user.Username, err)
  197. return err
  198. }
  199. }
  200. hashSeeder := &model.HistoryOfSeeders{
  201. SeederName: "UserPasswordHash",
  202. }
  203. if err := db.Create(hashSeeder).Error; err != nil {
  204. return err
  205. }
  206. }
  207. if !slices.Contains(seedersHistory, "ApiTokensTable") {
  208. if err := seedApiTokens(); err != nil {
  209. return err
  210. }
  211. }
  212. if !slices.Contains(seedersHistory, "ApiTokensHash") {
  213. if err := hashExistingApiTokens(); err != nil {
  214. return err
  215. }
  216. }
  217. if !slices.Contains(seedersHistory, "ClientsTable") {
  218. if err := seedClientsFromInboundJSON(); err != nil {
  219. return err
  220. }
  221. }
  222. if !slices.Contains(seedersHistory, "InboundClientsArrayFix") {
  223. if err := normalizeInboundClientsArray(); err != nil {
  224. return err
  225. }
  226. }
  227. if !slices.Contains(seedersHistory, "InboundClientTgIdFix") {
  228. if err := normalizeInboundClientTgId(); err != nil {
  229. return err
  230. }
  231. }
  232. if !slices.Contains(seedersHistory, "InboundClientSubIdFix") {
  233. if err := normalizeInboundClientSubId(); err != nil {
  234. return err
  235. }
  236. }
  237. if !slices.Contains(seedersHistory, "FreedomFinalRulesReverseFix") {
  238. if err := normalizeFreedomFinalRules(); err != nil {
  239. return err
  240. }
  241. }
  242. return nil
  243. }
  244. func normalizeInboundClientTgId() error {
  245. var inbounds []model.Inbound
  246. if err := db.Find(&inbounds).Error; err != nil {
  247. return err
  248. }
  249. return db.Transaction(func(tx *gorm.DB) error {
  250. for _, inbound := range inbounds {
  251. if strings.TrimSpace(inbound.Settings) == "" {
  252. continue
  253. }
  254. var settings map[string]any
  255. if err := json.Unmarshal([]byte(inbound.Settings), &settings); err != nil {
  256. log.Printf("InboundClientTgIdFix: skip inbound %d (invalid settings json): %v", inbound.Id, err)
  257. continue
  258. }
  259. clients, ok := settings["clients"].([]any)
  260. if !ok {
  261. continue
  262. }
  263. mutated := false
  264. for i, raw := range clients {
  265. obj, ok := raw.(map[string]any)
  266. if !ok {
  267. continue
  268. }
  269. tgRaw, present := obj["tgId"]
  270. if !present {
  271. continue
  272. }
  273. v, isFloat := tgRaw.(float64)
  274. if isFloat && !math.IsNaN(v) && !math.IsInf(v, 0) && v == math.Trunc(v) {
  275. continue
  276. }
  277. obj["tgId"] = int64(0)
  278. clients[i] = obj
  279. mutated = true
  280. }
  281. if !mutated {
  282. continue
  283. }
  284. settings["clients"] = clients
  285. newSettings, err := json.MarshalIndent(settings, "", " ")
  286. if err != nil {
  287. log.Printf("InboundClientTgIdFix: skip inbound %d (marshal failed): %v", inbound.Id, err)
  288. continue
  289. }
  290. if err := tx.Model(&model.Inbound{}).Where("id = ?", inbound.Id).
  291. Update("settings", string(newSettings)).Error; err != nil {
  292. return err
  293. }
  294. }
  295. return tx.Create(&model.HistoryOfSeeders{SeederName: "InboundClientTgIdFix"}).Error
  296. })
  297. }
  298. func normalizeInboundClientSubId() error {
  299. var inbounds []model.Inbound
  300. if err := db.Find(&inbounds).Error; err != nil {
  301. return err
  302. }
  303. return db.Transaction(func(tx *gorm.DB) error {
  304. for _, inbound := range inbounds {
  305. if strings.TrimSpace(inbound.Settings) == "" {
  306. continue
  307. }
  308. var settings map[string]any
  309. if err := json.Unmarshal([]byte(inbound.Settings), &settings); err != nil {
  310. log.Printf("InboundClientSubIdFix: skip inbound %d (invalid settings json): %v", inbound.Id, err)
  311. continue
  312. }
  313. clients, ok := settings["clients"].([]any)
  314. if !ok {
  315. continue
  316. }
  317. mutated := false
  318. for i, raw := range clients {
  319. obj, ok := raw.(map[string]any)
  320. if !ok {
  321. continue
  322. }
  323. existing, _ := obj["subId"].(string)
  324. if strings.TrimSpace(existing) != "" {
  325. continue
  326. }
  327. obj["subId"] = random.NumLower(16)
  328. clients[i] = obj
  329. mutated = true
  330. }
  331. if !mutated {
  332. continue
  333. }
  334. settings["clients"] = clients
  335. newSettings, err := json.MarshalIndent(settings, "", " ")
  336. if err != nil {
  337. log.Printf("InboundClientSubIdFix: skip inbound %d (marshal failed): %v", inbound.Id, err)
  338. continue
  339. }
  340. if err := tx.Model(&model.Inbound{}).Where("id = ?", inbound.Id).
  341. Update("settings", string(newSettings)).Error; err != nil {
  342. return err
  343. }
  344. }
  345. return tx.Create(&model.HistoryOfSeeders{SeederName: "InboundClientSubIdFix"}).Error
  346. })
  347. }
  348. func normalizeInboundClientsArray() error {
  349. var inbounds []model.Inbound
  350. if err := db.Find(&inbounds).Error; err != nil {
  351. return err
  352. }
  353. return db.Transaction(func(tx *gorm.DB) error {
  354. for _, inbound := range inbounds {
  355. if strings.TrimSpace(inbound.Settings) == "" {
  356. continue
  357. }
  358. var settings map[string]any
  359. if err := json.Unmarshal([]byte(inbound.Settings), &settings); err != nil {
  360. log.Printf("InboundClientsArrayFix: skip inbound %d (invalid settings json): %v", inbound.Id, err)
  361. continue
  362. }
  363. raw, exists := settings["clients"]
  364. if !exists || raw != nil {
  365. continue
  366. }
  367. settings["clients"] = []any{}
  368. newSettings, err := json.MarshalIndent(settings, "", " ")
  369. if err != nil {
  370. log.Printf("InboundClientsArrayFix: skip inbound %d (marshal failed): %v", inbound.Id, err)
  371. continue
  372. }
  373. if err := tx.Model(&model.Inbound{}).Where("id = ?", inbound.Id).
  374. Update("settings", string(newSettings)).Error; err != nil {
  375. return err
  376. }
  377. }
  378. return tx.Create(&model.HistoryOfSeeders{SeederName: "InboundClientsArrayFix"}).Error
  379. })
  380. }
  381. func normalizeFreedomFinalRules() error {
  382. var setting model.Setting
  383. err := db.Model(model.Setting{}).Where("key = ?", "xrayTemplateConfig").First(&setting).Error
  384. if errors.Is(err, gorm.ErrRecordNotFound) {
  385. return db.Create(&model.HistoryOfSeeders{SeederName: "FreedomFinalRulesReverseFix"}).Error
  386. }
  387. if err != nil {
  388. return err
  389. }
  390. updated, changed, rErr := rewriteFreedomFinalRules(setting.Value)
  391. if rErr != nil {
  392. log.Printf("FreedomFinalRulesReverseFix: skip (invalid xrayTemplateConfig json): %v", rErr)
  393. return db.Create(&model.HistoryOfSeeders{SeederName: "FreedomFinalRulesReverseFix"}).Error
  394. }
  395. return db.Transaction(func(tx *gorm.DB) error {
  396. if changed {
  397. if err := tx.Model(&model.Setting{}).Where("key = ?", "xrayTemplateConfig").
  398. Update("value", updated).Error; err != nil {
  399. return err
  400. }
  401. }
  402. return tx.Create(&model.HistoryOfSeeders{SeederName: "FreedomFinalRulesReverseFix"}).Error
  403. })
  404. }
  405. func rewriteFreedomFinalRules(raw string) (string, bool, error) {
  406. if strings.TrimSpace(raw) == "" {
  407. return raw, false, nil
  408. }
  409. var cfg map[string]any
  410. if err := json.Unmarshal([]byte(raw), &cfg); err != nil {
  411. return raw, false, err
  412. }
  413. outbounds, ok := cfg["outbounds"].([]any)
  414. if !ok {
  415. return raw, false, nil
  416. }
  417. changed := false
  418. for _, ob := range outbounds {
  419. obj, ok := ob.(map[string]any)
  420. if !ok {
  421. continue
  422. }
  423. if proto, _ := obj["protocol"].(string); proto != "freedom" {
  424. continue
  425. }
  426. settings, ok := obj["settings"].(map[string]any)
  427. if !ok {
  428. continue
  429. }
  430. if !isLegacyPrivateOnlyFinalRules(settings["finalRules"]) {
  431. continue
  432. }
  433. settings["finalRules"] = []any{map[string]any{"action": "allow"}}
  434. changed = true
  435. }
  436. if !changed {
  437. return raw, false, nil
  438. }
  439. out, err := json.MarshalIndent(cfg, "", " ")
  440. if err != nil {
  441. return raw, false, err
  442. }
  443. return string(out), true, nil
  444. }
  445. func isLegacyPrivateOnlyFinalRules(v any) bool {
  446. rules, ok := v.([]any)
  447. if !ok || len(rules) != 1 {
  448. return false
  449. }
  450. rule, ok := rules[0].(map[string]any)
  451. if !ok {
  452. return false
  453. }
  454. if action, _ := rule["action"].(string); action != "allow" {
  455. return false
  456. }
  457. ips, ok := rule["ip"].([]any)
  458. if !ok || len(ips) != 1 {
  459. return false
  460. }
  461. if s, _ := ips[0].(string); s != "geoip:private" {
  462. return false
  463. }
  464. for k := range rule {
  465. if k != "action" && k != "ip" {
  466. return false
  467. }
  468. }
  469. return true
  470. }
  471. // normalizeClientJSONFields coerces loosely-typed numeric fields in a raw
  472. // settings.clients entry so json.Unmarshal into model.Client doesn't fail
  473. // when older rows wrote tgId/limitIp/totalGB/etc. as strings. Empty strings
  474. // drop the key so the field falls back to its zero value.
  475. func normalizeClientJSONFields(obj map[string]any) {
  476. normalizeInt := func(key string) {
  477. raw, exists := obj[key]
  478. if !exists {
  479. return
  480. }
  481. s, ok := raw.(string)
  482. if !ok {
  483. return
  484. }
  485. trimmed := strings.ReplaceAll(strings.TrimSpace(s), " ", "")
  486. if trimmed == "" {
  487. delete(obj, key)
  488. return
  489. }
  490. if n, err := strconv.ParseInt(trimmed, 10, 64); err == nil {
  491. obj[key] = n
  492. } else {
  493. delete(obj, key)
  494. }
  495. }
  496. for _, k := range []string{"tgId", "limitIp", "totalGB", "expiryTime", "reset", "created_at", "updated_at"} {
  497. normalizeInt(k)
  498. }
  499. }
  500. func seedClientsFromInboundJSON() error {
  501. var inbounds []model.Inbound
  502. if err := db.Find(&inbounds).Error; err != nil {
  503. return err
  504. }
  505. return db.Transaction(func(tx *gorm.DB) error {
  506. byEmail := map[string]*model.ClientRecord{}
  507. var existing []model.ClientRecord
  508. if err := tx.Find(&existing).Error; err != nil {
  509. return err
  510. }
  511. for i := range existing {
  512. byEmail[existing[i].Email] = &existing[i]
  513. }
  514. for _, inbound := range inbounds {
  515. if strings.TrimSpace(inbound.Settings) == "" {
  516. continue
  517. }
  518. var settings map[string]any
  519. if err := json.Unmarshal([]byte(inbound.Settings), &settings); err != nil {
  520. log.Printf("ClientsTable seed: skip inbound %d (invalid settings json): %v", inbound.Id, err)
  521. continue
  522. }
  523. rawList, ok := settings["clients"].([]any)
  524. if !ok {
  525. continue
  526. }
  527. for _, raw := range rawList {
  528. obj, ok := raw.(map[string]any)
  529. if !ok {
  530. continue
  531. }
  532. normalizeClientJSONFields(obj)
  533. blob, err := json.Marshal(obj)
  534. if err != nil {
  535. continue
  536. }
  537. var c model.Client
  538. if err := json.Unmarshal(blob, &c); err != nil {
  539. log.Printf("ClientsTable seed: skip client in inbound %d (unmarshal failed): %v; payload=%s",
  540. inbound.Id, err, string(blob))
  541. continue
  542. }
  543. email := strings.TrimSpace(c.Email)
  544. if email == "" {
  545. continue
  546. }
  547. incoming := c.ToRecord()
  548. row, dup := byEmail[email]
  549. if !dup {
  550. if err := tx.Create(incoming).Error; err != nil {
  551. return err
  552. }
  553. byEmail[email] = incoming
  554. row = incoming
  555. } else {
  556. conflicts := model.MergeClientRecord(row, incoming)
  557. for _, x := range conflicts {
  558. log.Printf("client merge: email=%s conflict on %s old=%v new=%v kept=%v",
  559. email, x.Field, x.Old, x.New, x.Kept)
  560. }
  561. if err := tx.Save(row).Error; err != nil {
  562. return err
  563. }
  564. }
  565. link := model.ClientInbound{
  566. ClientId: row.Id,
  567. InboundId: inbound.Id,
  568. FlowOverride: c.Flow,
  569. }
  570. if err := tx.Where("client_id = ? AND inbound_id = ?", row.Id, inbound.Id).
  571. FirstOrCreate(&link).Error; err != nil {
  572. return err
  573. }
  574. }
  575. }
  576. return tx.Create(&model.HistoryOfSeeders{SeederName: "ClientsTable"}).Error
  577. })
  578. }
  579. // seedApiTokens copies the legacy `apiToken` setting into the new
  580. // api_tokens table as a row named "default" so existing central panels
  581. // keep working after the upgrade. Idempotent — records itself in
  582. // history_of_seeders and only runs when api_tokens is empty.
  583. func seedApiTokens() error {
  584. empty, err := isTableEmpty("api_tokens")
  585. if err != nil {
  586. return err
  587. }
  588. if empty {
  589. var legacy model.Setting
  590. err := db.Model(model.Setting{}).Where("key = ?", "apiToken").First(&legacy).Error
  591. if err == nil && legacy.Value != "" {
  592. row := &model.ApiToken{
  593. Name: "default",
  594. Token: legacy.Value,
  595. Enabled: true,
  596. }
  597. if err := db.Create(row).Error; err != nil {
  598. log.Printf("Error migrating legacy apiToken: %v", err)
  599. return err
  600. }
  601. }
  602. }
  603. return db.Create(&model.HistoryOfSeeders{SeederName: "ApiTokensTable"}).Error
  604. }
  605. // hashExistingApiTokens replaces any plaintext token stored before tokens were
  606. // hashed at rest with its SHA-256 digest. Callers keep their plaintext copy
  607. // (used on remote nodes), so existing tokens keep authenticating; the panel
  608. // just can no longer reveal them. Idempotent — already-hashed rows are skipped.
  609. func hashExistingApiTokens() error {
  610. var rows []*model.ApiToken
  611. if err := db.Find(&rows).Error; err != nil {
  612. return err
  613. }
  614. for _, r := range rows {
  615. if crypto.IsSHA256Hex(r.Token) {
  616. continue
  617. }
  618. hashed := crypto.HashTokenSHA256(r.Token)
  619. if err := db.Model(model.ApiToken{}).Where("id = ?", r.Id).Update("token", hashed).Error; err != nil {
  620. log.Printf("Error hashing api token %d: %v", r.Id, err)
  621. return err
  622. }
  623. }
  624. return db.Create(&model.HistoryOfSeeders{SeederName: "ApiTokensHash"}).Error
  625. }
  626. // isTableEmpty returns true if the named table contains zero rows.
  627. func isTableEmpty(tableName string) (bool, error) {
  628. var count int64
  629. err := db.Table(tableName).Count(&count).Error
  630. return count == 0, err
  631. }
  632. // InitDB sets up the database connection, migrates models, and runs seeders.
  633. // When XUI_DB_TYPE=postgres, dbPath is ignored and XUI_DB_DSN is used instead.
  634. func InitDB(dbPath string) error {
  635. var gormLogger logger.Interface
  636. if config.IsDebug() {
  637. gormLogger = logger.New(
  638. log.New(os.Stdout, "\r\n", log.LstdFlags),
  639. logger.Config{
  640. SlowThreshold: time.Second,
  641. LogLevel: logger.Info,
  642. IgnoreRecordNotFoundError: true,
  643. Colorful: true,
  644. },
  645. )
  646. } else {
  647. gormLogger = logger.Discard
  648. }
  649. c := &gorm.Config{Logger: gormLogger, DisableForeignKeyConstraintWhenMigrating: true}
  650. var err error
  651. switch config.GetDBKind() {
  652. case "postgres":
  653. dsn := config.GetDBDSN()
  654. if dsn == "" {
  655. return errors.New("XUI_DB_TYPE=postgres but XUI_DB_DSN is empty")
  656. }
  657. db, err = gorm.Open(postgres.Open(dsn), c)
  658. if err != nil {
  659. return err
  660. }
  661. default:
  662. dir := path.Dir(dbPath)
  663. if err = os.MkdirAll(dir, 0755); err != nil {
  664. return err
  665. }
  666. dsn := dbPath + "?_journal_mode=WAL&_busy_timeout=10000&_synchronous=NORMAL&_txlock=immediate"
  667. db, err = gorm.Open(sqlite.Open(dsn), c)
  668. if err != nil {
  669. return err
  670. }
  671. sqlDB, err := db.DB()
  672. if err != nil {
  673. return err
  674. }
  675. if _, err := sqlDB.Exec("PRAGMA journal_mode=WAL"); err != nil {
  676. return err
  677. }
  678. if _, err := sqlDB.Exec("PRAGMA busy_timeout=10000"); err != nil {
  679. return err
  680. }
  681. if _, err := sqlDB.Exec("PRAGMA synchronous=NORMAL"); err != nil {
  682. return err
  683. }
  684. }
  685. sqlDB, err := db.DB()
  686. if err != nil {
  687. return err
  688. }
  689. var maxOpen, maxIdle int
  690. switch config.GetDBKind() {
  691. case "postgres":
  692. maxOpen = envInt("XUI_DB_MAX_OPEN_CONNS", 25)
  693. maxIdle = envInt("XUI_DB_MAX_IDLE_CONNS", 25)
  694. default:
  695. maxOpen = envInt("XUI_DB_MAX_OPEN_CONNS", 8)
  696. maxIdle = envInt("XUI_DB_MAX_IDLE_CONNS", 4)
  697. }
  698. sqlDB.SetMaxOpenConns(maxOpen)
  699. sqlDB.SetMaxIdleConns(maxIdle)
  700. sqlDB.SetConnMaxLifetime(time.Hour)
  701. sqlDB.SetConnMaxIdleTime(30 * time.Minute)
  702. if err := initModels(); err != nil {
  703. return err
  704. }
  705. isUsersEmpty, err := isTableEmpty("users")
  706. if err != nil {
  707. return err
  708. }
  709. if err := initUser(); err != nil {
  710. return err
  711. }
  712. return runSeeders(isUsersEmpty)
  713. }
  714. func envInt(key string, def int) int {
  715. v := strings.TrimSpace(os.Getenv(key))
  716. if v == "" {
  717. return def
  718. }
  719. n, err := strconv.Atoi(v)
  720. if err != nil || n <= 0 {
  721. return def
  722. }
  723. return n
  724. }
  725. // CloseDB closes the database connection if it exists.
  726. func CloseDB() error {
  727. if db != nil {
  728. sqlDB, err := db.DB()
  729. if err != nil {
  730. return err
  731. }
  732. return sqlDB.Close()
  733. }
  734. return nil
  735. }
  736. // GetDB returns the global GORM database instance.
  737. func GetDB() *gorm.DB {
  738. return db
  739. }
  740. func IsNotFound(err error) bool {
  741. return errors.Is(err, gorm.ErrRecordNotFound)
  742. }
  743. // IsSQLiteDB checks if the given file is a valid SQLite database by reading its signature.
  744. func IsSQLiteDB(file io.ReaderAt) (bool, error) {
  745. signature := []byte("SQLite format 3\x00")
  746. buf := make([]byte, len(signature))
  747. _, err := file.ReadAt(buf, 0)
  748. if err != nil {
  749. return false, err
  750. }
  751. return bytes.Equal(buf, signature), nil
  752. }
  753. // Checkpoint performs a WAL checkpoint on the SQLite database to ensure data consistency.
  754. // No-op on PostgreSQL (WAL there is managed by the server).
  755. func Checkpoint() error {
  756. if IsPostgres() {
  757. return nil
  758. }
  759. return db.Exec("PRAGMA wal_checkpoint;").Error
  760. }
  761. // ValidateSQLiteDB opens the provided sqlite DB path with a throw-away connection
  762. // and runs a PRAGMA integrity_check to ensure the file is structurally sound.
  763. // It does not mutate global state or run migrations.
  764. func ValidateSQLiteDB(dbPath string) error {
  765. if _, err := os.Stat(dbPath); err != nil { // file must exist
  766. return err
  767. }
  768. gdb, err := gorm.Open(sqlite.Open(dbPath), &gorm.Config{Logger: logger.Discard})
  769. if err != nil {
  770. return err
  771. }
  772. sqlDB, err := gdb.DB()
  773. if err != nil {
  774. return err
  775. }
  776. defer sqlDB.Close()
  777. var res string
  778. if err := gdb.Raw("PRAGMA integrity_check;").Scan(&res).Error; err != nil {
  779. return err
  780. }
  781. if res != "ok" {
  782. return errors.New("sqlite integrity check failed: " + res)
  783. }
  784. return nil
  785. }