db.go 23 KB

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