db.go 23 KB

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