1
0

db.go 23 KB

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