db.go 71 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578
  1. package database
  2. import (
  3. "bytes"
  4. "context"
  5. "database/sql"
  6. "encoding/json"
  7. "errors"
  8. "fmt"
  9. "io"
  10. "log"
  11. "math"
  12. "os"
  13. "os/exec"
  14. "path"
  15. "path/filepath"
  16. "runtime"
  17. "slices"
  18. "strconv"
  19. "strings"
  20. "time"
  21. "github.com/mhsanaei/3x-ui/v3/internal/config"
  22. "github.com/mhsanaei/3x-ui/v3/internal/database/model"
  23. "github.com/mhsanaei/3x-ui/v3/internal/util/crypto"
  24. "github.com/mhsanaei/3x-ui/v3/internal/util/random"
  25. "github.com/mhsanaei/3x-ui/v3/internal/xray"
  26. "github.com/mattn/go-sqlite3"
  27. "gorm.io/driver/postgres"
  28. "gorm.io/driver/sqlite"
  29. "gorm.io/gorm"
  30. "gorm.io/gorm/logger"
  31. )
  32. var db *gorm.DB
  33. var backupSQLiteTimeout = 2 * time.Minute
  34. const (
  35. DialectSQLite = "sqlite"
  36. DialectPostgres = "postgres"
  37. )
  38. func IsPostgres() bool {
  39. if db == nil {
  40. return config.GetDBKind() == "postgres"
  41. }
  42. return db.Name() == "postgres"
  43. }
  44. func Dialect() string {
  45. if db == nil {
  46. return ""
  47. }
  48. return db.Name()
  49. }
  50. const (
  51. defaultUsername = "admin"
  52. defaultPassword = "admin"
  53. sqliteBackupDirPrefix = ".x-ui-backup-"
  54. )
  55. func allModels() []any {
  56. return []any{
  57. &model.User{},
  58. &model.Inbound{},
  59. &model.OutboundTraffics{},
  60. &model.Setting{},
  61. &model.InboundClientIps{},
  62. &xray.ClientTraffic{},
  63. &model.HistoryOfSeeders{},
  64. &model.Node{},
  65. &model.ApiToken{},
  66. &model.ClientRecord{},
  67. &model.ClientInbound{},
  68. &model.ClientHwid{},
  69. &model.ClientExternalLink{},
  70. &model.ClientGroup{},
  71. &model.InboundFallback{},
  72. &model.Host{},
  73. &model.NodeClientTraffic{},
  74. &model.NodeClientIp{},
  75. &model.ClientGlobalTraffic{},
  76. &model.OutboundSubscription{},
  77. &model.SubBalancer{},
  78. }
  79. }
  80. func migrateClientTrafficLastSubFetchColumn() error {
  81. migrator := db.Migrator()
  82. if !migrator.HasTable(&xray.ClientTraffic{}) || migrator.HasColumn(&xray.ClientTraffic{}, "last_sub_fetch") {
  83. return nil
  84. }
  85. return migrator.AddColumn(&xray.ClientTraffic{}, "LastSubFetch")
  86. }
  87. func initModels() error {
  88. if err := migrateClientTrafficLastSubFetchColumn(); err != nil {
  89. return err
  90. }
  91. models := allModels()
  92. for _, mdl := range models {
  93. if IsPostgres() && postgresModelSettled(mdl) {
  94. continue
  95. }
  96. if err := db.AutoMigrate(mdl); err != nil {
  97. if isIgnorableDuplicateColumnErr(db, err, mdl) {
  98. log.Printf("Ignoring duplicate column during auto migration for %T: %v", mdl, err)
  99. continue
  100. }
  101. log.Printf("Error auto migrating model: %v", err)
  102. return err
  103. }
  104. }
  105. if err := dropLegacyInboundPortUnique(); err != nil {
  106. return err
  107. }
  108. if err := migrateHostVerifyPeerCertByNameColumn(); err != nil {
  109. return err
  110. }
  111. if err := normalizeApiTokenCreatedAtSeconds(); err != nil {
  112. return err
  113. }
  114. if err := migrateApiTokenScopeAndExpiry(); err != nil {
  115. return err
  116. }
  117. if err := dropLegacyForeignKeys(); err != nil {
  118. return err
  119. }
  120. if err := pruneOrphanedClientInbounds(); err != nil {
  121. return err
  122. }
  123. if err := pruneOrphanedHosts(); err != nil {
  124. return err
  125. }
  126. if err := normalizeInboundSubSortIndex(); err != nil {
  127. return err
  128. }
  129. if err := normalizeClientExternalLinkEnable(); err != nil {
  130. return err
  131. }
  132. if err := normalizeClientExternalLinkTimestamps(); err != nil {
  133. return err
  134. }
  135. if err := repairOverflowedTrafficCounters(); err != nil {
  136. return err
  137. }
  138. if err := dedupeInboundSettingsClients(); err != nil {
  139. return err
  140. }
  141. if err := migrateLegacySocksInboundsToMixed(); err != nil {
  142. return err
  143. }
  144. if err := migrateShadowsocksRemovedCiphers(); err != nil {
  145. return err
  146. }
  147. if err := migrateVmessRemovedSecurities(); err != nil {
  148. return err
  149. }
  150. if err := migrateTgIDIndex(); err != nil {
  151. return err
  152. }
  153. if err := migrateClientTrafficResetColumns(); err != nil {
  154. return err
  155. }
  156. if err := migrateSyncOrphanColumns(); err != nil {
  157. return err
  158. }
  159. if err := migrateClientEmailLowerIndex(); err != nil {
  160. return err
  161. }
  162. if IsPostgres() {
  163. if err := resyncPostgresSequences(db, models); err != nil {
  164. log.Printf("Error resyncing postgres sequences: %v", err)
  165. return err
  166. }
  167. }
  168. return nil
  169. }
  170. func postgresModelSettled(mdl any) bool {
  171. migrator := db.Migrator()
  172. if !migrator.HasTable(mdl) {
  173. return false
  174. }
  175. stmt := &gorm.Statement{DB: db}
  176. if err := stmt.Parse(mdl); err != nil || stmt.Schema == nil {
  177. return false
  178. }
  179. for _, dbName := range stmt.Schema.DBNames {
  180. if !migrator.HasColumn(mdl, dbName) {
  181. return false
  182. }
  183. }
  184. for _, idx := range stmt.Schema.ParseIndexes() {
  185. if !migrator.HasIndex(mdl, idx.Name) {
  186. return false
  187. }
  188. }
  189. return true
  190. }
  191. func dropLegacyForeignKeys() error {
  192. if !IsPostgres() {
  193. return nil
  194. }
  195. if err := db.Exec("ALTER TABLE client_traffics DROP CONSTRAINT IF EXISTS fk_inbounds_client_stats").Error; err != nil {
  196. log.Printf("Error dropping legacy foreign key fk_inbounds_client_stats: %v", err)
  197. return err
  198. }
  199. return nil
  200. }
  201. type sqliteIndexListRow struct {
  202. Name string `gorm:"column:name"`
  203. Unique int `gorm:"column:unique"`
  204. Origin string `gorm:"column:origin"`
  205. }
  206. func sqliteUniquePortIndexes() (autoIndexes, explicitIndexes []string, err error) {
  207. var list []sqliteIndexListRow
  208. if err = db.Raw(`PRAGMA index_list('inbounds')`).Scan(&list).Error; err != nil {
  209. return nil, nil, err
  210. }
  211. for _, idx := range list {
  212. if idx.Unique != 1 {
  213. continue
  214. }
  215. var cols []struct {
  216. Name string `gorm:"column:name"`
  217. }
  218. if err = db.Raw(`PRAGMA index_info("` + idx.Name + `")`).Scan(&cols).Error; err != nil {
  219. return nil, nil, err
  220. }
  221. if len(cols) != 1 || cols[0].Name != "port" {
  222. continue
  223. }
  224. if idx.Origin == "c" {
  225. explicitIndexes = append(explicitIndexes, idx.Name)
  226. } else {
  227. autoIndexes = append(autoIndexes, idx.Name)
  228. }
  229. }
  230. return autoIndexes, explicitIndexes, nil
  231. }
  232. // dropLegacyInboundPortUnique removes the pre-multi-node UNIQUE on inbounds.port,
  233. // which AutoMigrate never drops and which blocks cross-node port reuse on old SQLite DBs.
  234. func dropLegacyInboundPortUnique() error {
  235. if IsPostgres() {
  236. return nil
  237. }
  238. autoIndexes, explicitIndexes, err := sqliteUniquePortIndexes()
  239. if err != nil {
  240. return err
  241. }
  242. for _, name := range explicitIndexes {
  243. if err := db.Exec(`DROP INDEX IF EXISTS "` + name + `"`).Error; err != nil {
  244. return err
  245. }
  246. }
  247. if len(autoIndexes) == 0 {
  248. return nil
  249. }
  250. log.Printf("Rebuilding inbounds table to drop the legacy UNIQUE constraint on port")
  251. return rebuildInboundsWithoutInlineUniquePort()
  252. }
  253. func sqliteTableColumns(tx *gorm.DB, table string) ([]string, error) {
  254. var rows []struct {
  255. Name string `gorm:"column:name"`
  256. }
  257. if err := tx.Raw(`PRAGMA table_info("` + table + `")`).Scan(&rows).Error; err != nil {
  258. return nil, err
  259. }
  260. cols := make([]string, 0, len(rows))
  261. for _, r := range rows {
  262. cols = append(cols, r.Name)
  263. }
  264. return cols, nil
  265. }
  266. func rebuildInboundsWithoutInlineUniquePort() error {
  267. return db.Transaction(func(tx *gorm.DB) error {
  268. var list []sqliteIndexListRow
  269. if err := tx.Raw(`PRAGMA index_list('inbounds')`).Scan(&list).Error; err != nil {
  270. return err
  271. }
  272. for _, idx := range list {
  273. if idx.Origin != "c" {
  274. continue
  275. }
  276. if err := tx.Exec(`DROP INDEX IF EXISTS "` + idx.Name + `"`).Error; err != nil {
  277. return err
  278. }
  279. }
  280. if err := tx.Exec(`ALTER TABLE inbounds RENAME TO inbounds_legacy_rebuild`).Error; err != nil {
  281. return err
  282. }
  283. if err := tx.Migrator().CreateTable(&model.Inbound{}); err != nil {
  284. return err
  285. }
  286. newCols, err := sqliteTableColumns(tx, "inbounds")
  287. if err != nil {
  288. return err
  289. }
  290. oldCols, err := sqliteTableColumns(tx, "inbounds_legacy_rebuild")
  291. if err != nil {
  292. return err
  293. }
  294. oldSet := make(map[string]struct{}, len(oldCols))
  295. for _, c := range oldCols {
  296. oldSet[c] = struct{}{}
  297. }
  298. shared := make([]string, 0, len(newCols))
  299. for _, c := range newCols {
  300. if _, ok := oldSet[c]; ok {
  301. shared = append(shared, `"`+c+`"`)
  302. }
  303. }
  304. colList := strings.Join(shared, ", ")
  305. if err := tx.Exec(`INSERT INTO inbounds (` + colList + `) SELECT ` + colList + ` FROM inbounds_legacy_rebuild`).Error; err != nil {
  306. return err
  307. }
  308. return tx.Exec(`DROP TABLE inbounds_legacy_rebuild`).Error
  309. })
  310. }
  311. // AutoMigrate adds the columns; an older SQLite ALTER TABLE leaves them NULL,
  312. // and a NULL traffic_reset fails every ClientRecord scan, not just the new query.
  313. func migrateClientTrafficResetColumns() error {
  314. if db.Migrator().HasColumn(&model.ClientRecord{}, "traffic_reset") {
  315. if err := db.Exec("UPDATE clients SET traffic_reset = 'never' WHERE traffic_reset IS NULL").Error; err != nil {
  316. return err
  317. }
  318. }
  319. if db.Migrator().HasColumn(&model.ClientRecord{}, "traffic_reset_day") {
  320. if err := db.Exec("UPDATE clients SET traffic_reset_day = 1 WHERE traffic_reset_day IS NULL").Error; err != nil {
  321. return err
  322. }
  323. }
  324. return nil
  325. }
  326. // AutoMigrate adds the column; this only backfills the NULLs an older SQLite
  327. // ALTER TABLE leaves behind, so the reaper's predicate never compares to NULL.
  328. func migrateSyncOrphanColumns() error {
  329. if !db.Migrator().HasColumn(&model.ClientRecord{}, "sync_orphaned_at") {
  330. return nil
  331. }
  332. return db.Exec("UPDATE clients SET sync_orphaned_at = 0 WHERE sync_orphaned_at IS NULL").Error
  333. }
  334. // The client identity checks match emails case-insensitively; without an
  335. // expression index (which no GORM struct tag can declare) they seq-scan.
  336. func migrateClientEmailLowerIndex() error {
  337. if db.Migrator().HasIndex(&model.ClientRecord{}, "idx_clients_email_lower") {
  338. return nil
  339. }
  340. return db.Exec("CREATE INDEX IF NOT EXISTS idx_clients_email_lower ON clients (LOWER(email))").Error
  341. }
  342. func migrateHostVerifyPeerCertByNameColumn() error {
  343. if !db.Migrator().HasColumn(&model.Host{}, "verify_peer_cert_by_name") {
  344. return nil
  345. }
  346. if IsPostgres() {
  347. var dataType string
  348. if err := db.Raw(
  349. `SELECT data_type FROM information_schema.columns WHERE table_name = 'hosts' AND column_name = 'verify_peer_cert_by_name'`,
  350. ).Scan(&dataType).Error; err != nil {
  351. return err
  352. }
  353. if dataType != "boolean" {
  354. return nil
  355. }
  356. if err := db.Exec(`ALTER TABLE hosts ALTER COLUMN verify_peer_cert_by_name DROP DEFAULT`).Error; err != nil {
  357. return err
  358. }
  359. return db.Exec(`ALTER TABLE hosts ALTER COLUMN verify_peer_cert_by_name TYPE text USING ''`).Error
  360. }
  361. return db.Exec(`UPDATE hosts SET verify_peer_cert_by_name = '' WHERE verify_peer_cert_by_name IS NULL OR typeof(verify_peer_cert_by_name) <> 'text'`).Error
  362. }
  363. func seedHostsFromExternalProxy() error {
  364. var history []string
  365. if err := db.Model(&model.HistoryOfSeeders{}).Pluck("seeder_name", &history).Error; err != nil {
  366. return err
  367. }
  368. if slices.Contains(history, "HostsFromExternalProxy") {
  369. return nil
  370. }
  371. var inbounds []model.Inbound
  372. if err := db.Find(&inbounds).Error; err != nil {
  373. return err
  374. }
  375. return db.Transaction(func(tx *gorm.DB) error {
  376. for _, inbound := range inbounds {
  377. if _, err := CreateHostsFromExternalProxy(tx, inbound.Id, inbound.StreamSettings); err != nil {
  378. return err
  379. }
  380. }
  381. return tx.Create(&model.HistoryOfSeeders{SeederName: "HostsFromExternalProxy"}).Error
  382. })
  383. }
  384. func seedMtprotoCustomShareAddrToHosts() error {
  385. const seederName = "MtprotoCustomShareAddrToHosts"
  386. var count int64
  387. if err := db.Model(&model.HistoryOfSeeders{}).Where("seeder_name = ?", seederName).Count(&count).Error; err != nil {
  388. return err
  389. }
  390. if count > 0 {
  391. return nil
  392. }
  393. return db.Transaction(func(tx *gorm.DB) error {
  394. var inbounds []model.Inbound
  395. if err := tx.Where("protocol = ? AND TRIM(COALESCE(share_addr_strategy, '')) = ?", string(model.MTProto), "custom").Find(&inbounds).Error; err != nil {
  396. return err
  397. }
  398. for _, inbound := range inbounds {
  399. if err := CreateHostFromMtprotoCustomShareAddr(tx, inbound.Id, inbound.ShareAddr); err != nil {
  400. return err
  401. }
  402. if err := tx.Model(&model.Inbound{}).Where("id = ?", inbound.Id).Updates(map[string]any{
  403. "share_addr_strategy": "listen",
  404. "share_addr": "",
  405. }).Error; err != nil {
  406. return err
  407. }
  408. }
  409. return tx.Create(&model.HistoryOfSeeders{SeederName: seederName}).Error
  410. })
  411. }
  412. func CreateHostFromMtprotoCustomShareAddr(tx *gorm.DB, inboundId int, rawAddress string) error {
  413. address := strings.TrimPrefix(strings.TrimSuffix(strings.TrimSpace(rawAddress), "]"), "[")
  414. if address == "" {
  415. return nil
  416. }
  417. var sameAddress []model.Host
  418. if err := tx.Where("inbound_id = ? AND address = ? AND is_disabled = ?", inboundId, address, false).
  419. Find(&sameAddress).Error; err != nil {
  420. return err
  421. }
  422. for _, host := range sameAddress {
  423. if !slices.Contains(host.ExcludeFromSubTypes, "raw") {
  424. return nil
  425. }
  426. }
  427. return tx.Create(&model.Host{
  428. GroupId: random.NumLower(16), InboundId: inboundId,
  429. Remark: address, Address: address, Security: "same",
  430. }).Error
  431. }
  432. func seedWireguardPeersToClients() error {
  433. var history []string
  434. if err := db.Model(&model.HistoryOfSeeders{}).Pluck("seeder_name", &history).Error; err != nil {
  435. return err
  436. }
  437. if slices.Contains(history, "WireguardPeersToClients") {
  438. return nil
  439. }
  440. var inbounds []model.Inbound
  441. if err := db.Where("protocol = ?", string(model.WireGuard)).Find(&inbounds).Error; err != nil {
  442. return err
  443. }
  444. return db.Transaction(func(tx *gorm.DB) error {
  445. usedEmails := map[string]struct{}{}
  446. var existingEmails []string
  447. if err := tx.Model(&model.ClientRecord{}).Pluck("email", &existingEmails).Error; err != nil {
  448. return err
  449. }
  450. for _, e := range existingEmails {
  451. usedEmails[e] = struct{}{}
  452. }
  453. for _, inbound := range inbounds {
  454. if strings.TrimSpace(inbound.Settings) == "" {
  455. continue
  456. }
  457. var settings map[string]any
  458. if err := json.Unmarshal([]byte(inbound.Settings), &settings); err != nil {
  459. log.Printf("WireguardPeersToClients: skip inbound %d (invalid settings json): %v", inbound.Id, err)
  460. continue
  461. }
  462. peers, ok := settings["peers"].([]any)
  463. if !ok || len(peers) == 0 {
  464. continue
  465. }
  466. var linkCount int64
  467. if err := tx.Model(&model.ClientInbound{}).Where("inbound_id = ?", inbound.Id).Count(&linkCount).Error; err != nil {
  468. return err
  469. }
  470. if linkCount > 0 {
  471. continue
  472. }
  473. clientObjs := make([]any, 0, len(peers))
  474. for i, raw := range peers {
  475. obj, ok := raw.(map[string]any)
  476. if !ok {
  477. continue
  478. }
  479. email := wireguardPeerEmail(inbound.Remark, obj, i, usedEmails)
  480. usedEmails[email] = struct{}{}
  481. obj["email"] = email
  482. if sub, _ := obj["subId"].(string); strings.TrimSpace(sub) == "" {
  483. obj["subId"] = random.NumLower(16)
  484. }
  485. if _, ok := obj["enable"]; !ok {
  486. obj["enable"] = true
  487. }
  488. blob, err := json.Marshal(obj)
  489. if err != nil {
  490. continue
  491. }
  492. var c model.Client
  493. if err := json.Unmarshal(blob, &c); err != nil {
  494. log.Printf("WireguardPeersToClients: skip peer in inbound %d: %v", inbound.Id, err)
  495. continue
  496. }
  497. c.Email = email
  498. incoming := c.ToRecord()
  499. var row model.ClientRecord
  500. err = tx.Where("email = ?", email).First(&row).Error
  501. if errors.Is(err, gorm.ErrRecordNotFound) {
  502. if err := tx.Create(incoming).Error; err != nil {
  503. return err
  504. }
  505. row = *incoming
  506. } else if err != nil {
  507. return err
  508. } else {
  509. model.MergeClientRecord(&row, incoming)
  510. if err := tx.Save(&row).Error; err != nil {
  511. return err
  512. }
  513. }
  514. link := model.ClientInbound{ClientId: row.Id, InboundId: inbound.Id}
  515. if err := tx.Where("client_id = ? AND inbound_id = ?", row.Id, inbound.Id).
  516. FirstOrCreate(&link).Error; err != nil {
  517. return err
  518. }
  519. clientObjs = append(clientObjs, obj)
  520. }
  521. delete(settings, "peers")
  522. settings["clients"] = clientObjs
  523. newSettings, err := json.Marshal(settings)
  524. if err != nil {
  525. return err
  526. }
  527. if err := tx.Model(&model.Inbound{}).Where("id = ?", inbound.Id).
  528. Update("settings", string(newSettings)).Error; err != nil {
  529. return err
  530. }
  531. }
  532. return tx.Create(&model.HistoryOfSeeders{SeederName: "WireguardPeersToClients"}).Error
  533. })
  534. }
  535. func wireguardPeerEmail(remark string, peer map[string]any, index int, used map[string]struct{}) string {
  536. base := strings.TrimSpace(remark)
  537. if base == "" {
  538. base = "wg"
  539. }
  540. suffix := strconv.Itoa(index + 1)
  541. if c, ok := peer["comment"].(string); ok && strings.TrimSpace(c) != "" {
  542. suffix = strings.TrimSpace(c)
  543. }
  544. email := strings.ReplaceAll(base+"-"+suffix, " ", "-")
  545. candidate := email
  546. for n := 2; ; n++ {
  547. if _, taken := used[candidate]; !taken {
  548. return candidate
  549. }
  550. candidate = email + "-" + strconv.Itoa(n)
  551. }
  552. }
  553. // seedMtprotoSecretsToClients converts each legacy single-secret mtproto inbound
  554. // into a one-client inbound so MTProto joins the shared multi-client model: the
  555. // inbound-level secret becomes the first client's FakeTLS secret, and a
  556. // ClientRecord + client_inbounds link are created so per-client traffic, limits,
  557. // and share links work exactly like every other protocol. One-time, self-gated
  558. // on the "MtprotoSecretsToClients" seeder row. Mirrors seedWireguardPeersToClients.
  559. func seedMtprotoSecretsToClients() error {
  560. var history []string
  561. if err := db.Model(&model.HistoryOfSeeders{}).Pluck("seeder_name", &history).Error; err != nil {
  562. return err
  563. }
  564. if slices.Contains(history, "MtprotoSecretsToClients") {
  565. return nil
  566. }
  567. var inbounds []model.Inbound
  568. if err := db.Where("protocol = ?", string(model.MTProto)).Find(&inbounds).Error; err != nil {
  569. return err
  570. }
  571. return db.Transaction(func(tx *gorm.DB) error {
  572. usedEmails := map[string]struct{}{}
  573. var existingEmails []string
  574. if err := tx.Model(&model.ClientRecord{}).Pluck("email", &existingEmails).Error; err != nil {
  575. return err
  576. }
  577. for _, e := range existingEmails {
  578. usedEmails[e] = struct{}{}
  579. }
  580. for _, inbound := range inbounds {
  581. if strings.TrimSpace(inbound.Settings) == "" {
  582. continue
  583. }
  584. var settings map[string]any
  585. if err := json.Unmarshal([]byte(inbound.Settings), &settings); err != nil {
  586. log.Printf("MtprotoSecretsToClients: skip inbound %d (invalid settings json): %v", inbound.Id, err)
  587. continue
  588. }
  589. if clients, ok := settings["clients"].([]any); ok && len(clients) > 0 {
  590. continue
  591. }
  592. var linkCount int64
  593. if err := tx.Model(&model.ClientInbound{}).Where("inbound_id = ?", inbound.Id).Count(&linkCount).Error; err != nil {
  594. return err
  595. }
  596. if linkCount > 0 {
  597. continue
  598. }
  599. secret, _ := settings["secret"].(string)
  600. secret = strings.TrimSpace(secret)
  601. if secret == "" {
  602. domain, _ := settings["fakeTlsDomain"].(string)
  603. secret = model.GenerateFakeTLSSecret(strings.TrimSpace(domain))
  604. }
  605. email := mtprotoInboundClientEmail(inbound.Remark, usedEmails)
  606. usedEmails[email] = struct{}{}
  607. obj := map[string]any{
  608. "email": email,
  609. "secret": secret,
  610. "enable": true,
  611. "subId": random.NumLower(16),
  612. }
  613. c := model.Client{Email: email, Secret: secret, Enable: true, SubID: obj["subId"].(string)}
  614. incoming := c.ToRecord()
  615. var row model.ClientRecord
  616. err := tx.Where("email = ?", email).First(&row).Error
  617. if errors.Is(err, gorm.ErrRecordNotFound) {
  618. if err := tx.Create(incoming).Error; err != nil {
  619. return err
  620. }
  621. row = *incoming
  622. } else if err != nil {
  623. return err
  624. } else {
  625. model.MergeClientRecord(&row, incoming)
  626. if err := tx.Save(&row).Error; err != nil {
  627. return err
  628. }
  629. }
  630. link := model.ClientInbound{ClientId: row.Id, InboundId: inbound.Id}
  631. if err := tx.Where("client_id = ? AND inbound_id = ?", row.Id, inbound.Id).
  632. FirstOrCreate(&link).Error; err != nil {
  633. return err
  634. }
  635. delete(settings, "secret")
  636. settings["clients"] = []any{obj}
  637. newSettings, err := json.Marshal(settings)
  638. if err != nil {
  639. return err
  640. }
  641. if err := tx.Model(&model.Inbound{}).Where("id = ?", inbound.Id).
  642. Update("settings", string(newSettings)).Error; err != nil {
  643. return err
  644. }
  645. }
  646. return tx.Create(&model.HistoryOfSeeders{SeederName: "MtprotoSecretsToClients"}).Error
  647. })
  648. }
  649. // stripMtprotoInboundSecrets removes the vestigial inbound-level `secret` from
  650. // every mtproto inbound. seedMtprotoSecretsToClients already drops it while
  651. // converting legacy single-secret inbounds, but inbounds that already had clients
  652. // kept the dead field, and the old HealMtprotoSecret regenerated it on every
  653. // save. mtg and every share link read only per-client secrets, so the
  654. // inbound-level value is dead data that once leaked into stale, unusable links.
  655. // One-time, self-gated on the "StripMtprotoInboundSecrets" seeder row.
  656. func stripMtprotoInboundSecrets() error {
  657. var history []string
  658. if err := db.Model(&model.HistoryOfSeeders{}).Pluck("seeder_name", &history).Error; err != nil {
  659. return err
  660. }
  661. if slices.Contains(history, "StripMtprotoInboundSecrets") {
  662. return nil
  663. }
  664. var inbounds []model.Inbound
  665. if err := db.Where("protocol = ?", string(model.MTProto)).Find(&inbounds).Error; err != nil {
  666. return err
  667. }
  668. return db.Transaction(func(tx *gorm.DB) error {
  669. for _, inbound := range inbounds {
  670. stripped, ok := model.StripMtprotoInboundSecret(inbound.Settings)
  671. if !ok {
  672. continue
  673. }
  674. if err := tx.Model(&model.Inbound{}).Where("id = ?", inbound.Id).
  675. Update("settings", stripped).Error; err != nil {
  676. return err
  677. }
  678. }
  679. return tx.Create(&model.HistoryOfSeeders{SeederName: "StripMtprotoInboundSecrets"}).Error
  680. })
  681. }
  682. // mtprotoInboundClientEmail derives a stable, unique client email for a migrated
  683. // mtproto inbound from its remark.
  684. func mtprotoInboundClientEmail(remark string, used map[string]struct{}) string {
  685. base := strings.TrimSpace(remark)
  686. if base == "" {
  687. base = "mtproto"
  688. }
  689. email := strings.ReplaceAll(base, " ", "-")
  690. candidate := email
  691. for n := 2; ; n++ {
  692. if _, taken := used[candidate]; !taken {
  693. return candidate
  694. }
  695. candidate = email + "-" + strconv.Itoa(n)
  696. }
  697. }
  698. // CreateHostsFromExternalProxy parses a legacy streamSettings.externalProxy array
  699. // and inserts one Host row per entry on tx, returning the number of rows created.
  700. // It is the shared core of both the one-time seedHostsFromExternalProxy startup
  701. // migration and the inbound-import path: an inbound exported from a build that
  702. // predated the hosts table carries its external proxies inline in
  703. // streamSettings.externalProxy, and the startup migration is gated off after its
  704. // first run, so a freshly imported inbound must be converted here instead. Blank
  705. // or malformed streamSettings, or one without externalProxy entries, is a no-op.
  706. func CreateHostsFromExternalProxy(tx *gorm.DB, inboundId int, streamSettings string) (int, error) {
  707. if strings.TrimSpace(streamSettings) == "" {
  708. return 0, nil
  709. }
  710. var stream map[string]any
  711. if err := json.Unmarshal([]byte(streamSettings), &stream); err != nil {
  712. return 0, nil
  713. }
  714. eps, ok := stream["externalProxy"].([]any)
  715. if !ok || len(eps) == 0 {
  716. return 0, nil
  717. }
  718. created := 0
  719. for i, raw := range eps {
  720. ep, ok := raw.(map[string]any)
  721. if !ok {
  722. continue
  723. }
  724. if err := tx.Create(externalProxyEntryToHost(inboundId, i, ep)).Error; err != nil {
  725. return created, err
  726. }
  727. created++
  728. }
  729. return created, nil
  730. }
  731. func externalProxyEntryToHost(inboundId, index int, ep map[string]any) *model.Host {
  732. security, _ := ep["forceTls"].(string)
  733. switch security {
  734. case "same", "tls", "none":
  735. default:
  736. security = "same"
  737. }
  738. dest, _ := ep["dest"].(string)
  739. port := 0
  740. if p, ok := ep["port"].(float64); ok {
  741. port = int(p)
  742. }
  743. remark, _ := ep["remark"].(string)
  744. if strings.TrimSpace(remark) == "" {
  745. remark = "imported " + strconv.Itoa(index+1)
  746. }
  747. if len(remark) > 256 {
  748. remark = remark[:256]
  749. }
  750. sni, _ := ep["sni"].(string)
  751. fingerprint, _ := ep["fingerprint"].(string)
  752. ech, _ := ep["echConfigList"].(string)
  753. return &model.Host{
  754. GroupId: random.NumLower(16),
  755. InboundId: inboundId,
  756. SortOrder: index,
  757. Remark: remark,
  758. Address: dest,
  759. Port: port,
  760. Security: security,
  761. Sni: sni,
  762. Fingerprint: fingerprint,
  763. Alpn: anyToNonEmptyStrings(ep["alpn"]),
  764. PinnedPeerCertSha256: anyToNonEmptyStrings(ep["pinnedPeerCertSha256"]),
  765. EchConfigList: ech,
  766. }
  767. }
  768. func anyToNonEmptyStrings(v any) []string {
  769. switch t := v.(type) {
  770. case []any:
  771. out := make([]string, 0, len(t))
  772. for _, e := range t {
  773. if s, ok := e.(string); ok && s != "" {
  774. out = append(out, s)
  775. }
  776. }
  777. return out
  778. case []string:
  779. out := make([]string, 0, len(t))
  780. for _, s := range t {
  781. if s != "" {
  782. out = append(out, s)
  783. }
  784. }
  785. return out
  786. default:
  787. return nil
  788. }
  789. }
  790. func pruneOrphanedHosts() error {
  791. res := db.Exec("DELETE FROM hosts WHERE inbound_id NOT IN (SELECT id FROM inbounds)")
  792. if res.Error != nil {
  793. log.Printf("Error pruning orphaned hosts rows: %v", res.Error)
  794. return res.Error
  795. }
  796. if res.RowsAffected > 0 {
  797. log.Printf("Pruned %d orphaned hosts row(s)", res.RowsAffected)
  798. }
  799. return nil
  800. }
  801. func pruneOrphanedClientInbounds() error {
  802. res := db.Exec("DELETE FROM client_inbounds WHERE inbound_id NOT IN (SELECT id FROM inbounds)")
  803. if res.Error != nil {
  804. log.Printf("Error pruning orphaned client_inbounds rows: %v", res.Error)
  805. return res.Error
  806. }
  807. if res.RowsAffected > 0 {
  808. log.Printf("Pruned %d orphaned client_inbounds row(s)", res.RowsAffected)
  809. }
  810. return nil
  811. }
  812. // migrateLegacySocksInboundsToMixed renames legacy socks inbounds to mixed.
  813. // The protocol enum dropped socks in favor of mixed (identical settings shape,
  814. // same behavior plus HTTP on the shared port), so rows predating the rename
  815. // fail model validation — most visibly when pushed to a node, where one legacy
  816. // inbound stalled the entire node's config and traffic sync (#5685).
  817. func migrateLegacySocksInboundsToMixed() error {
  818. res := db.Exec("UPDATE inbounds SET protocol = 'mixed' WHERE protocol = 'socks'")
  819. if res.Error != nil {
  820. log.Printf("Error migrating legacy socks inbounds to mixed: %v", res.Error)
  821. return res.Error
  822. }
  823. if res.RowsAffected > 0 {
  824. log.Printf("Migrated %d legacy socks inbound(s) to mixed", res.RowsAffected)
  825. }
  826. return nil
  827. }
  828. // migrateShadowsocksRemovedCiphers rewrites shadowsocks inbounds still using
  829. // the "none"/"plain" ciphers that xray-core v26.7.11 removed; one such row
  830. // makes the whole generated config unbuildable and keeps xray from starting.
  831. func migrateShadowsocksRemovedCiphers() error {
  832. var inbounds []model.Inbound
  833. if err := db.Where("protocol = ?", model.Shadowsocks).Find(&inbounds).Error; err != nil {
  834. return err
  835. }
  836. migrated := int64(0)
  837. for _, inbound := range inbounds {
  838. if strings.TrimSpace(inbound.Settings) == "" {
  839. continue
  840. }
  841. var settings map[string]any
  842. if err := json.Unmarshal([]byte(inbound.Settings), &settings); err != nil {
  843. continue
  844. }
  845. changed := false
  846. if method, _ := settings["method"].(string); method != "" {
  847. if replacement, removed := model.ReplaceRemovedShadowsocksCipher(method); removed {
  848. settings["method"] = replacement
  849. changed = true
  850. }
  851. }
  852. if clients, ok := settings["clients"].([]any); ok {
  853. for i := range clients {
  854. cm, ok := clients[i].(map[string]any)
  855. if !ok {
  856. continue
  857. }
  858. method, _ := cm["method"].(string)
  859. if replacement, removed := model.ReplaceRemovedShadowsocksCipher(method); removed {
  860. cm["method"] = replacement
  861. clients[i] = cm
  862. changed = true
  863. }
  864. }
  865. }
  866. if !changed {
  867. continue
  868. }
  869. newSettings, err := json.MarshalIndent(settings, "", " ")
  870. if err != nil {
  871. log.Printf("migrateShadowsocksRemovedCiphers: skip inbound %d (marshal failed): %v", inbound.Id, err)
  872. continue
  873. }
  874. if err := db.Model(&model.Inbound{}).Where("id = ?", inbound.Id).
  875. Update("settings", string(newSettings)).Error; err != nil {
  876. return err
  877. }
  878. migrated++
  879. }
  880. if migrated > 0 {
  881. log.Printf("Rewrote removed shadowsocks cipher on %d inbound(s)", migrated)
  882. }
  883. return nil
  884. }
  885. // migrateVmessRemovedSecurities rewrites the vmess "none"/"zero" security
  886. // values that xray-core v26.7.11 removed to "auto" (what the core now treats
  887. // them as), on both the clients column and each vmess inbound's settings.
  888. func migrateVmessRemovedSecurities() error {
  889. res := db.Exec("UPDATE clients SET security = 'auto' WHERE security IN ('none', 'zero')")
  890. if res.Error != nil {
  891. log.Printf("Error migrating removed vmess security values on clients: %v", res.Error)
  892. return res.Error
  893. }
  894. if res.RowsAffected > 0 {
  895. log.Printf("Migrated %d client(s) off removed vmess security values", res.RowsAffected)
  896. }
  897. var inbounds []model.Inbound
  898. if err := db.Where("protocol = ?", model.VMESS).Find(&inbounds).Error; err != nil {
  899. return err
  900. }
  901. migrated := int64(0)
  902. for _, inbound := range inbounds {
  903. if strings.TrimSpace(inbound.Settings) == "" {
  904. continue
  905. }
  906. var settings map[string]any
  907. if err := json.Unmarshal([]byte(inbound.Settings), &settings); err != nil {
  908. continue
  909. }
  910. clients, ok := settings["clients"].([]any)
  911. if !ok {
  912. continue
  913. }
  914. changed := false
  915. for i := range clients {
  916. cm, ok := clients[i].(map[string]any)
  917. if !ok {
  918. continue
  919. }
  920. if security, _ := cm["security"].(string); security == "none" || security == "zero" {
  921. cm["security"] = "auto"
  922. clients[i] = cm
  923. changed = true
  924. }
  925. }
  926. if !changed {
  927. continue
  928. }
  929. newSettings, err := json.MarshalIndent(settings, "", " ")
  930. if err != nil {
  931. log.Printf("migrateVmessRemovedSecurities: skip inbound %d (marshal failed): %v", inbound.Id, err)
  932. continue
  933. }
  934. if err := db.Model(&model.Inbound{}).Where("id = ?", inbound.Id).
  935. Update("settings", string(newSettings)).Error; err != nil {
  936. return err
  937. }
  938. migrated++
  939. }
  940. if migrated > 0 {
  941. log.Printf("Rewrote removed vmess security values on %d inbound(s)", migrated)
  942. }
  943. return nil
  944. }
  945. // migrateTgIDIndex creates an index on the clients.tg_id column so that
  946. // lookups by Telegram ID do not require a full table scan. The index tag
  947. // on the struct field already causes AutoMigrate to create it on new
  948. // installations; the explicit migration ensures existing databases get it.
  949. func migrateTgIDIndex() error {
  950. if db.Migrator().HasIndex(&model.ClientRecord{}, "idx_clients_tg_id") {
  951. return nil
  952. }
  953. return db.Migrator().CreateIndex(&model.ClientRecord{}, "TgID")
  954. }
  955. // normalizeInboundSubSortIndex lifts sub_sort_index values below the 1-based
  956. // minimum (rows written by builds that defaulted the column to 0, or by nodes
  957. // predating the field) so they cannot sort ahead of explicitly ranked inbounds.
  958. func normalizeInboundSubSortIndex() error {
  959. res := db.Exec("UPDATE inbounds SET sub_sort_index = 1 WHERE sub_sort_index < 1")
  960. if res.Error != nil {
  961. log.Printf("Error normalizing inbound sub_sort_index: %v", res.Error)
  962. return res.Error
  963. }
  964. if res.RowsAffected > 0 {
  965. log.Printf("Normalized sub_sort_index on %d inbound(s)", res.RowsAffected)
  966. }
  967. return nil
  968. }
  969. // normalizeClientExternalLinkEnable keeps external-link rows written before the
  970. // enable column existed enabled; disabled rows from newer builds stay false.
  971. func normalizeClientExternalLinkEnable() error {
  972. res := db.Exec("UPDATE client_external_links SET enable = ? WHERE enable IS NULL", true)
  973. if res.Error != nil {
  974. log.Printf("Error normalizing client external link enable: %v", res.Error)
  975. return res.Error
  976. }
  977. if res.RowsAffected > 0 {
  978. log.Printf("Normalized enable on %d client external link(s)", res.RowsAffected)
  979. }
  980. return nil
  981. }
  982. // normalizeClientExternalLinkTimestamps zeroes the NULLs an older build could
  983. // leave behind, so the sub-side expiry predicate never drops a legacy row.
  984. func normalizeClientExternalLinkTimestamps() error {
  985. res := db.Exec("UPDATE client_external_links SET expiry_time = 0 WHERE expiry_time IS NULL")
  986. if res.Error != nil {
  987. log.Printf("Error normalizing client external link expiry_time: %v", res.Error)
  988. return res.Error
  989. }
  990. expiryRows := res.RowsAffected
  991. res = db.Exec("UPDATE client_external_links SET last_fetch_at = 0 WHERE last_fetch_at IS NULL")
  992. if res.Error != nil {
  993. log.Printf("Error normalizing client external link last_fetch_at: %v", res.Error)
  994. return res.Error
  995. }
  996. if expiryRows+res.RowsAffected > 0 {
  997. log.Printf("Normalized timestamps on %d client external link(s)", expiryRows+res.RowsAffected)
  998. }
  999. return nil
  1000. }
  1001. // repairOverflowedTrafficCounters heals traffic counters that historic
  1002. // compounding bugs pushed past int64: on SQLite an overflowing INTEGER is
  1003. // silently promoted to REAL, after which the column no longer scans into the
  1004. // Go int64 field and every reader of the table fails (#5762). REAL cells are
  1005. // cast back to INTEGER (SQLite caps the cast at math.MaxInt64), then values
  1006. // are clamped into [0, TrafficMax] on both backends so the next delta cannot
  1007. // overflow again.
  1008. func repairOverflowedTrafficCounters() error {
  1009. targets := []struct {
  1010. table string
  1011. columns []string
  1012. }{
  1013. {"client_traffics", []string{"up", "down"}},
  1014. {"inbounds", []string{"up", "down"}},
  1015. {"outbound_traffics", []string{"up", "down", "total"}},
  1016. {"node_client_traffics", []string{"up", "down"}},
  1017. }
  1018. for _, target := range targets {
  1019. for _, col := range target.columns {
  1020. statements := []string{
  1021. fmt.Sprintf("UPDATE %s SET %s = %d WHERE %s > %d", target.table, col, TrafficMax, col, TrafficMax),
  1022. fmt.Sprintf("UPDATE %s SET %s = 0 WHERE %s < 0", target.table, col, col),
  1023. }
  1024. if !IsPostgres() {
  1025. statements = append([]string{
  1026. fmt.Sprintf("UPDATE %s SET %s = CAST(%s AS INTEGER) WHERE typeof(%s) = 'real'", target.table, col, col, col),
  1027. }, statements...)
  1028. }
  1029. var repaired int64
  1030. for _, statement := range statements {
  1031. res := db.Exec(statement)
  1032. if res.Error != nil {
  1033. log.Printf("Error repairing %s.%s: %v", target.table, col, res.Error)
  1034. return res.Error
  1035. }
  1036. repaired += res.RowsAffected
  1037. }
  1038. if repaired > 0 {
  1039. log.Printf("Repaired %d overflowed %s.%s value(s)", repaired, target.table, col)
  1040. }
  1041. }
  1042. }
  1043. return nil
  1044. }
  1045. // dedupeInboundSettingsClients collapses duplicate same-email entries inside
  1046. // every inbound's settings.clients array, keeping the first occurrence.
  1047. // Retried or raced multi-node client adds on older builds appended the same
  1048. // client several times (#5770), which the client lists then rendered as
  1049. // phantom duplicates. Runs on every start (idempotent, writes only changed
  1050. // rows) because a restored backup or a not-yet-upgraded node's snapshot can
  1051. // reintroduce duplicates.
  1052. func dedupeInboundSettingsClients() error {
  1053. var inbounds []model.Inbound
  1054. if err := db.Find(&inbounds).Error; err != nil {
  1055. return err
  1056. }
  1057. repaired := int64(0)
  1058. for _, inbound := range inbounds {
  1059. if strings.TrimSpace(inbound.Settings) == "" {
  1060. continue
  1061. }
  1062. var settings map[string]any
  1063. if err := json.Unmarshal([]byte(inbound.Settings), &settings); err != nil {
  1064. continue
  1065. }
  1066. clients, _ := settings["clients"].([]any)
  1067. if len(clients) < 2 {
  1068. continue
  1069. }
  1070. seen := make(map[string]struct{}, len(clients))
  1071. kept := make([]any, 0, len(clients))
  1072. for _, c := range clients {
  1073. if cm, ok := c.(map[string]any); ok {
  1074. if email, _ := cm["email"].(string); email != "" {
  1075. key := strings.ToLower(email)
  1076. if _, dup := seen[key]; dup {
  1077. continue
  1078. }
  1079. seen[key] = struct{}{}
  1080. }
  1081. }
  1082. kept = append(kept, c)
  1083. }
  1084. if len(kept) == len(clients) {
  1085. continue
  1086. }
  1087. settings["clients"] = kept
  1088. newSettings, err := json.MarshalIndent(settings, "", " ")
  1089. if err != nil {
  1090. log.Printf("dedupeInboundSettingsClients: skip inbound %d (marshal failed): %v", inbound.Id, err)
  1091. continue
  1092. }
  1093. if err := db.Model(&model.Inbound{}).Where("id = ?", inbound.Id).
  1094. Update("settings", string(newSettings)).Error; err != nil {
  1095. return err
  1096. }
  1097. repaired++
  1098. }
  1099. if repaired > 0 {
  1100. log.Printf("Removed duplicate client entries from %d inbound(s)", repaired)
  1101. }
  1102. return nil
  1103. }
  1104. func isIgnorableDuplicateColumnErr(gdb *gorm.DB, err error, mdl any) bool {
  1105. if err == nil {
  1106. return false
  1107. }
  1108. errMsg := strings.ToLower(err.Error())
  1109. const sqlitePrefix = "duplicate column name:"
  1110. if _, after, ok := strings.Cut(errMsg, sqlitePrefix); ok {
  1111. col := strings.TrimSpace(after)
  1112. col = strings.Trim(col, "`\"[]")
  1113. return col != "" && gdb != nil && gdb.Migrator().HasColumn(mdl, col)
  1114. }
  1115. if strings.Contains(errMsg, "already exists") && strings.Contains(errMsg, "column ") {
  1116. if _, after, ok := strings.Cut(errMsg, "column \""); ok {
  1117. rest := after
  1118. if e := strings.Index(rest, "\""); e > 0 {
  1119. col := rest[:e]
  1120. return col != "" && gdb != nil && gdb.Migrator().HasColumn(mdl, col)
  1121. }
  1122. }
  1123. }
  1124. return false
  1125. }
  1126. func initUser() error {
  1127. empty, err := isTableEmpty("users")
  1128. if err != nil {
  1129. log.Printf("Error checking if users table is empty: %v", err)
  1130. return err
  1131. }
  1132. if empty {
  1133. hashedPassword, err := crypto.HashPasswordAsBcrypt(defaultPassword)
  1134. if err != nil {
  1135. log.Printf("Error hashing default password: %v", err)
  1136. return err
  1137. }
  1138. user := &model.User{
  1139. Username: defaultUsername,
  1140. Password: hashedPassword,
  1141. }
  1142. return db.Create(user).Error
  1143. }
  1144. return nil
  1145. }
  1146. func seedRandomSubscriptionPaths() error {
  1147. settings := []model.Setting{
  1148. {Key: "subPath", Value: "/" + random.NumLower(16) + "/"},
  1149. {Key: "subJsonPath", Value: "/" + random.NumLower(16) + "/"},
  1150. {Key: "subClashPath", Value: "/" + random.NumLower(16) + "/"},
  1151. }
  1152. return db.Transaction(func(tx *gorm.DB) error {
  1153. for i := range settings {
  1154. if err := tx.Where("key = ?", settings[i].Key).FirstOrCreate(&settings[i]).Error; err != nil {
  1155. return err
  1156. }
  1157. }
  1158. return nil
  1159. })
  1160. }
  1161. func runSeeders(isUsersEmpty bool) error {
  1162. empty, err := isTableEmpty("history_of_seeders")
  1163. if err != nil {
  1164. log.Printf("Error checking if users table is empty: %v", err)
  1165. return err
  1166. }
  1167. if empty && isUsersEmpty {
  1168. seeders := []string{"UserPasswordHash", "ClientsTable", "InboundClientsArrayFix", "InboundClientTgIdFix2", "InboundClientSubIdFix", "FreedomFinalRulesReverseFix", "FreedomFinalRulesPrivateEgressBlock", "InboundRealityFinalmaskTcpStrip", "ApiTokensHash", "LegacyProxySettingsCleanup", "OutboundRemovedKeysFix", "WireguardPeersToClients", "MtprotoSecretsToClients", "NodeInboundsAdopted", "ResetIpLimitNoFail2ban"}
  1169. for _, name := range seeders {
  1170. if err := db.Create(&model.HistoryOfSeeders{SeederName: name}).Error; err != nil {
  1171. return err
  1172. }
  1173. }
  1174. return seedApiTokens()
  1175. }
  1176. var seedersHistory []string
  1177. if err := db.Model(&model.HistoryOfSeeders{}).Pluck("seeder_name", &seedersHistory).Error; err != nil {
  1178. log.Printf("Error fetching seeder history: %v", err)
  1179. return err
  1180. }
  1181. if !slices.Contains(seedersHistory, "UserPasswordHash") && !isUsersEmpty {
  1182. var users []model.User
  1183. if err := db.Find(&users).Error; err != nil {
  1184. log.Printf("Error fetching users for password migration: %v", err)
  1185. return err
  1186. }
  1187. for _, user := range users {
  1188. if crypto.IsHashed(user.Password) {
  1189. continue
  1190. }
  1191. hashedPassword, err := crypto.HashPasswordAsBcrypt(user.Password)
  1192. if err != nil {
  1193. log.Printf("Error hashing password for user '%s': %v", user.Username, err)
  1194. return err
  1195. }
  1196. if err := db.Model(&user).Update("password", hashedPassword).Error; err != nil {
  1197. log.Printf("Error updating password for user '%s': %v", user.Username, err)
  1198. return err
  1199. }
  1200. }
  1201. hashSeeder := &model.HistoryOfSeeders{
  1202. SeederName: "UserPasswordHash",
  1203. }
  1204. if err := db.Create(hashSeeder).Error; err != nil {
  1205. return err
  1206. }
  1207. }
  1208. if !slices.Contains(seedersHistory, "ApiTokensTable") {
  1209. if err := seedApiTokens(); err != nil {
  1210. return err
  1211. }
  1212. }
  1213. if !slices.Contains(seedersHistory, "ApiTokensHash") {
  1214. if err := hashExistingApiTokens(); err != nil {
  1215. return err
  1216. }
  1217. }
  1218. if !slices.Contains(seedersHistory, "ClientsTable") {
  1219. if err := seedClientsFromInboundJSON(); err != nil {
  1220. return err
  1221. }
  1222. }
  1223. if !slices.Contains(seedersHistory, "InboundClientsArrayFix") {
  1224. if err := normalizeInboundClientsArray(); err != nil {
  1225. return err
  1226. }
  1227. }
  1228. if !slices.Contains(seedersHistory, "InboundClientTgIdFix2") {
  1229. if err := normalizeInboundClientTgId(); err != nil {
  1230. return err
  1231. }
  1232. }
  1233. if !slices.Contains(seedersHistory, "InboundClientSubIdFix") {
  1234. if err := normalizeInboundClientSubId(); err != nil {
  1235. return err
  1236. }
  1237. }
  1238. if !slices.Contains(seedersHistory, "FreedomFinalRulesReverseFix") {
  1239. if err := normalizeFreedomFinalRules(); err != nil {
  1240. return err
  1241. }
  1242. }
  1243. if !slices.Contains(seedersHistory, "FreedomFinalRulesPrivateEgressBlock") {
  1244. if err := hardenFreedomFinalRules(); err != nil {
  1245. return err
  1246. }
  1247. }
  1248. if !slices.Contains(seedersHistory, "InboundRealityFinalmaskTcpStrip") {
  1249. if err := stripRealityFinalmaskTcp(); err != nil {
  1250. return err
  1251. }
  1252. }
  1253. if !slices.Contains(seedersHistory, "LegacyProxySettingsCleanup") {
  1254. if err := clearLegacyProxySettings(); err != nil {
  1255. return err
  1256. }
  1257. }
  1258. if !slices.Contains(seedersHistory, "OutboundRemovedKeysFix") {
  1259. if err := migrateOutboundRemovedKeys(); err != nil {
  1260. return err
  1261. }
  1262. }
  1263. if !slices.Contains(seedersHistory, "NodeInboundsAdopted") {
  1264. if err := seedNodeInboundsAdopted(); err != nil {
  1265. return err
  1266. }
  1267. }
  1268. if err := seedHostsFromExternalProxy(); err != nil {
  1269. return err
  1270. }
  1271. if err := seedMtprotoCustomShareAddrToHosts(); err != nil {
  1272. return err
  1273. }
  1274. if err := resetIpLimitsWithoutFail2ban(); err != nil {
  1275. return err
  1276. }
  1277. if err := seedWireguardPeersToClients(); err != nil {
  1278. return err
  1279. }
  1280. if err := backfillEmptyHostGroupIds(); err != nil {
  1281. return err
  1282. }
  1283. // Self-gated on the "MtprotoSecretsToClients" row.
  1284. if err := seedMtprotoSecretsToClients(); err != nil {
  1285. return err
  1286. }
  1287. // Self-gated on the "StripMtprotoInboundSecrets" row. Must run after the
  1288. // seeder above so legacy single-secret inbounds are first converted to a
  1289. // client (which preserves the secret) before the inbound-level copy is
  1290. // dropped from every mtproto inbound.
  1291. if err := stripMtprotoInboundSecrets(); err != nil {
  1292. return err
  1293. }
  1294. // Idempotent, not seeder-gated: bad values can re-enter via a restored
  1295. // backup, so re-check on every start.
  1296. return normalizeSettingPaths()
  1297. }
  1298. // seedNodeInboundsAdopted keeps the pre-existing reconcile behavior for nodes
  1299. // that were already syncing before the inbounds_adopted_at gate was introduced.
  1300. func seedNodeInboundsAdopted() error {
  1301. if err := db.Model(&model.Node{}).
  1302. Where("inbounds_adopted_at = 0").
  1303. Update("inbounds_adopted_at", time.Now().Unix()).Error; err != nil {
  1304. return err
  1305. }
  1306. return db.Create(&model.HistoryOfSeeders{SeederName: "NodeInboundsAdopted"}).Error
  1307. }
  1308. // backfillEmptyHostGroupIds is idempotent and not seeder-gated: builds that
  1309. // predate group ids on the inbound-import path (and restored backups) can
  1310. // re-introduce hosts rows with an empty group_id, and such rows render as a
  1311. // synthetic fallback_<id> group the update/delete API cannot address, so
  1312. // re-check on every start.
  1313. func backfillEmptyHostGroupIds() error {
  1314. var hosts []*model.Host
  1315. if err := db.Where("group_id = '' OR group_id IS NULL").Find(&hosts).Error; err != nil {
  1316. return err
  1317. }
  1318. if len(hosts) == 0 {
  1319. return nil
  1320. }
  1321. return db.Transaction(func(tx *gorm.DB) error {
  1322. for _, h := range hosts {
  1323. if err := tx.Model(h).Update("group_id", random.NumLower(16)).Error; err != nil {
  1324. return err
  1325. }
  1326. }
  1327. return nil
  1328. })
  1329. }
  1330. func resetIpLimitsWithoutFail2ban() error {
  1331. var history []string
  1332. if err := db.Model(&model.HistoryOfSeeders{}).Pluck("seeder_name", &history).Error; err != nil {
  1333. return err
  1334. }
  1335. if slices.Contains(history, "ResetIpLimitNoFail2ban") {
  1336. return nil
  1337. }
  1338. state, probeErr := fail2banEnforcementState()
  1339. if state == fail2banEnforcing {
  1340. return db.Create(&model.HistoryOfSeeders{SeederName: "ResetIpLimitNoFail2ban"}).Error
  1341. }
  1342. if state == fail2banUnknown {
  1343. log.Printf("ResetIpLimitNoFail2ban: fail2ban-client present but not runnable (%v); keeping configured IP limits, will retry next start", probeErr)
  1344. return nil
  1345. }
  1346. var inbounds []model.Inbound
  1347. if err := db.Find(&inbounds).Error; err != nil {
  1348. return err
  1349. }
  1350. return db.Transaction(func(tx *gorm.DB) error {
  1351. for _, inbound := range inbounds {
  1352. if strings.TrimSpace(inbound.Settings) == "" {
  1353. continue
  1354. }
  1355. var settings map[string]any
  1356. if err := json.Unmarshal([]byte(inbound.Settings), &settings); err != nil {
  1357. log.Printf("ResetIpLimitNoFail2ban: skip inbound %d (invalid settings json): %v", inbound.Id, err)
  1358. continue
  1359. }
  1360. clients, ok := settings["clients"].([]any)
  1361. if !ok {
  1362. continue
  1363. }
  1364. mutated := false
  1365. for i, raw := range clients {
  1366. obj, ok := raw.(map[string]any)
  1367. if !ok {
  1368. continue
  1369. }
  1370. v, present := obj["limitIp"]
  1371. if !present {
  1372. continue
  1373. }
  1374. if n, isNum := v.(float64); isNum && n == 0 {
  1375. continue
  1376. }
  1377. obj["limitIp"] = 0
  1378. clients[i] = obj
  1379. mutated = true
  1380. }
  1381. if !mutated {
  1382. continue
  1383. }
  1384. settings["clients"] = clients
  1385. newSettings, err := json.MarshalIndent(settings, "", " ")
  1386. if err != nil {
  1387. log.Printf("ResetIpLimitNoFail2ban: skip inbound %d (marshal failed): %v", inbound.Id, err)
  1388. continue
  1389. }
  1390. if err := tx.Model(&model.Inbound{}).Where("id = ?", inbound.Id).
  1391. Update("settings", string(newSettings)).Error; err != nil {
  1392. return err
  1393. }
  1394. }
  1395. if err := tx.Model(&model.ClientRecord{}).Where("limit_ip <> ?", 0).
  1396. Update("limit_ip", 0).Error; err != nil {
  1397. return err
  1398. }
  1399. return tx.Create(&model.HistoryOfSeeders{SeederName: "ResetIpLimitNoFail2ban"}).Error
  1400. })
  1401. }
  1402. type fail2banState int
  1403. const (
  1404. fail2banEnforcing fail2banState = iota
  1405. fail2banAbsent
  1406. fail2banUnknown
  1407. )
  1408. // fail2banEnforcementState separates "fail2ban is not installed" from "the probe
  1409. // itself failed", so a transient failure never drives an irreversible cleanup.
  1410. func fail2banEnforcementState() (fail2banState, error) {
  1411. if v, ok := os.LookupEnv("XUI_ENABLE_FAIL2BAN"); ok && v != "true" {
  1412. return fail2banAbsent, nil
  1413. }
  1414. if runtime.GOOS == "windows" {
  1415. return fail2banAbsent, nil
  1416. }
  1417. if _, err := exec.LookPath("fail2ban-client"); err != nil {
  1418. return fail2banAbsent, nil
  1419. }
  1420. if err := exec.CommandContext(context.Background(), "fail2ban-client", "-h").Run(); err != nil {
  1421. return fail2banUnknown, err
  1422. }
  1423. return fail2banEnforcing, nil
  1424. }
  1425. func clearLegacyProxySettings() error {
  1426. return db.Transaction(func(tx *gorm.DB) error {
  1427. if err := tx.Where("key IN ?", []string{"panelProxy", "tgBotProxy"}).
  1428. Delete(&model.Setting{}).Error; err != nil {
  1429. return err
  1430. }
  1431. return tx.Create(&model.HistoryOfSeeders{SeederName: "LegacyProxySettingsCleanup"}).Error
  1432. })
  1433. }
  1434. func migrateOutboundRemovedKeys() error {
  1435. var setting model.Setting
  1436. err := db.Model(model.Setting{}).Where("key = ?", "xrayTemplateConfig").First(&setting).Error
  1437. if errors.Is(err, gorm.ErrRecordNotFound) {
  1438. return db.Create(&model.HistoryOfSeeders{SeederName: "OutboundRemovedKeysFix"}).Error
  1439. }
  1440. if err != nil {
  1441. return err
  1442. }
  1443. updated, changed, rErr := rewriteRemovedOutboundKeys(setting.Value)
  1444. if rErr != nil {
  1445. log.Printf("OutboundRemovedKeysFix: skip (invalid xrayTemplateConfig json): %v", rErr)
  1446. return db.Create(&model.HistoryOfSeeders{SeederName: "OutboundRemovedKeysFix"}).Error
  1447. }
  1448. return db.Transaction(func(tx *gorm.DB) error {
  1449. if changed {
  1450. if err := tx.Model(&model.Setting{}).Where("key = ?", "xrayTemplateConfig").
  1451. Update("value", updated).Error; err != nil {
  1452. return err
  1453. }
  1454. }
  1455. return tx.Create(&model.HistoryOfSeeders{SeederName: "OutboundRemovedKeysFix"}).Error
  1456. })
  1457. }
  1458. // rewriteRemovedOutboundKeys moves outbound proxySettings.tag to sockopt.dialerProxy
  1459. // and drops freedom sockopt.addressPortStrategy: xray-core v26.9.8 refuses both.
  1460. func rewriteRemovedOutboundKeys(raw string) (string, bool, error) {
  1461. if strings.TrimSpace(raw) == "" {
  1462. return raw, false, nil
  1463. }
  1464. var cfg map[string]any
  1465. if err := json.Unmarshal([]byte(raw), &cfg); err != nil {
  1466. return raw, false, err
  1467. }
  1468. outbounds, ok := cfg["outbounds"].([]any)
  1469. if !ok {
  1470. return raw, false, nil
  1471. }
  1472. changed := false
  1473. for _, ob := range outbounds {
  1474. obj, ok := ob.(map[string]any)
  1475. if !ok {
  1476. continue
  1477. }
  1478. if proxySettings, present := obj["proxySettings"]; present {
  1479. ps, _ := proxySettings.(map[string]any)
  1480. if tag, _ := ps["tag"].(string); tag != "" {
  1481. sockopt := outboundSockopt(obj, true)
  1482. if current, _ := sockopt["dialerProxy"].(string); current == "" {
  1483. sockopt["dialerProxy"] = tag
  1484. }
  1485. }
  1486. delete(obj, "proxySettings")
  1487. changed = true
  1488. }
  1489. if proto, _ := obj["protocol"].(string); proto == "freedom" {
  1490. if sockopt := outboundSockopt(obj, false); sockopt != nil {
  1491. if _, present := sockopt["addressPortStrategy"]; present {
  1492. delete(sockopt, "addressPortStrategy")
  1493. changed = true
  1494. }
  1495. }
  1496. }
  1497. }
  1498. if !changed {
  1499. return raw, false, nil
  1500. }
  1501. out, err := json.MarshalIndent(cfg, "", " ")
  1502. if err != nil {
  1503. return raw, false, err
  1504. }
  1505. return string(out), true, nil
  1506. }
  1507. func outboundSockopt(obj map[string]any, create bool) map[string]any {
  1508. stream, _ := obj["streamSettings"].(map[string]any)
  1509. if stream == nil {
  1510. if !create {
  1511. return nil
  1512. }
  1513. stream = map[string]any{}
  1514. obj["streamSettings"] = stream
  1515. }
  1516. sockopt, _ := stream["sockopt"].(map[string]any)
  1517. if sockopt == nil {
  1518. if !create {
  1519. return nil
  1520. }
  1521. sockopt = map[string]any{}
  1522. stream["sockopt"] = sockopt
  1523. }
  1524. return sockopt
  1525. }
  1526. func normalizeSettingPaths() error {
  1527. pathKeys := []string{"webBasePath", "subPath", "subJsonPath", "subClashPath"}
  1528. var rows []model.Setting
  1529. if err := db.Where("key IN ?", pathKeys).Find(&rows).Error; err != nil {
  1530. return err
  1531. }
  1532. for _, row := range rows {
  1533. fixed := row.Value
  1534. if !strings.HasPrefix(fixed, "/") {
  1535. fixed = "/" + fixed
  1536. }
  1537. if !strings.HasSuffix(fixed, "/") {
  1538. fixed += "/"
  1539. }
  1540. if fixed == row.Value {
  1541. continue
  1542. }
  1543. if err := db.Model(&model.Setting{}).Where("id = ?", row.Id).
  1544. Update("value", fixed).Error; err != nil {
  1545. return err
  1546. }
  1547. }
  1548. return nil
  1549. }
  1550. func normalizeInboundClientTgId() error {
  1551. var inbounds []model.Inbound
  1552. if err := db.Find(&inbounds).Error; err != nil {
  1553. return err
  1554. }
  1555. return db.Transaction(func(tx *gorm.DB) error {
  1556. for _, inbound := range inbounds {
  1557. if strings.TrimSpace(inbound.Settings) == "" {
  1558. continue
  1559. }
  1560. var settings map[string]any
  1561. if err := json.Unmarshal([]byte(inbound.Settings), &settings); err != nil {
  1562. log.Printf("InboundClientTgIdFix: skip inbound %d (invalid settings json): %v", inbound.Id, err)
  1563. continue
  1564. }
  1565. clients, ok := settings["clients"].([]any)
  1566. if !ok {
  1567. continue
  1568. }
  1569. mutated := false
  1570. for i, raw := range clients {
  1571. obj, ok := raw.(map[string]any)
  1572. if !ok {
  1573. continue
  1574. }
  1575. tgRaw, present := obj["tgId"]
  1576. if !present {
  1577. continue
  1578. }
  1579. v, isFloat := tgRaw.(float64)
  1580. if isFloat && !math.IsNaN(v) && !math.IsInf(v, 0) && v == math.Trunc(v) {
  1581. continue
  1582. }
  1583. obj["tgId"] = int64(0)
  1584. if s, isStr := tgRaw.(string); isStr {
  1585. if id, err := strconv.ParseInt(strings.ReplaceAll(strings.TrimSpace(s), " ", ""), 10, 64); err == nil {
  1586. obj["tgId"] = id
  1587. }
  1588. }
  1589. clients[i] = obj
  1590. mutated = true
  1591. }
  1592. if !mutated {
  1593. continue
  1594. }
  1595. settings["clients"] = clients
  1596. newSettings, err := json.MarshalIndent(settings, "", " ")
  1597. if err != nil {
  1598. log.Printf("InboundClientTgIdFix: skip inbound %d (marshal failed): %v", inbound.Id, err)
  1599. continue
  1600. }
  1601. if err := tx.Model(&model.Inbound{}).Where("id = ?", inbound.Id).
  1602. Update("settings", string(newSettings)).Error; err != nil {
  1603. return err
  1604. }
  1605. }
  1606. return tx.Create(&model.HistoryOfSeeders{SeederName: "InboundClientTgIdFix2"}).Error
  1607. })
  1608. }
  1609. func normalizeInboundClientSubId() error {
  1610. var inbounds []model.Inbound
  1611. if err := db.Find(&inbounds).Error; err != nil {
  1612. return err
  1613. }
  1614. return db.Transaction(func(tx *gorm.DB) error {
  1615. for _, inbound := range inbounds {
  1616. if strings.TrimSpace(inbound.Settings) == "" {
  1617. continue
  1618. }
  1619. var settings map[string]any
  1620. if err := json.Unmarshal([]byte(inbound.Settings), &settings); err != nil {
  1621. log.Printf("InboundClientSubIdFix: skip inbound %d (invalid settings json): %v", inbound.Id, err)
  1622. continue
  1623. }
  1624. clients, ok := settings["clients"].([]any)
  1625. if !ok {
  1626. continue
  1627. }
  1628. mutated := false
  1629. for i, raw := range clients {
  1630. obj, ok := raw.(map[string]any)
  1631. if !ok {
  1632. continue
  1633. }
  1634. existing, _ := obj["subId"].(string)
  1635. if strings.TrimSpace(existing) != "" {
  1636. continue
  1637. }
  1638. obj["subId"] = random.NumLower(16)
  1639. clients[i] = obj
  1640. mutated = true
  1641. }
  1642. if !mutated {
  1643. continue
  1644. }
  1645. settings["clients"] = clients
  1646. newSettings, err := json.MarshalIndent(settings, "", " ")
  1647. if err != nil {
  1648. log.Printf("InboundClientSubIdFix: skip inbound %d (marshal failed): %v", inbound.Id, err)
  1649. continue
  1650. }
  1651. if err := tx.Model(&model.Inbound{}).Where("id = ?", inbound.Id).
  1652. Update("settings", string(newSettings)).Error; err != nil {
  1653. return err
  1654. }
  1655. }
  1656. return tx.Create(&model.HistoryOfSeeders{SeederName: "InboundClientSubIdFix"}).Error
  1657. })
  1658. }
  1659. func normalizeInboundClientsArray() error {
  1660. var inbounds []model.Inbound
  1661. if err := db.Find(&inbounds).Error; err != nil {
  1662. return err
  1663. }
  1664. return db.Transaction(func(tx *gorm.DB) error {
  1665. for _, inbound := range inbounds {
  1666. if strings.TrimSpace(inbound.Settings) == "" {
  1667. continue
  1668. }
  1669. var settings map[string]any
  1670. if err := json.Unmarshal([]byte(inbound.Settings), &settings); err != nil {
  1671. log.Printf("InboundClientsArrayFix: skip inbound %d (invalid settings json): %v", inbound.Id, err)
  1672. continue
  1673. }
  1674. raw, exists := settings["clients"]
  1675. if !exists || raw != nil {
  1676. continue
  1677. }
  1678. settings["clients"] = []any{}
  1679. newSettings, err := json.MarshalIndent(settings, "", " ")
  1680. if err != nil {
  1681. log.Printf("InboundClientsArrayFix: skip inbound %d (marshal failed): %v", inbound.Id, err)
  1682. continue
  1683. }
  1684. if err := tx.Model(&model.Inbound{}).Where("id = ?", inbound.Id).
  1685. Update("settings", string(newSettings)).Error; err != nil {
  1686. return err
  1687. }
  1688. }
  1689. return tx.Create(&model.HistoryOfSeeders{SeederName: "InboundClientsArrayFix"}).Error
  1690. })
  1691. }
  1692. func normalizeFreedomFinalRules() error {
  1693. var setting model.Setting
  1694. err := db.Model(model.Setting{}).Where("key = ?", "xrayTemplateConfig").First(&setting).Error
  1695. if errors.Is(err, gorm.ErrRecordNotFound) {
  1696. return db.Create(&model.HistoryOfSeeders{SeederName: "FreedomFinalRulesReverseFix"}).Error
  1697. }
  1698. if err != nil {
  1699. return err
  1700. }
  1701. updated, changed, rErr := rewriteFreedomFinalRules(setting.Value)
  1702. if rErr != nil {
  1703. log.Printf("FreedomFinalRulesReverseFix: skip (invalid xrayTemplateConfig json): %v", rErr)
  1704. return db.Create(&model.HistoryOfSeeders{SeederName: "FreedomFinalRulesReverseFix"}).Error
  1705. }
  1706. return db.Transaction(func(tx *gorm.DB) error {
  1707. if changed {
  1708. if err := tx.Model(&model.Setting{}).Where("key = ?", "xrayTemplateConfig").
  1709. Update("value", updated).Error; err != nil {
  1710. return err
  1711. }
  1712. }
  1713. return tx.Create(&model.HistoryOfSeeders{SeederName: "FreedomFinalRulesReverseFix"}).Error
  1714. })
  1715. }
  1716. func rewriteFreedomFinalRules(raw string) (string, bool, error) {
  1717. if strings.TrimSpace(raw) == "" {
  1718. return raw, false, nil
  1719. }
  1720. var cfg map[string]any
  1721. if err := json.Unmarshal([]byte(raw), &cfg); err != nil {
  1722. return raw, false, err
  1723. }
  1724. outbounds, ok := cfg["outbounds"].([]any)
  1725. if !ok {
  1726. return raw, false, nil
  1727. }
  1728. changed := false
  1729. for _, ob := range outbounds {
  1730. obj, ok := ob.(map[string]any)
  1731. if !ok {
  1732. continue
  1733. }
  1734. if proto, _ := obj["protocol"].(string); proto != "freedom" {
  1735. continue
  1736. }
  1737. settings, ok := obj["settings"].(map[string]any)
  1738. if !ok {
  1739. continue
  1740. }
  1741. if !isLegacyPrivateOnlyFinalRules(settings["finalRules"]) {
  1742. continue
  1743. }
  1744. settings["finalRules"] = []any{map[string]any{"action": "allow"}}
  1745. changed = true
  1746. }
  1747. if !changed {
  1748. return raw, false, nil
  1749. }
  1750. out, err := json.MarshalIndent(cfg, "", " ")
  1751. if err != nil {
  1752. return raw, false, err
  1753. }
  1754. return string(out), true, nil
  1755. }
  1756. func isLegacyPrivateOnlyFinalRules(v any) bool {
  1757. rules, ok := v.([]any)
  1758. if !ok || len(rules) != 1 {
  1759. return false
  1760. }
  1761. rule, ok := rules[0].(map[string]any)
  1762. if !ok {
  1763. return false
  1764. }
  1765. if action, _ := rule["action"].(string); action != "allow" {
  1766. return false
  1767. }
  1768. ips, ok := rule["ip"].([]any)
  1769. if !ok || len(ips) != 1 {
  1770. return false
  1771. }
  1772. if s, _ := ips[0].(string); s != "geoip:private" {
  1773. return false
  1774. }
  1775. for k := range rule {
  1776. if k != "action" && k != "ip" {
  1777. return false
  1778. }
  1779. }
  1780. return true
  1781. }
  1782. func isUnrestrictedFreedomFinalRules(v any, present bool) bool {
  1783. if !present || v == nil {
  1784. return true
  1785. }
  1786. rules, ok := v.([]any)
  1787. return ok && len(rules) == 0
  1788. }
  1789. func hardenFreedomFinalRules() error {
  1790. var setting model.Setting
  1791. err := db.Model(model.Setting{}).Where("key = ?", "xrayTemplateConfig").First(&setting).Error
  1792. if errors.Is(err, gorm.ErrRecordNotFound) {
  1793. return db.Create(&model.HistoryOfSeeders{SeederName: "FreedomFinalRulesPrivateEgressBlock"}).Error
  1794. }
  1795. if err != nil {
  1796. return err
  1797. }
  1798. updated, changed, rErr := rewriteFreedomFinalRulesPrivateEgress(setting.Value)
  1799. if rErr != nil {
  1800. log.Printf("FreedomFinalRulesPrivateEgressBlock: skip (invalid xrayTemplateConfig json): %v", rErr)
  1801. return db.Create(&model.HistoryOfSeeders{SeederName: "FreedomFinalRulesPrivateEgressBlock"}).Error
  1802. }
  1803. return db.Transaction(func(tx *gorm.DB) error {
  1804. if changed {
  1805. if err := tx.Model(&model.Setting{}).Where("key = ?", "xrayTemplateConfig").
  1806. Update("value", updated).Error; err != nil {
  1807. return err
  1808. }
  1809. }
  1810. return tx.Create(&model.HistoryOfSeeders{SeederName: "FreedomFinalRulesPrivateEgressBlock"}).Error
  1811. })
  1812. }
  1813. func rewriteFreedomFinalRulesPrivateEgress(raw string) (string, bool, error) {
  1814. if strings.TrimSpace(raw) == "" {
  1815. return raw, false, nil
  1816. }
  1817. var cfg map[string]any
  1818. if err := json.Unmarshal([]byte(raw), &cfg); err != nil {
  1819. return raw, false, err
  1820. }
  1821. outbounds, ok := cfg["outbounds"].([]any)
  1822. if !ok {
  1823. return raw, false, nil
  1824. }
  1825. changed := false
  1826. for _, ob := range outbounds {
  1827. obj, ok := ob.(map[string]any)
  1828. if !ok {
  1829. continue
  1830. }
  1831. if proto, _ := obj["protocol"].(string); proto != "freedom" {
  1832. continue
  1833. }
  1834. settings, ok := obj["settings"].(map[string]any)
  1835. if !ok {
  1836. continue
  1837. }
  1838. finalRules, present := settings["finalRules"]
  1839. if !isUnrestrictedFreedomFinalRules(finalRules, present) &&
  1840. !isAllowOnlyFinalRules(finalRules) &&
  1841. !isLegacyPrivateOnlyFinalRules(finalRules) {
  1842. continue
  1843. }
  1844. settings["finalRules"] = []any{
  1845. map[string]any{"action": "block", "ip": []any{"geoip:private"}},
  1846. map[string]any{"action": "allow"},
  1847. }
  1848. changed = true
  1849. }
  1850. if !changed {
  1851. return raw, false, nil
  1852. }
  1853. out, err := json.MarshalIndent(cfg, "", " ")
  1854. if err != nil {
  1855. return raw, false, err
  1856. }
  1857. return string(out), true, nil
  1858. }
  1859. func stripRealityFinalmaskTcp() error {
  1860. var inbounds []model.Inbound
  1861. if err := db.Find(&inbounds).Error; err != nil {
  1862. return err
  1863. }
  1864. return db.Transaction(func(tx *gorm.DB) error {
  1865. for i := range inbounds {
  1866. updated, changed := stripRealityFinalmaskTcpFromStream(inbounds[i].StreamSettings)
  1867. if !changed {
  1868. continue
  1869. }
  1870. if err := tx.Model(&model.Inbound{}).Where("id = ?", inbounds[i].Id).
  1871. Update("stream_settings", updated).Error; err != nil {
  1872. return err
  1873. }
  1874. log.Printf("InboundRealityFinalmaskTcpStrip: removed finalmask.tcp from REALITY inbound %d (%s)", inbounds[i].Id, inbounds[i].Tag)
  1875. }
  1876. return tx.Create(&model.HistoryOfSeeders{SeederName: "InboundRealityFinalmaskTcpStrip"}).Error
  1877. })
  1878. }
  1879. func stripRealityFinalmaskTcpFromStream(raw string) (string, bool) {
  1880. if strings.TrimSpace(raw) == "" {
  1881. return raw, false
  1882. }
  1883. var stream map[string]any
  1884. if err := json.Unmarshal([]byte(raw), &stream); err != nil {
  1885. return raw, false
  1886. }
  1887. if sec, _ := stream["security"].(string); sec != "reality" {
  1888. return raw, false
  1889. }
  1890. finalmask, ok := stream["finalmask"].(map[string]any)
  1891. if !ok {
  1892. return raw, false
  1893. }
  1894. if tcp, _ := finalmask["tcp"].([]any); len(tcp) == 0 {
  1895. return raw, false
  1896. }
  1897. delete(finalmask, "tcp")
  1898. if len(finalmask) == 0 {
  1899. delete(stream, "finalmask")
  1900. }
  1901. out, err := json.Marshal(stream)
  1902. if err != nil {
  1903. return raw, false
  1904. }
  1905. return string(out), true
  1906. }
  1907. func isAllowOnlyFinalRules(v any) bool {
  1908. rules, ok := v.([]any)
  1909. if !ok || len(rules) != 1 {
  1910. return false
  1911. }
  1912. rule, ok := rules[0].(map[string]any)
  1913. if !ok {
  1914. return false
  1915. }
  1916. if action, _ := rule["action"].(string); action != "allow" {
  1917. return false
  1918. }
  1919. for k := range rule {
  1920. if k != "action" {
  1921. return false
  1922. }
  1923. }
  1924. return true
  1925. }
  1926. func normalizeClientJSONFields(obj map[string]any) {
  1927. normalizeInt := func(key string) {
  1928. raw, exists := obj[key]
  1929. if !exists {
  1930. return
  1931. }
  1932. s, ok := raw.(string)
  1933. if !ok {
  1934. return
  1935. }
  1936. trimmed := strings.ReplaceAll(strings.TrimSpace(s), " ", "")
  1937. if trimmed == "" {
  1938. delete(obj, key)
  1939. return
  1940. }
  1941. if n, err := strconv.ParseInt(trimmed, 10, 64); err == nil {
  1942. obj[key] = n
  1943. } else {
  1944. delete(obj, key)
  1945. }
  1946. }
  1947. for _, k := range []string{"tgId", "limitIp", "totalGB", "expiryTime", "reset", "created_at", "updated_at"} {
  1948. normalizeInt(k)
  1949. }
  1950. }
  1951. func seedClientsFromInboundJSON() error {
  1952. var inbounds []model.Inbound
  1953. if err := db.Find(&inbounds).Error; err != nil {
  1954. return err
  1955. }
  1956. return db.Transaction(func(tx *gorm.DB) error {
  1957. byEmail := map[string]*model.ClientRecord{}
  1958. var existing []model.ClientRecord
  1959. if err := tx.Find(&existing).Error; err != nil {
  1960. return err
  1961. }
  1962. for i := range existing {
  1963. byEmail[existing[i].Email] = &existing[i]
  1964. }
  1965. for _, inbound := range inbounds {
  1966. if strings.TrimSpace(inbound.Settings) == "" {
  1967. continue
  1968. }
  1969. var settings map[string]any
  1970. if err := json.Unmarshal([]byte(inbound.Settings), &settings); err != nil {
  1971. log.Printf("ClientsTable seed: skip inbound %d (invalid settings json): %v", inbound.Id, err)
  1972. continue
  1973. }
  1974. rawList, ok := settings["clients"].([]any)
  1975. if !ok {
  1976. continue
  1977. }
  1978. for _, raw := range rawList {
  1979. obj, ok := raw.(map[string]any)
  1980. if !ok {
  1981. continue
  1982. }
  1983. normalizeClientJSONFields(obj)
  1984. blob, err := json.Marshal(obj)
  1985. if err != nil {
  1986. continue
  1987. }
  1988. var c model.Client
  1989. if err := json.Unmarshal(blob, &c); err != nil {
  1990. log.Printf("ClientsTable seed: skip client in inbound %d (unmarshal failed): %v; payload=%s",
  1991. inbound.Id, err, string(blob))
  1992. continue
  1993. }
  1994. email := strings.TrimSpace(c.Email)
  1995. if email == "" {
  1996. continue
  1997. }
  1998. incoming := c.ToRecord()
  1999. row, dup := byEmail[email]
  2000. if !dup {
  2001. if err := tx.Create(incoming).Error; err != nil {
  2002. return err
  2003. }
  2004. byEmail[email] = incoming
  2005. row = incoming
  2006. } else {
  2007. conflicts := model.MergeClientRecord(row, incoming)
  2008. for _, x := range conflicts {
  2009. log.Printf("client merge: email=%s conflict on %s old=%v new=%v kept=%v",
  2010. email, x.Field, x.Old, x.New, x.Kept)
  2011. }
  2012. if err := tx.Save(row).Error; err != nil {
  2013. return err
  2014. }
  2015. }
  2016. link := model.ClientInbound{
  2017. ClientId: row.Id,
  2018. InboundId: inbound.Id,
  2019. FlowOverride: c.Flow,
  2020. }
  2021. if err := tx.Where("client_id = ? AND inbound_id = ?", row.Id, inbound.Id).
  2022. FirstOrCreate(&link).Error; err != nil {
  2023. return err
  2024. }
  2025. }
  2026. }
  2027. return tx.Create(&model.HistoryOfSeeders{SeederName: "ClientsTable"}).Error
  2028. })
  2029. }
  2030. func seedApiTokens() error {
  2031. empty, err := isTableEmpty("api_tokens")
  2032. if err != nil {
  2033. return err
  2034. }
  2035. if empty {
  2036. var legacy model.Setting
  2037. err := db.Model(model.Setting{}).Where("key = ?", "apiToken").First(&legacy).Error
  2038. if err == nil && legacy.Value != "" {
  2039. row := &model.ApiToken{
  2040. Name: "default",
  2041. Token: legacy.Value,
  2042. Enabled: true,
  2043. }
  2044. if err := db.Create(row).Error; err != nil {
  2045. log.Printf("Error migrating legacy apiToken: %v", err)
  2046. return err
  2047. }
  2048. }
  2049. }
  2050. return db.Create(&model.HistoryOfSeeders{SeederName: "ApiTokensTable"}).Error
  2051. }
  2052. func hashExistingApiTokens() error {
  2053. var rows []*model.ApiToken
  2054. if err := db.Find(&rows).Error; err != nil {
  2055. return err
  2056. }
  2057. for _, r := range rows {
  2058. if crypto.IsSHA256Hex(r.Token) {
  2059. continue
  2060. }
  2061. hashed := crypto.HashTokenSHA256(r.Token)
  2062. if err := db.Model(model.ApiToken{}).Where("id = ?", r.Id).Update("token", hashed).Error; err != nil {
  2063. log.Printf("Error hashing api token %d: %v", r.Id, err)
  2064. return err
  2065. }
  2066. }
  2067. return db.Create(&model.HistoryOfSeeders{SeederName: "ApiTokensHash"}).Error
  2068. }
  2069. func isTableEmpty(tableName string) (bool, error) {
  2070. var count int64
  2071. err := db.Table(tableName).Count(&count).Error
  2072. return count == 0, err
  2073. }
  2074. func InitDB(dbPath string) error {
  2075. var gormLogger logger.Interface
  2076. if config.IsDebug() {
  2077. gormLogger = logger.New(
  2078. log.New(os.Stdout, "\r\n", log.LstdFlags),
  2079. logger.Config{
  2080. SlowThreshold: time.Second,
  2081. LogLevel: logger.Info,
  2082. IgnoreRecordNotFoundError: true,
  2083. Colorful: true,
  2084. },
  2085. )
  2086. } else {
  2087. gormLogger = logger.Discard
  2088. }
  2089. c := &gorm.Config{Logger: gormLogger, DisableForeignKeyConstraintWhenMigrating: true}
  2090. var err error
  2091. switch config.GetDBKind() {
  2092. case "postgres":
  2093. dsn := config.GetDBDSN()
  2094. if dsn == "" {
  2095. return errors.New("XUI_DB_TYPE=postgres but XUI_DB_DSN is empty")
  2096. }
  2097. db, err = openPostgresWithRetry(dsn, c)
  2098. if err != nil {
  2099. return err
  2100. }
  2101. default:
  2102. dir := path.Dir(dbPath)
  2103. if err = os.MkdirAll(dir, 0o700); err != nil {
  2104. return err
  2105. }
  2106. if err = cleanupSQLiteBackupDirs(filepath.Dir(dbPath)); err != nil {
  2107. log.Printf("clean SQLite backup directories: %v", err)
  2108. }
  2109. sync := sqliteSynchronous()
  2110. journal := sqliteJournalMode()
  2111. dsn := dbPath + "?_journal_mode=" + journal + "&_busy_timeout=10000&_synchronous=" + sync + "&_txlock=immediate"
  2112. db, err = gorm.Open(sqlite.Open(dsn), c)
  2113. if err != nil {
  2114. return err
  2115. }
  2116. if err := restrictSQLiteFilePerms(dbPath); err != nil {
  2117. log.Printf("restrict SQLite file permissions: %v", err)
  2118. }
  2119. sqlDB, err := db.DB()
  2120. if err != nil {
  2121. return err
  2122. }
  2123. pragmas := []string{
  2124. "PRAGMA journal_mode=" + journal,
  2125. "PRAGMA busy_timeout=10000",
  2126. "PRAGMA synchronous=" + sync,
  2127. fmt.Sprintf("PRAGMA cache_size=-%d", envInt("XUI_DB_CACHE_MB", 32)*1024),
  2128. fmt.Sprintf("PRAGMA mmap_size=%d", int64(envInt("XUI_DB_MMAP_MB", 256))*1024*1024),
  2129. "PRAGMA temp_store=MEMORY",
  2130. }
  2131. for _, p := range pragmas {
  2132. if _, err := sqlDB.ExecContext(context.Background(), p); err != nil {
  2133. return err
  2134. }
  2135. }
  2136. }
  2137. sqlDB, err := db.DB()
  2138. if err != nil {
  2139. return err
  2140. }
  2141. var maxOpen, maxIdle int
  2142. switch config.GetDBKind() {
  2143. case "postgres":
  2144. maxOpen = envInt("XUI_DB_MAX_OPEN_CONNS", 25)
  2145. maxIdle = envInt("XUI_DB_MAX_IDLE_CONNS", 25)
  2146. default:
  2147. maxOpen = envInt("XUI_DB_MAX_OPEN_CONNS", 8)
  2148. maxIdle = envInt("XUI_DB_MAX_IDLE_CONNS", 4)
  2149. }
  2150. sqlDB.SetMaxOpenConns(maxOpen)
  2151. sqlDB.SetMaxIdleConns(maxIdle)
  2152. sqlDB.SetConnMaxLifetime(time.Hour)
  2153. sqlDB.SetConnMaxIdleTime(30 * time.Minute)
  2154. if err := initModels(); err != nil {
  2155. return err
  2156. }
  2157. isUsersEmpty, err := isTableEmpty("users")
  2158. if err != nil {
  2159. return err
  2160. }
  2161. if isUsersEmpty {
  2162. if err := seedRandomSubscriptionPaths(); err != nil {
  2163. return err
  2164. }
  2165. }
  2166. if err := initUser(); err != nil {
  2167. return err
  2168. }
  2169. return runSeeders(isUsersEmpty)
  2170. }
  2171. func normalizeApiTokenCreatedAtSeconds() error {
  2172. return db.Model(&model.ApiToken{}).
  2173. Where("created_at >= ?", model.ApiTokenUnixMillisecondsThreshold).
  2174. UpdateColumn("created_at", gorm.Expr("created_at / ?", 1000)).Error
  2175. }
  2176. func migrateApiTokenScopeAndExpiry() error {
  2177. m := db.Migrator()
  2178. if !m.HasColumn(&model.ApiToken{}, "Scope") {
  2179. if err := m.AddColumn(&model.ApiToken{}, "Scope"); err != nil {
  2180. return err
  2181. }
  2182. }
  2183. if !m.HasColumn(&model.ApiToken{}, "ExpiresAt") {
  2184. if err := m.AddColumn(&model.ApiToken{}, "ExpiresAt"); err != nil {
  2185. return err
  2186. }
  2187. }
  2188. return db.Model(&model.ApiToken{}).Where("scope IS NULL OR TRIM(scope) = ''").
  2189. Updates(map[string]any{"scope": model.ApiScopeAdmin, "expires_at": 0}).Error
  2190. }
  2191. // openPostgresWithRetry retries the initial PostgreSQL connection with
  2192. // backoff so a database that starts slower than the panel (or drops out
  2193. // briefly) does not immediately kill the process and trip systemd's
  2194. // restart loop. Every failed attempt logs the real driver error, which
  2195. // used to be buried behind a generic startup failure.
  2196. func openPostgresWithRetry(dsn string, c *gorm.Config) (*gorm.DB, error) {
  2197. delays := []time.Duration{0, 2 * time.Second, 5 * time.Second, 10 * time.Second, 20 * time.Second, 30 * time.Second}
  2198. var lastErr error
  2199. for i, delay := range delays {
  2200. if delay > 0 {
  2201. time.Sleep(delay)
  2202. }
  2203. conn, err := gorm.Open(postgres.Open(dsn), c)
  2204. if err == nil {
  2205. if i > 0 {
  2206. log.Printf("postgres connection established on attempt %d/%d", i+1, len(delays))
  2207. }
  2208. return conn, nil
  2209. }
  2210. lastErr = err
  2211. log.Printf("postgres connection attempt %d/%d failed: %v", i+1, len(delays), err)
  2212. }
  2213. return nil, fmt.Errorf("postgres unreachable after %d attempts: %w", len(delays), lastErr)
  2214. }
  2215. // The store holds client secrets, so it and its WAL/SHM side files stay
  2216. // owner-only. Best effort: a store the panel cannot chmod still opens.
  2217. func restrictSQLiteFilePerms(dbPath string) error {
  2218. for _, name := range []string{dbPath, dbPath + "-wal", dbPath + "-shm"} {
  2219. if err := os.Chmod(name, 0o600); err != nil && !errors.Is(err, os.ErrNotExist) {
  2220. return err
  2221. }
  2222. }
  2223. return nil
  2224. }
  2225. func sqliteJournalMode() string {
  2226. switch strings.ToUpper(strings.TrimSpace(os.Getenv("XUI_DB_JOURNAL_MODE"))) {
  2227. case "DELETE":
  2228. return "DELETE"
  2229. default:
  2230. return "WAL"
  2231. }
  2232. }
  2233. func backupSQLiteStepPages() int {
  2234. if sqliteJournalMode() == "DELETE" {
  2235. return 128
  2236. }
  2237. return -1
  2238. }
  2239. func cleanupSQLiteBackupDirs(dir string) error {
  2240. entries, err := os.ReadDir(dir)
  2241. if errors.Is(err, os.ErrNotExist) {
  2242. return nil
  2243. }
  2244. if err != nil {
  2245. return err
  2246. }
  2247. for _, entry := range entries {
  2248. if entry.IsDir() && strings.HasPrefix(entry.Name(), sqliteBackupDirPrefix) {
  2249. if err := os.RemoveAll(filepath.Join(dir, entry.Name())); err != nil {
  2250. return err
  2251. }
  2252. }
  2253. }
  2254. return nil
  2255. }
  2256. func sqliteSynchronous() string {
  2257. switch strings.ToUpper(strings.TrimSpace(os.Getenv("XUI_DB_SYNCHRONOUS"))) {
  2258. case "OFF":
  2259. return "OFF"
  2260. case "NORMAL":
  2261. return "NORMAL"
  2262. case "EXTRA":
  2263. return "EXTRA"
  2264. default:
  2265. return "FULL"
  2266. }
  2267. }
  2268. func envInt(key string, def int) int {
  2269. v := strings.TrimSpace(os.Getenv(key))
  2270. if v == "" {
  2271. return def
  2272. }
  2273. n, err := strconv.Atoi(v)
  2274. if err != nil || n <= 0 {
  2275. return def
  2276. }
  2277. return n
  2278. }
  2279. func CloseDB() error {
  2280. if db != nil {
  2281. sqlDB, err := db.DB()
  2282. if err != nil {
  2283. return err
  2284. }
  2285. return sqlDB.Close()
  2286. }
  2287. return nil
  2288. }
  2289. func GetDB() *gorm.DB {
  2290. return db
  2291. }
  2292. func IsNotFound(err error) bool {
  2293. return errors.Is(err, gorm.ErrRecordNotFound)
  2294. }
  2295. func IsSQLiteDB(file io.ReaderAt) (bool, error) {
  2296. signature := []byte("SQLite format 3\x00")
  2297. buf := make([]byte, len(signature))
  2298. _, err := file.ReadAt(buf, 0)
  2299. if err != nil {
  2300. return false, err
  2301. }
  2302. return bytes.Equal(buf, signature), nil
  2303. }
  2304. func BackupSQLite(dstPath string) (err error) {
  2305. if IsPostgres() {
  2306. return errors.New("sqlite backup is unavailable for PostgreSQL")
  2307. }
  2308. if db == nil {
  2309. return errors.New("database is not initialized")
  2310. }
  2311. if _, err := os.Lstat(dstPath); err == nil {
  2312. return fmt.Errorf("sqlite backup destination already exists: %s", dstPath)
  2313. } else if !errors.Is(err, os.ErrNotExist) {
  2314. return err
  2315. }
  2316. defer func() {
  2317. if err != nil {
  2318. _ = os.Remove(dstPath)
  2319. }
  2320. }()
  2321. ctx, cancel := context.WithTimeout(context.Background(), backupSQLiteTimeout)
  2322. defer cancel()
  2323. sourceDB, err := db.DB()
  2324. if err != nil {
  2325. return err
  2326. }
  2327. sourceConn, err := sourceDB.Conn(ctx)
  2328. if err != nil {
  2329. return err
  2330. }
  2331. defer sourceConn.Close()
  2332. destinationDB, err := sql.Open("sqlite3", dstPath)
  2333. if err != nil {
  2334. return err
  2335. }
  2336. defer destinationDB.Close()
  2337. destinationConn, err := destinationDB.Conn(ctx)
  2338. if err != nil {
  2339. return err
  2340. }
  2341. defer destinationConn.Close()
  2342. return sourceConn.Raw(func(sourceDriver any) error {
  2343. source, ok := sourceDriver.(*sqlite3.SQLiteConn)
  2344. if !ok {
  2345. return fmt.Errorf("unexpected SQLite source connection type %T", sourceDriver)
  2346. }
  2347. return destinationConn.Raw(func(destinationDriver any) error {
  2348. destination, ok := destinationDriver.(*sqlite3.SQLiteConn)
  2349. if !ok {
  2350. return fmt.Errorf("unexpected SQLite destination connection type %T", destinationDriver)
  2351. }
  2352. backup, err := destination.Backup("main", source, "main")
  2353. if err != nil {
  2354. return err
  2355. }
  2356. finished := false
  2357. defer func() {
  2358. if !finished {
  2359. _ = backup.Finish()
  2360. }
  2361. }()
  2362. for {
  2363. done, err := backup.Step(backupSQLiteStepPages())
  2364. if err != nil {
  2365. return err
  2366. }
  2367. if done {
  2368. finished = true
  2369. return backup.Finish()
  2370. }
  2371. select {
  2372. case <-ctx.Done():
  2373. return ctx.Err()
  2374. case <-time.After(10 * time.Millisecond):
  2375. }
  2376. }
  2377. })
  2378. })
  2379. }
  2380. func ValidateSQLiteDB(dbPath string) error {
  2381. if _, err := os.Stat(dbPath); err != nil {
  2382. return err
  2383. }
  2384. gdb, err := gorm.Open(sqlite.Open(dbPath), &gorm.Config{Logger: logger.Discard})
  2385. if err != nil {
  2386. return err
  2387. }
  2388. sqlDB, err := gdb.DB()
  2389. if err != nil {
  2390. return err
  2391. }
  2392. defer sqlDB.Close()
  2393. var res string
  2394. if err := gdb.Raw("PRAGMA integrity_check;").Scan(&res).Error; err != nil {
  2395. return err
  2396. }
  2397. if res != "ok" {
  2398. return errors.New("sqlite integrity check failed: " + res)
  2399. }
  2400. return nil
  2401. }