db.go 71 KB

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