db.go 63 KB

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