1
0

db.go 72 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589
  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 sub_sort_index values below the 1-based
  966. // minimum (rows written by builds that defaulted the column to 0, or by nodes
  967. // predating the field) so they cannot sort ahead of explicitly ranked inbounds.
  968. func normalizeInboundSubSortIndex() error {
  969. res := db.Exec("UPDATE inbounds SET sub_sort_index = 1 WHERE sub_sort_index < 1")
  970. if res.Error != nil {
  971. log.Printf("Error normalizing inbound sub_sort_index: %v", res.Error)
  972. return res.Error
  973. }
  974. if res.RowsAffected > 0 {
  975. log.Printf("Normalized sub_sort_index on %d inbound(s)", res.RowsAffected)
  976. }
  977. return nil
  978. }
  979. // normalizeClientExternalLinkEnable keeps external-link rows written before the
  980. // enable column existed enabled; disabled rows from newer builds stay false.
  981. func normalizeClientExternalLinkEnable() error {
  982. res := db.Exec("UPDATE client_external_links SET enable = ? WHERE enable IS NULL", true)
  983. if res.Error != nil {
  984. log.Printf("Error normalizing client external link enable: %v", res.Error)
  985. return res.Error
  986. }
  987. if res.RowsAffected > 0 {
  988. log.Printf("Normalized enable on %d client external link(s)", res.RowsAffected)
  989. }
  990. return nil
  991. }
  992. // normalizeClientExternalLinkTimestamps zeroes the NULLs an older build could
  993. // leave behind, so the sub-side expiry predicate never drops a legacy row.
  994. func normalizeClientExternalLinkTimestamps() error {
  995. res := db.Exec("UPDATE client_external_links SET expiry_time = 0 WHERE expiry_time IS NULL")
  996. if res.Error != nil {
  997. log.Printf("Error normalizing client external link expiry_time: %v", res.Error)
  998. return res.Error
  999. }
  1000. expiryRows := res.RowsAffected
  1001. res = db.Exec("UPDATE client_external_links SET last_fetch_at = 0 WHERE last_fetch_at IS NULL")
  1002. if res.Error != nil {
  1003. log.Printf("Error normalizing client external link last_fetch_at: %v", res.Error)
  1004. return res.Error
  1005. }
  1006. if expiryRows+res.RowsAffected > 0 {
  1007. log.Printf("Normalized timestamps on %d client external link(s)", expiryRows+res.RowsAffected)
  1008. }
  1009. return nil
  1010. }
  1011. // repairOverflowedTrafficCounters heals traffic counters that historic
  1012. // compounding bugs pushed past int64: on SQLite an overflowing INTEGER is
  1013. // silently promoted to REAL, after which the column no longer scans into the
  1014. // Go int64 field and every reader of the table fails (#5762). REAL cells are
  1015. // cast back to INTEGER (SQLite caps the cast at math.MaxInt64), then values
  1016. // are clamped into [0, TrafficMax] on both backends so the next delta cannot
  1017. // overflow again.
  1018. func repairOverflowedTrafficCounters() error {
  1019. targets := []struct {
  1020. table string
  1021. columns []string
  1022. }{
  1023. {"client_traffics", []string{"up", "down"}},
  1024. {"inbounds", []string{"up", "down"}},
  1025. {"outbound_traffics", []string{"up", "down", "total"}},
  1026. {"node_client_traffics", []string{"up", "down"}},
  1027. }
  1028. for _, target := range targets {
  1029. for _, col := range target.columns {
  1030. statements := []string{
  1031. fmt.Sprintf("UPDATE %s SET %s = %d WHERE %s > %d", target.table, col, TrafficMax, col, TrafficMax),
  1032. fmt.Sprintf("UPDATE %s SET %s = 0 WHERE %s < 0", target.table, col, col),
  1033. }
  1034. if !IsPostgres() {
  1035. statements = append([]string{
  1036. fmt.Sprintf("UPDATE %s SET %s = CAST(%s AS INTEGER) WHERE typeof(%s) = 'real'", target.table, col, col, col),
  1037. }, statements...)
  1038. }
  1039. var repaired int64
  1040. for _, statement := range statements {
  1041. res := db.Exec(statement)
  1042. if res.Error != nil {
  1043. log.Printf("Error repairing %s.%s: %v", target.table, col, res.Error)
  1044. return res.Error
  1045. }
  1046. repaired += res.RowsAffected
  1047. }
  1048. if repaired > 0 {
  1049. log.Printf("Repaired %d overflowed %s.%s value(s)", repaired, target.table, col)
  1050. }
  1051. }
  1052. }
  1053. return nil
  1054. }
  1055. // dedupeInboundSettingsClients collapses duplicate same-email entries inside
  1056. // every inbound's settings.clients array, keeping the first occurrence.
  1057. // Retried or raced multi-node client adds on older builds appended the same
  1058. // client several times (#5770), which the client lists then rendered as
  1059. // phantom duplicates. Runs on every start (idempotent, writes only changed
  1060. // rows) because a restored backup or a not-yet-upgraded node's snapshot can
  1061. // reintroduce duplicates.
  1062. func dedupeInboundSettingsClients() error {
  1063. var inbounds []model.Inbound
  1064. if err := db.Find(&inbounds).Error; err != nil {
  1065. return err
  1066. }
  1067. repaired := int64(0)
  1068. for _, inbound := range inbounds {
  1069. if strings.TrimSpace(inbound.Settings) == "" {
  1070. continue
  1071. }
  1072. var settings map[string]any
  1073. if err := json.Unmarshal([]byte(inbound.Settings), &settings); err != nil {
  1074. continue
  1075. }
  1076. clients, _ := settings["clients"].([]any)
  1077. if len(clients) < 2 {
  1078. continue
  1079. }
  1080. seen := make(map[string]struct{}, len(clients))
  1081. kept := make([]any, 0, len(clients))
  1082. for _, c := range clients {
  1083. if cm, ok := c.(map[string]any); ok {
  1084. if email, _ := cm["email"].(string); email != "" {
  1085. key := strings.ToLower(email)
  1086. if _, dup := seen[key]; dup {
  1087. continue
  1088. }
  1089. seen[key] = struct{}{}
  1090. }
  1091. }
  1092. kept = append(kept, c)
  1093. }
  1094. if len(kept) == len(clients) {
  1095. continue
  1096. }
  1097. settings["clients"] = kept
  1098. newSettings, err := json.MarshalIndent(settings, "", " ")
  1099. if err != nil {
  1100. log.Printf("dedupeInboundSettingsClients: skip inbound %d (marshal failed): %v", inbound.Id, err)
  1101. continue
  1102. }
  1103. if err := db.Model(&model.Inbound{}).Where("id = ?", inbound.Id).
  1104. Update("settings", string(newSettings)).Error; err != nil {
  1105. return err
  1106. }
  1107. repaired++
  1108. }
  1109. if repaired > 0 {
  1110. log.Printf("Removed duplicate client entries from %d inbound(s)", repaired)
  1111. }
  1112. return nil
  1113. }
  1114. func isIgnorableDuplicateColumnErr(gdb *gorm.DB, err error, mdl any) bool {
  1115. if err == nil {
  1116. return false
  1117. }
  1118. errMsg := strings.ToLower(err.Error())
  1119. const sqlitePrefix = "duplicate column name:"
  1120. if _, after, ok := strings.Cut(errMsg, sqlitePrefix); ok {
  1121. col := strings.TrimSpace(after)
  1122. col = strings.Trim(col, "`\"[]")
  1123. return col != "" && gdb != nil && gdb.Migrator().HasColumn(mdl, col)
  1124. }
  1125. if strings.Contains(errMsg, "already exists") && strings.Contains(errMsg, "column ") {
  1126. if _, after, ok := strings.Cut(errMsg, "column \""); ok {
  1127. rest := after
  1128. if e := strings.Index(rest, "\""); e > 0 {
  1129. col := rest[:e]
  1130. return col != "" && gdb != nil && gdb.Migrator().HasColumn(mdl, col)
  1131. }
  1132. }
  1133. }
  1134. return false
  1135. }
  1136. func initUser() error {
  1137. empty, err := isTableEmpty("users")
  1138. if err != nil {
  1139. log.Printf("Error checking if users table is empty: %v", err)
  1140. return err
  1141. }
  1142. if empty {
  1143. hashedPassword, err := crypto.HashPasswordAsBcrypt(defaultPassword)
  1144. if err != nil {
  1145. log.Printf("Error hashing default password: %v", err)
  1146. return err
  1147. }
  1148. user := &model.User{
  1149. Username: defaultUsername,
  1150. Password: hashedPassword,
  1151. }
  1152. return db.Create(user).Error
  1153. }
  1154. return nil
  1155. }
  1156. func seedRandomSubscriptionPaths() error {
  1157. settings := []model.Setting{
  1158. {Key: "subPath", Value: "/" + random.NumLower(16) + "/"},
  1159. {Key: "subJsonPath", Value: "/" + random.NumLower(16) + "/"},
  1160. {Key: "subClashPath", Value: "/" + random.NumLower(16) + "/"},
  1161. }
  1162. return db.Transaction(func(tx *gorm.DB) error {
  1163. for i := range settings {
  1164. if err := tx.Where("key = ?", settings[i].Key).FirstOrCreate(&settings[i]).Error; err != nil {
  1165. return err
  1166. }
  1167. }
  1168. return nil
  1169. })
  1170. }
  1171. func runSeeders(isUsersEmpty bool) error {
  1172. empty, err := isTableEmpty("history_of_seeders")
  1173. if err != nil {
  1174. log.Printf("Error checking if users table is empty: %v", err)
  1175. return err
  1176. }
  1177. if empty && isUsersEmpty {
  1178. seeders := []string{"UserPasswordHash", "ClientsTable", "InboundClientsArrayFix", "InboundClientTgIdFix2", "InboundClientSubIdFix", "FreedomFinalRulesReverseFix", "FreedomFinalRulesPrivateEgressBlock", "InboundRealityFinalmaskTcpStrip", "ApiTokensHash", "LegacyProxySettingsCleanup", "OutboundRemovedKeysFix", "WireguardPeersToClients", "MtprotoSecretsToClients", "NodeInboundsAdopted", "ResetIpLimitNoFail2ban"}
  1179. for _, name := range seeders {
  1180. if err := db.Create(&model.HistoryOfSeeders{SeederName: name}).Error; err != nil {
  1181. return err
  1182. }
  1183. }
  1184. return seedApiTokens()
  1185. }
  1186. var seedersHistory []string
  1187. if err := db.Model(&model.HistoryOfSeeders{}).Pluck("seeder_name", &seedersHistory).Error; err != nil {
  1188. log.Printf("Error fetching seeder history: %v", err)
  1189. return err
  1190. }
  1191. if !slices.Contains(seedersHistory, "UserPasswordHash") && !isUsersEmpty {
  1192. var users []model.User
  1193. if err := db.Find(&users).Error; err != nil {
  1194. log.Printf("Error fetching users for password migration: %v", err)
  1195. return err
  1196. }
  1197. for _, user := range users {
  1198. if crypto.IsHashed(user.Password) {
  1199. continue
  1200. }
  1201. hashedPassword, err := crypto.HashPasswordAsBcrypt(user.Password)
  1202. if err != nil {
  1203. log.Printf("Error hashing password for user '%s': %v", user.Username, err)
  1204. return err
  1205. }
  1206. if err := db.Model(&user).Update("password", hashedPassword).Error; err != nil {
  1207. log.Printf("Error updating password for user '%s': %v", user.Username, err)
  1208. return err
  1209. }
  1210. }
  1211. hashSeeder := &model.HistoryOfSeeders{
  1212. SeederName: "UserPasswordHash",
  1213. }
  1214. if err := db.Create(hashSeeder).Error; err != nil {
  1215. return err
  1216. }
  1217. }
  1218. if !slices.Contains(seedersHistory, "ApiTokensTable") {
  1219. if err := seedApiTokens(); err != nil {
  1220. return err
  1221. }
  1222. }
  1223. if !slices.Contains(seedersHistory, "ApiTokensHash") {
  1224. if err := hashExistingApiTokens(); err != nil {
  1225. return err
  1226. }
  1227. }
  1228. if !slices.Contains(seedersHistory, "ClientsTable") {
  1229. if err := seedClientsFromInboundJSON(); err != nil {
  1230. return err
  1231. }
  1232. }
  1233. if !slices.Contains(seedersHistory, "InboundClientsArrayFix") {
  1234. if err := normalizeInboundClientsArray(); err != nil {
  1235. return err
  1236. }
  1237. }
  1238. if !slices.Contains(seedersHistory, "InboundClientTgIdFix2") {
  1239. if err := normalizeInboundClientTgId(); err != nil {
  1240. return err
  1241. }
  1242. }
  1243. if !slices.Contains(seedersHistory, "InboundClientSubIdFix") {
  1244. if err := normalizeInboundClientSubId(); err != nil {
  1245. return err
  1246. }
  1247. }
  1248. if !slices.Contains(seedersHistory, "FreedomFinalRulesReverseFix") {
  1249. if err := normalizeFreedomFinalRules(); err != nil {
  1250. return err
  1251. }
  1252. }
  1253. if !slices.Contains(seedersHistory, "FreedomFinalRulesPrivateEgressBlock") {
  1254. if err := hardenFreedomFinalRules(); err != nil {
  1255. return err
  1256. }
  1257. }
  1258. if !slices.Contains(seedersHistory, "InboundRealityFinalmaskTcpStrip") {
  1259. if err := stripRealityFinalmaskTcp(); err != nil {
  1260. return err
  1261. }
  1262. }
  1263. if !slices.Contains(seedersHistory, "LegacyProxySettingsCleanup") {
  1264. if err := clearLegacyProxySettings(); err != nil {
  1265. return err
  1266. }
  1267. }
  1268. if !slices.Contains(seedersHistory, "OutboundRemovedKeysFix") {
  1269. if err := migrateOutboundRemovedKeys(); err != nil {
  1270. return err
  1271. }
  1272. }
  1273. if !slices.Contains(seedersHistory, "NodeInboundsAdopted") {
  1274. if err := seedNodeInboundsAdopted(); err != nil {
  1275. return err
  1276. }
  1277. }
  1278. if err := seedHostsFromExternalProxy(); err != nil {
  1279. return err
  1280. }
  1281. if err := seedMtprotoCustomShareAddrToHosts(); err != nil {
  1282. return err
  1283. }
  1284. if err := resetIpLimitsWithoutFail2ban(); err != nil {
  1285. return err
  1286. }
  1287. if err := seedWireguardPeersToClients(); err != nil {
  1288. return err
  1289. }
  1290. if err := backfillEmptyHostGroupIds(); err != nil {
  1291. return err
  1292. }
  1293. // Self-gated on the "MtprotoSecretsToClients" row.
  1294. if err := seedMtprotoSecretsToClients(); err != nil {
  1295. return err
  1296. }
  1297. // Self-gated on the "StripMtprotoInboundSecrets" row. Must run after the
  1298. // seeder above so legacy single-secret inbounds are first converted to a
  1299. // client (which preserves the secret) before the inbound-level copy is
  1300. // dropped from every mtproto inbound.
  1301. if err := stripMtprotoInboundSecrets(); err != nil {
  1302. return err
  1303. }
  1304. // Idempotent, not seeder-gated: bad values can re-enter via a restored
  1305. // backup, so re-check on every start.
  1306. return normalizeSettingPaths()
  1307. }
  1308. // seedNodeInboundsAdopted keeps the pre-existing reconcile behavior for nodes
  1309. // that were already syncing before the inbounds_adopted_at gate was introduced.
  1310. func seedNodeInboundsAdopted() error {
  1311. if err := db.Model(&model.Node{}).
  1312. Where("inbounds_adopted_at = 0").
  1313. Update("inbounds_adopted_at", time.Now().Unix()).Error; err != nil {
  1314. return err
  1315. }
  1316. return db.Create(&model.HistoryOfSeeders{SeederName: "NodeInboundsAdopted"}).Error
  1317. }
  1318. // backfillEmptyHostGroupIds is idempotent and not seeder-gated: builds that
  1319. // predate group ids on the inbound-import path (and restored backups) can
  1320. // re-introduce hosts rows with an empty group_id, and such rows render as a
  1321. // synthetic fallback_<id> group the update/delete API cannot address, so
  1322. // re-check on every start.
  1323. func backfillEmptyHostGroupIds() error {
  1324. var hosts []*model.Host
  1325. if err := db.Where("group_id = '' OR group_id IS NULL").Find(&hosts).Error; err != nil {
  1326. return err
  1327. }
  1328. if len(hosts) == 0 {
  1329. return nil
  1330. }
  1331. return db.Transaction(func(tx *gorm.DB) error {
  1332. for _, h := range hosts {
  1333. if err := tx.Model(h).Update("group_id", random.NumLower(16)).Error; err != nil {
  1334. return err
  1335. }
  1336. }
  1337. return nil
  1338. })
  1339. }
  1340. func resetIpLimitsWithoutFail2ban() error {
  1341. var history []string
  1342. if err := db.Model(&model.HistoryOfSeeders{}).Pluck("seeder_name", &history).Error; err != nil {
  1343. return err
  1344. }
  1345. if slices.Contains(history, "ResetIpLimitNoFail2ban") {
  1346. return nil
  1347. }
  1348. state, probeErr := fail2banEnforcementState()
  1349. if state == fail2banEnforcing {
  1350. return db.Create(&model.HistoryOfSeeders{SeederName: "ResetIpLimitNoFail2ban"}).Error
  1351. }
  1352. if state == fail2banUnknown {
  1353. log.Printf("ResetIpLimitNoFail2ban: fail2ban-client present but not runnable (%v); keeping configured IP limits, will retry next start", probeErr)
  1354. return nil
  1355. }
  1356. var inbounds []model.Inbound
  1357. if err := db.Find(&inbounds).Error; err != nil {
  1358. return err
  1359. }
  1360. return db.Transaction(func(tx *gorm.DB) error {
  1361. for _, inbound := range inbounds {
  1362. if strings.TrimSpace(inbound.Settings) == "" {
  1363. continue
  1364. }
  1365. var settings map[string]any
  1366. if err := json.Unmarshal([]byte(inbound.Settings), &settings); err != nil {
  1367. log.Printf("ResetIpLimitNoFail2ban: skip inbound %d (invalid settings json): %v", inbound.Id, err)
  1368. continue
  1369. }
  1370. clients, ok := settings["clients"].([]any)
  1371. if !ok {
  1372. continue
  1373. }
  1374. mutated := false
  1375. for i, raw := range clients {
  1376. obj, ok := raw.(map[string]any)
  1377. if !ok {
  1378. continue
  1379. }
  1380. v, present := obj["limitIp"]
  1381. if !present {
  1382. continue
  1383. }
  1384. if n, isNum := v.(float64); isNum && n == 0 {
  1385. continue
  1386. }
  1387. obj["limitIp"] = 0
  1388. clients[i] = obj
  1389. mutated = true
  1390. }
  1391. if !mutated {
  1392. continue
  1393. }
  1394. settings["clients"] = clients
  1395. newSettings, err := json.MarshalIndent(settings, "", " ")
  1396. if err != nil {
  1397. log.Printf("ResetIpLimitNoFail2ban: skip inbound %d (marshal failed): %v", inbound.Id, err)
  1398. continue
  1399. }
  1400. if err := tx.Model(&model.Inbound{}).Where("id = ?", inbound.Id).
  1401. Update("settings", string(newSettings)).Error; err != nil {
  1402. return err
  1403. }
  1404. }
  1405. if err := tx.Model(&model.ClientRecord{}).Where("limit_ip <> ?", 0).
  1406. Update("limit_ip", 0).Error; err != nil {
  1407. return err
  1408. }
  1409. return tx.Create(&model.HistoryOfSeeders{SeederName: "ResetIpLimitNoFail2ban"}).Error
  1410. })
  1411. }
  1412. type fail2banState int
  1413. const (
  1414. fail2banEnforcing fail2banState = iota
  1415. fail2banAbsent
  1416. fail2banUnknown
  1417. )
  1418. // fail2banEnforcementState separates "fail2ban is not installed" from "the probe
  1419. // itself failed", so a transient failure never drives an irreversible cleanup.
  1420. func fail2banEnforcementState() (fail2banState, error) {
  1421. if v, ok := os.LookupEnv("XUI_ENABLE_FAIL2BAN"); ok && v != "true" {
  1422. return fail2banAbsent, nil
  1423. }
  1424. if runtime.GOOS == "windows" {
  1425. return fail2banAbsent, nil
  1426. }
  1427. if _, err := exec.LookPath("fail2ban-client"); err != nil {
  1428. return fail2banAbsent, nil
  1429. }
  1430. if err := exec.CommandContext(context.Background(), "fail2ban-client", "-h").Run(); err != nil {
  1431. return fail2banUnknown, err
  1432. }
  1433. return fail2banEnforcing, nil
  1434. }
  1435. func clearLegacyProxySettings() error {
  1436. return db.Transaction(func(tx *gorm.DB) error {
  1437. if err := tx.Where("key IN ?", []string{"panelProxy", "tgBotProxy"}).
  1438. Delete(&model.Setting{}).Error; err != nil {
  1439. return err
  1440. }
  1441. return tx.Create(&model.HistoryOfSeeders{SeederName: "LegacyProxySettingsCleanup"}).Error
  1442. })
  1443. }
  1444. func migrateOutboundRemovedKeys() error {
  1445. var setting model.Setting
  1446. err := db.Model(model.Setting{}).Where("key = ?", "xrayTemplateConfig").First(&setting).Error
  1447. if errors.Is(err, gorm.ErrRecordNotFound) {
  1448. return db.Create(&model.HistoryOfSeeders{SeederName: "OutboundRemovedKeysFix"}).Error
  1449. }
  1450. if err != nil {
  1451. return err
  1452. }
  1453. updated, changed, rErr := rewriteRemovedOutboundKeys(setting.Value)
  1454. if rErr != nil {
  1455. log.Printf("OutboundRemovedKeysFix: skip (invalid xrayTemplateConfig json): %v", rErr)
  1456. return db.Create(&model.HistoryOfSeeders{SeederName: "OutboundRemovedKeysFix"}).Error
  1457. }
  1458. return db.Transaction(func(tx *gorm.DB) error {
  1459. if changed {
  1460. if err := tx.Model(&model.Setting{}).Where("key = ?", "xrayTemplateConfig").
  1461. Update("value", updated).Error; err != nil {
  1462. return err
  1463. }
  1464. }
  1465. return tx.Create(&model.HistoryOfSeeders{SeederName: "OutboundRemovedKeysFix"}).Error
  1466. })
  1467. }
  1468. // rewriteRemovedOutboundKeys moves outbound proxySettings.tag to sockopt.dialerProxy
  1469. // and drops freedom sockopt.addressPortStrategy: xray-core v26.9.8 refuses both.
  1470. func rewriteRemovedOutboundKeys(raw string) (string, bool, error) {
  1471. if strings.TrimSpace(raw) == "" {
  1472. return raw, false, nil
  1473. }
  1474. var cfg map[string]any
  1475. if err := json.Unmarshal([]byte(raw), &cfg); err != nil {
  1476. return raw, false, err
  1477. }
  1478. outbounds, ok := cfg["outbounds"].([]any)
  1479. if !ok {
  1480. return raw, false, nil
  1481. }
  1482. changed := false
  1483. for _, ob := range outbounds {
  1484. obj, ok := ob.(map[string]any)
  1485. if !ok {
  1486. continue
  1487. }
  1488. if proxySettings, present := obj["proxySettings"]; present {
  1489. ps, _ := proxySettings.(map[string]any)
  1490. if tag, _ := ps["tag"].(string); tag != "" {
  1491. sockopt := outboundSockopt(obj, true)
  1492. if current, _ := sockopt["dialerProxy"].(string); current == "" {
  1493. sockopt["dialerProxy"] = tag
  1494. }
  1495. }
  1496. delete(obj, "proxySettings")
  1497. changed = true
  1498. }
  1499. if proto, _ := obj["protocol"].(string); proto == "freedom" {
  1500. if sockopt := outboundSockopt(obj, false); sockopt != nil {
  1501. if _, present := sockopt["addressPortStrategy"]; present {
  1502. delete(sockopt, "addressPortStrategy")
  1503. changed = true
  1504. }
  1505. }
  1506. }
  1507. }
  1508. if !changed {
  1509. return raw, false, nil
  1510. }
  1511. out, err := json.MarshalIndent(cfg, "", " ")
  1512. if err != nil {
  1513. return raw, false, err
  1514. }
  1515. return string(out), true, nil
  1516. }
  1517. func outboundSockopt(obj map[string]any, create bool) map[string]any {
  1518. stream, _ := obj["streamSettings"].(map[string]any)
  1519. if stream == nil {
  1520. if !create {
  1521. return nil
  1522. }
  1523. stream = map[string]any{}
  1524. obj["streamSettings"] = stream
  1525. }
  1526. sockopt, _ := stream["sockopt"].(map[string]any)
  1527. if sockopt == nil {
  1528. if !create {
  1529. return nil
  1530. }
  1531. sockopt = map[string]any{}
  1532. stream["sockopt"] = sockopt
  1533. }
  1534. return sockopt
  1535. }
  1536. func normalizeSettingPaths() error {
  1537. pathKeys := []string{"webBasePath", "subPath", "subJsonPath", "subClashPath"}
  1538. var rows []model.Setting
  1539. if err := db.Where("key IN ?", pathKeys).Find(&rows).Error; err != nil {
  1540. return err
  1541. }
  1542. for _, row := range rows {
  1543. fixed := row.Value
  1544. if !strings.HasPrefix(fixed, "/") {
  1545. fixed = "/" + fixed
  1546. }
  1547. if !strings.HasSuffix(fixed, "/") {
  1548. fixed += "/"
  1549. }
  1550. if fixed == row.Value {
  1551. continue
  1552. }
  1553. if err := db.Model(&model.Setting{}).Where("id = ?", row.Id).
  1554. Update("value", fixed).Error; err != nil {
  1555. return err
  1556. }
  1557. }
  1558. return nil
  1559. }
  1560. func normalizeInboundClientTgId() error {
  1561. var inbounds []model.Inbound
  1562. if err := db.Find(&inbounds).Error; err != nil {
  1563. return err
  1564. }
  1565. return db.Transaction(func(tx *gorm.DB) error {
  1566. for _, inbound := range inbounds {
  1567. if strings.TrimSpace(inbound.Settings) == "" {
  1568. continue
  1569. }
  1570. var settings map[string]any
  1571. if err := json.Unmarshal([]byte(inbound.Settings), &settings); err != nil {
  1572. log.Printf("InboundClientTgIdFix: skip inbound %d (invalid settings json): %v", inbound.Id, err)
  1573. continue
  1574. }
  1575. clients, ok := settings["clients"].([]any)
  1576. if !ok {
  1577. continue
  1578. }
  1579. mutated := false
  1580. for i, raw := range clients {
  1581. obj, ok := raw.(map[string]any)
  1582. if !ok {
  1583. continue
  1584. }
  1585. tgRaw, present := obj["tgId"]
  1586. if !present {
  1587. continue
  1588. }
  1589. v, isFloat := tgRaw.(float64)
  1590. if isFloat && !math.IsNaN(v) && !math.IsInf(v, 0) && v == math.Trunc(v) {
  1591. continue
  1592. }
  1593. obj["tgId"] = int64(0)
  1594. if s, isStr := tgRaw.(string); isStr {
  1595. if id, err := strconv.ParseInt(strings.ReplaceAll(strings.TrimSpace(s), " ", ""), 10, 64); err == nil {
  1596. obj["tgId"] = id
  1597. }
  1598. }
  1599. clients[i] = obj
  1600. mutated = true
  1601. }
  1602. if !mutated {
  1603. continue
  1604. }
  1605. settings["clients"] = clients
  1606. newSettings, err := json.MarshalIndent(settings, "", " ")
  1607. if err != nil {
  1608. log.Printf("InboundClientTgIdFix: skip inbound %d (marshal failed): %v", inbound.Id, err)
  1609. continue
  1610. }
  1611. if err := tx.Model(&model.Inbound{}).Where("id = ?", inbound.Id).
  1612. Update("settings", string(newSettings)).Error; err != nil {
  1613. return err
  1614. }
  1615. }
  1616. return tx.Create(&model.HistoryOfSeeders{SeederName: "InboundClientTgIdFix2"}).Error
  1617. })
  1618. }
  1619. func normalizeInboundClientSubId() error {
  1620. var inbounds []model.Inbound
  1621. if err := db.Find(&inbounds).Error; err != nil {
  1622. return err
  1623. }
  1624. return db.Transaction(func(tx *gorm.DB) error {
  1625. for _, inbound := range inbounds {
  1626. if strings.TrimSpace(inbound.Settings) == "" {
  1627. continue
  1628. }
  1629. var settings map[string]any
  1630. if err := json.Unmarshal([]byte(inbound.Settings), &settings); err != nil {
  1631. log.Printf("InboundClientSubIdFix: skip inbound %d (invalid settings json): %v", inbound.Id, err)
  1632. continue
  1633. }
  1634. clients, ok := settings["clients"].([]any)
  1635. if !ok {
  1636. continue
  1637. }
  1638. mutated := false
  1639. for i, raw := range clients {
  1640. obj, ok := raw.(map[string]any)
  1641. if !ok {
  1642. continue
  1643. }
  1644. existing, _ := obj["subId"].(string)
  1645. if strings.TrimSpace(existing) != "" {
  1646. continue
  1647. }
  1648. obj["subId"] = random.NumLower(16)
  1649. clients[i] = obj
  1650. mutated = true
  1651. }
  1652. if !mutated {
  1653. continue
  1654. }
  1655. settings["clients"] = clients
  1656. newSettings, err := json.MarshalIndent(settings, "", " ")
  1657. if err != nil {
  1658. log.Printf("InboundClientSubIdFix: skip inbound %d (marshal failed): %v", inbound.Id, err)
  1659. continue
  1660. }
  1661. if err := tx.Model(&model.Inbound{}).Where("id = ?", inbound.Id).
  1662. Update("settings", string(newSettings)).Error; err != nil {
  1663. return err
  1664. }
  1665. }
  1666. return tx.Create(&model.HistoryOfSeeders{SeederName: "InboundClientSubIdFix"}).Error
  1667. })
  1668. }
  1669. func normalizeInboundClientsArray() error {
  1670. var inbounds []model.Inbound
  1671. if err := db.Find(&inbounds).Error; err != nil {
  1672. return err
  1673. }
  1674. return db.Transaction(func(tx *gorm.DB) error {
  1675. for _, inbound := range inbounds {
  1676. if strings.TrimSpace(inbound.Settings) == "" {
  1677. continue
  1678. }
  1679. var settings map[string]any
  1680. if err := json.Unmarshal([]byte(inbound.Settings), &settings); err != nil {
  1681. log.Printf("InboundClientsArrayFix: skip inbound %d (invalid settings json): %v", inbound.Id, err)
  1682. continue
  1683. }
  1684. raw, exists := settings["clients"]
  1685. if !exists || raw != nil {
  1686. continue
  1687. }
  1688. settings["clients"] = []any{}
  1689. newSettings, err := json.MarshalIndent(settings, "", " ")
  1690. if err != nil {
  1691. log.Printf("InboundClientsArrayFix: skip inbound %d (marshal failed): %v", inbound.Id, err)
  1692. continue
  1693. }
  1694. if err := tx.Model(&model.Inbound{}).Where("id = ?", inbound.Id).
  1695. Update("settings", string(newSettings)).Error; err != nil {
  1696. return err
  1697. }
  1698. }
  1699. return tx.Create(&model.HistoryOfSeeders{SeederName: "InboundClientsArrayFix"}).Error
  1700. })
  1701. }
  1702. func normalizeFreedomFinalRules() error {
  1703. var setting model.Setting
  1704. err := db.Model(model.Setting{}).Where("key = ?", "xrayTemplateConfig").First(&setting).Error
  1705. if errors.Is(err, gorm.ErrRecordNotFound) {
  1706. return db.Create(&model.HistoryOfSeeders{SeederName: "FreedomFinalRulesReverseFix"}).Error
  1707. }
  1708. if err != nil {
  1709. return err
  1710. }
  1711. updated, changed, rErr := rewriteFreedomFinalRules(setting.Value)
  1712. if rErr != nil {
  1713. log.Printf("FreedomFinalRulesReverseFix: skip (invalid xrayTemplateConfig json): %v", rErr)
  1714. return db.Create(&model.HistoryOfSeeders{SeederName: "FreedomFinalRulesReverseFix"}).Error
  1715. }
  1716. return db.Transaction(func(tx *gorm.DB) error {
  1717. if changed {
  1718. if err := tx.Model(&model.Setting{}).Where("key = ?", "xrayTemplateConfig").
  1719. Update("value", updated).Error; err != nil {
  1720. return err
  1721. }
  1722. }
  1723. return tx.Create(&model.HistoryOfSeeders{SeederName: "FreedomFinalRulesReverseFix"}).Error
  1724. })
  1725. }
  1726. func rewriteFreedomFinalRules(raw string) (string, bool, error) {
  1727. if strings.TrimSpace(raw) == "" {
  1728. return raw, false, nil
  1729. }
  1730. var cfg map[string]any
  1731. if err := json.Unmarshal([]byte(raw), &cfg); err != nil {
  1732. return raw, false, err
  1733. }
  1734. outbounds, ok := cfg["outbounds"].([]any)
  1735. if !ok {
  1736. return raw, false, nil
  1737. }
  1738. changed := false
  1739. for _, ob := range outbounds {
  1740. obj, ok := ob.(map[string]any)
  1741. if !ok {
  1742. continue
  1743. }
  1744. if proto, _ := obj["protocol"].(string); proto != "freedom" {
  1745. continue
  1746. }
  1747. settings, ok := obj["settings"].(map[string]any)
  1748. if !ok {
  1749. continue
  1750. }
  1751. if !isLegacyPrivateOnlyFinalRules(settings["finalRules"]) {
  1752. continue
  1753. }
  1754. settings["finalRules"] = []any{map[string]any{"action": "allow"}}
  1755. changed = true
  1756. }
  1757. if !changed {
  1758. return raw, false, nil
  1759. }
  1760. out, err := json.MarshalIndent(cfg, "", " ")
  1761. if err != nil {
  1762. return raw, false, err
  1763. }
  1764. return string(out), true, nil
  1765. }
  1766. func isLegacyPrivateOnlyFinalRules(v any) bool {
  1767. rules, ok := v.([]any)
  1768. if !ok || len(rules) != 1 {
  1769. return false
  1770. }
  1771. rule, ok := rules[0].(map[string]any)
  1772. if !ok {
  1773. return false
  1774. }
  1775. if action, _ := rule["action"].(string); action != "allow" {
  1776. return false
  1777. }
  1778. ips, ok := rule["ip"].([]any)
  1779. if !ok || len(ips) != 1 {
  1780. return false
  1781. }
  1782. if s, _ := ips[0].(string); s != "geoip:private" {
  1783. return false
  1784. }
  1785. for k := range rule {
  1786. if k != "action" && k != "ip" {
  1787. return false
  1788. }
  1789. }
  1790. return true
  1791. }
  1792. func isUnrestrictedFreedomFinalRules(v any, present bool) bool {
  1793. if !present || v == nil {
  1794. return true
  1795. }
  1796. rules, ok := v.([]any)
  1797. return ok && len(rules) == 0
  1798. }
  1799. func hardenFreedomFinalRules() error {
  1800. var setting model.Setting
  1801. err := db.Model(model.Setting{}).Where("key = ?", "xrayTemplateConfig").First(&setting).Error
  1802. if errors.Is(err, gorm.ErrRecordNotFound) {
  1803. return db.Create(&model.HistoryOfSeeders{SeederName: "FreedomFinalRulesPrivateEgressBlock"}).Error
  1804. }
  1805. if err != nil {
  1806. return err
  1807. }
  1808. updated, changed, rErr := rewriteFreedomFinalRulesPrivateEgress(setting.Value)
  1809. if rErr != nil {
  1810. log.Printf("FreedomFinalRulesPrivateEgressBlock: skip (invalid xrayTemplateConfig json): %v", rErr)
  1811. return db.Create(&model.HistoryOfSeeders{SeederName: "FreedomFinalRulesPrivateEgressBlock"}).Error
  1812. }
  1813. return db.Transaction(func(tx *gorm.DB) error {
  1814. if changed {
  1815. if err := tx.Model(&model.Setting{}).Where("key = ?", "xrayTemplateConfig").
  1816. Update("value", updated).Error; err != nil {
  1817. return err
  1818. }
  1819. }
  1820. return tx.Create(&model.HistoryOfSeeders{SeederName: "FreedomFinalRulesPrivateEgressBlock"}).Error
  1821. })
  1822. }
  1823. func rewriteFreedomFinalRulesPrivateEgress(raw string) (string, bool, error) {
  1824. if strings.TrimSpace(raw) == "" {
  1825. return raw, false, nil
  1826. }
  1827. var cfg map[string]any
  1828. if err := json.Unmarshal([]byte(raw), &cfg); err != nil {
  1829. return raw, false, err
  1830. }
  1831. outbounds, ok := cfg["outbounds"].([]any)
  1832. if !ok {
  1833. return raw, false, nil
  1834. }
  1835. changed := false
  1836. for _, ob := range outbounds {
  1837. obj, ok := ob.(map[string]any)
  1838. if !ok {
  1839. continue
  1840. }
  1841. if proto, _ := obj["protocol"].(string); proto != "freedom" {
  1842. continue
  1843. }
  1844. settings, ok := obj["settings"].(map[string]any)
  1845. if !ok {
  1846. continue
  1847. }
  1848. finalRules, present := settings["finalRules"]
  1849. if !isUnrestrictedFreedomFinalRules(finalRules, present) &&
  1850. !isAllowOnlyFinalRules(finalRules) &&
  1851. !isLegacyPrivateOnlyFinalRules(finalRules) {
  1852. continue
  1853. }
  1854. settings["finalRules"] = []any{
  1855. map[string]any{"action": "block", "ip": []any{"geoip:private"}},
  1856. map[string]any{"action": "allow"},
  1857. }
  1858. changed = true
  1859. }
  1860. if !changed {
  1861. return raw, false, nil
  1862. }
  1863. out, err := json.MarshalIndent(cfg, "", " ")
  1864. if err != nil {
  1865. return raw, false, err
  1866. }
  1867. return string(out), true, nil
  1868. }
  1869. func stripRealityFinalmaskTcp() error {
  1870. var inbounds []model.Inbound
  1871. if err := db.Find(&inbounds).Error; err != nil {
  1872. return err
  1873. }
  1874. return db.Transaction(func(tx *gorm.DB) error {
  1875. for i := range inbounds {
  1876. updated, changed := stripRealityFinalmaskTcpFromStream(inbounds[i].StreamSettings)
  1877. if !changed {
  1878. continue
  1879. }
  1880. if err := tx.Model(&model.Inbound{}).Where("id = ?", inbounds[i].Id).
  1881. Update("stream_settings", updated).Error; err != nil {
  1882. return err
  1883. }
  1884. log.Printf("InboundRealityFinalmaskTcpStrip: removed finalmask.tcp from REALITY inbound %d (%s)", inbounds[i].Id, inbounds[i].Tag)
  1885. }
  1886. return tx.Create(&model.HistoryOfSeeders{SeederName: "InboundRealityFinalmaskTcpStrip"}).Error
  1887. })
  1888. }
  1889. func stripRealityFinalmaskTcpFromStream(raw string) (string, bool) {
  1890. if strings.TrimSpace(raw) == "" {
  1891. return raw, false
  1892. }
  1893. var stream map[string]any
  1894. if err := json.Unmarshal([]byte(raw), &stream); err != nil {
  1895. return raw, false
  1896. }
  1897. if sec, _ := stream["security"].(string); sec != "reality" {
  1898. return raw, false
  1899. }
  1900. finalmask, ok := stream["finalmask"].(map[string]any)
  1901. if !ok {
  1902. return raw, false
  1903. }
  1904. if tcp, _ := finalmask["tcp"].([]any); len(tcp) == 0 {
  1905. return raw, false
  1906. }
  1907. delete(finalmask, "tcp")
  1908. if len(finalmask) == 0 {
  1909. delete(stream, "finalmask")
  1910. }
  1911. out, err := json.Marshal(stream)
  1912. if err != nil {
  1913. return raw, false
  1914. }
  1915. return string(out), true
  1916. }
  1917. func isAllowOnlyFinalRules(v any) bool {
  1918. rules, ok := v.([]any)
  1919. if !ok || len(rules) != 1 {
  1920. return false
  1921. }
  1922. rule, ok := rules[0].(map[string]any)
  1923. if !ok {
  1924. return false
  1925. }
  1926. if action, _ := rule["action"].(string); action != "allow" {
  1927. return false
  1928. }
  1929. for k := range rule {
  1930. if k != "action" {
  1931. return false
  1932. }
  1933. }
  1934. return true
  1935. }
  1936. func normalizeClientJSONFields(obj map[string]any) {
  1937. normalizeInt := func(key string) {
  1938. raw, exists := obj[key]
  1939. if !exists {
  1940. return
  1941. }
  1942. s, ok := raw.(string)
  1943. if !ok {
  1944. return
  1945. }
  1946. trimmed := strings.ReplaceAll(strings.TrimSpace(s), " ", "")
  1947. if trimmed == "" {
  1948. delete(obj, key)
  1949. return
  1950. }
  1951. if n, err := strconv.ParseInt(trimmed, 10, 64); err == nil {
  1952. obj[key] = n
  1953. } else {
  1954. delete(obj, key)
  1955. }
  1956. }
  1957. for _, k := range []string{"tgId", "limitIp", "totalGB", "expiryTime", "reset", "created_at", "updated_at"} {
  1958. normalizeInt(k)
  1959. }
  1960. }
  1961. func seedClientsFromInboundJSON() error {
  1962. var inbounds []model.Inbound
  1963. if err := db.Find(&inbounds).Error; err != nil {
  1964. return err
  1965. }
  1966. return db.Transaction(func(tx *gorm.DB) error {
  1967. byEmail := map[string]*model.ClientRecord{}
  1968. var existing []model.ClientRecord
  1969. if err := tx.Find(&existing).Error; err != nil {
  1970. return err
  1971. }
  1972. for i := range existing {
  1973. byEmail[existing[i].Email] = &existing[i]
  1974. }
  1975. for _, inbound := range inbounds {
  1976. if strings.TrimSpace(inbound.Settings) == "" {
  1977. continue
  1978. }
  1979. var settings map[string]any
  1980. if err := json.Unmarshal([]byte(inbound.Settings), &settings); err != nil {
  1981. log.Printf("ClientsTable seed: skip inbound %d (invalid settings json): %v", inbound.Id, err)
  1982. continue
  1983. }
  1984. rawList, ok := settings["clients"].([]any)
  1985. if !ok {
  1986. continue
  1987. }
  1988. for _, raw := range rawList {
  1989. obj, ok := raw.(map[string]any)
  1990. if !ok {
  1991. continue
  1992. }
  1993. normalizeClientJSONFields(obj)
  1994. blob, err := json.Marshal(obj)
  1995. if err != nil {
  1996. continue
  1997. }
  1998. var c model.Client
  1999. if err := json.Unmarshal(blob, &c); err != nil {
  2000. log.Printf("ClientsTable seed: skip client in inbound %d (unmarshal failed): %v; payload=%s",
  2001. inbound.Id, err, string(blob))
  2002. continue
  2003. }
  2004. email := strings.TrimSpace(c.Email)
  2005. if email == "" {
  2006. continue
  2007. }
  2008. incoming := c.ToRecord()
  2009. row, dup := byEmail[email]
  2010. if !dup {
  2011. if err := tx.Create(incoming).Error; err != nil {
  2012. return err
  2013. }
  2014. byEmail[email] = incoming
  2015. row = incoming
  2016. } else {
  2017. conflicts := model.MergeClientRecord(row, incoming)
  2018. for _, x := range conflicts {
  2019. log.Printf("client merge: email=%s conflict on %s old=%v new=%v kept=%v",
  2020. email, x.Field, x.Old, x.New, x.Kept)
  2021. }
  2022. if err := tx.Save(row).Error; err != nil {
  2023. return err
  2024. }
  2025. }
  2026. link := model.ClientInbound{
  2027. ClientId: row.Id,
  2028. InboundId: inbound.Id,
  2029. FlowOverride: c.Flow,
  2030. }
  2031. if err := tx.Where("client_id = ? AND inbound_id = ?", row.Id, inbound.Id).
  2032. FirstOrCreate(&link).Error; err != nil {
  2033. return err
  2034. }
  2035. }
  2036. }
  2037. return tx.Create(&model.HistoryOfSeeders{SeederName: "ClientsTable"}).Error
  2038. })
  2039. }
  2040. func seedApiTokens() error {
  2041. empty, err := isTableEmpty("api_tokens")
  2042. if err != nil {
  2043. return err
  2044. }
  2045. if empty {
  2046. var legacy model.Setting
  2047. err := db.Model(model.Setting{}).Where("key = ?", "apiToken").First(&legacy).Error
  2048. if err == nil && legacy.Value != "" {
  2049. row := &model.ApiToken{
  2050. Name: "default",
  2051. Token: legacy.Value,
  2052. Enabled: true,
  2053. }
  2054. if err := db.Create(row).Error; err != nil {
  2055. log.Printf("Error migrating legacy apiToken: %v", err)
  2056. return err
  2057. }
  2058. }
  2059. }
  2060. return db.Create(&model.HistoryOfSeeders{SeederName: "ApiTokensTable"}).Error
  2061. }
  2062. func hashExistingApiTokens() error {
  2063. var rows []*model.ApiToken
  2064. if err := db.Find(&rows).Error; err != nil {
  2065. return err
  2066. }
  2067. for _, r := range rows {
  2068. if crypto.IsSHA256Hex(r.Token) {
  2069. continue
  2070. }
  2071. hashed := crypto.HashTokenSHA256(r.Token)
  2072. if err := db.Model(model.ApiToken{}).Where("id = ?", r.Id).Update("token", hashed).Error; err != nil {
  2073. log.Printf("Error hashing api token %d: %v", r.Id, err)
  2074. return err
  2075. }
  2076. }
  2077. return db.Create(&model.HistoryOfSeeders{SeederName: "ApiTokensHash"}).Error
  2078. }
  2079. func isTableEmpty(tableName string) (bool, error) {
  2080. var count int64
  2081. err := db.Table(tableName).Count(&count).Error
  2082. return count == 0, err
  2083. }
  2084. func InitDB(dbPath string) error {
  2085. var gormLogger logger.Interface
  2086. if config.IsDebug() {
  2087. gormLogger = logger.New(
  2088. log.New(os.Stdout, "\r\n", log.LstdFlags),
  2089. logger.Config{
  2090. SlowThreshold: time.Second,
  2091. LogLevel: logger.Info,
  2092. IgnoreRecordNotFoundError: true,
  2093. Colorful: true,
  2094. },
  2095. )
  2096. } else {
  2097. gormLogger = logger.Discard
  2098. }
  2099. c := &gorm.Config{Logger: gormLogger, DisableForeignKeyConstraintWhenMigrating: true}
  2100. var err error
  2101. switch config.GetDBKind() {
  2102. case "postgres":
  2103. dsn := config.GetDBDSN()
  2104. if dsn == "" {
  2105. return errors.New("XUI_DB_TYPE=postgres but XUI_DB_DSN is empty")
  2106. }
  2107. db, err = openPostgresWithRetry(dsn, c)
  2108. if err != nil {
  2109. return err
  2110. }
  2111. default:
  2112. dir := path.Dir(dbPath)
  2113. if err = os.MkdirAll(dir, 0o700); err != nil {
  2114. return err
  2115. }
  2116. if err = cleanupSQLiteBackupDirs(filepath.Dir(dbPath)); err != nil {
  2117. log.Printf("clean SQLite backup directories: %v", err)
  2118. }
  2119. sync := sqliteSynchronous()
  2120. journal := sqliteJournalMode()
  2121. dsn := dbPath + "?_journal_mode=" + journal + "&_busy_timeout=10000&_synchronous=" + sync + "&_txlock=immediate"
  2122. db, err = gorm.Open(sqlite.Open(dsn), c)
  2123. if err != nil {
  2124. return err
  2125. }
  2126. if err := restrictSQLiteFilePerms(dbPath); err != nil {
  2127. log.Printf("restrict SQLite file permissions: %v", err)
  2128. }
  2129. sqlDB, err := db.DB()
  2130. if err != nil {
  2131. return err
  2132. }
  2133. pragmas := []string{
  2134. "PRAGMA journal_mode=" + journal,
  2135. "PRAGMA busy_timeout=10000",
  2136. "PRAGMA synchronous=" + sync,
  2137. fmt.Sprintf("PRAGMA cache_size=-%d", envInt("XUI_DB_CACHE_MB", 32)*1024),
  2138. fmt.Sprintf("PRAGMA mmap_size=%d", int64(envInt("XUI_DB_MMAP_MB", 256))*1024*1024),
  2139. "PRAGMA temp_store=MEMORY",
  2140. }
  2141. for _, p := range pragmas {
  2142. if _, err := sqlDB.ExecContext(context.Background(), p); err != nil {
  2143. return err
  2144. }
  2145. }
  2146. }
  2147. sqlDB, err := db.DB()
  2148. if err != nil {
  2149. return err
  2150. }
  2151. var maxOpen, maxIdle int
  2152. switch config.GetDBKind() {
  2153. case "postgres":
  2154. maxOpen = envInt("XUI_DB_MAX_OPEN_CONNS", 25)
  2155. maxIdle = envInt("XUI_DB_MAX_IDLE_CONNS", 25)
  2156. default:
  2157. maxOpen = envInt("XUI_DB_MAX_OPEN_CONNS", 8)
  2158. maxIdle = envInt("XUI_DB_MAX_IDLE_CONNS", 4)
  2159. }
  2160. sqlDB.SetMaxOpenConns(maxOpen)
  2161. sqlDB.SetMaxIdleConns(maxIdle)
  2162. sqlDB.SetConnMaxLifetime(time.Hour)
  2163. sqlDB.SetConnMaxIdleTime(30 * time.Minute)
  2164. if err := initModels(); err != nil {
  2165. return err
  2166. }
  2167. isUsersEmpty, err := isTableEmpty("users")
  2168. if err != nil {
  2169. return err
  2170. }
  2171. if isUsersEmpty {
  2172. if err := seedRandomSubscriptionPaths(); err != nil {
  2173. return err
  2174. }
  2175. }
  2176. if err := initUser(); err != nil {
  2177. return err
  2178. }
  2179. return runSeeders(isUsersEmpty)
  2180. }
  2181. func normalizeApiTokenCreatedAtSeconds() error {
  2182. return db.Model(&model.ApiToken{}).
  2183. Where("created_at >= ?", model.ApiTokenUnixMillisecondsThreshold).
  2184. UpdateColumn("created_at", gorm.Expr("created_at / ?", 1000)).Error
  2185. }
  2186. func migrateApiTokenScopeAndExpiry() error {
  2187. m := db.Migrator()
  2188. if !m.HasColumn(&model.ApiToken{}, "Scope") {
  2189. if err := m.AddColumn(&model.ApiToken{}, "Scope"); err != nil {
  2190. return err
  2191. }
  2192. }
  2193. if !m.HasColumn(&model.ApiToken{}, "ExpiresAt") {
  2194. if err := m.AddColumn(&model.ApiToken{}, "ExpiresAt"); err != nil {
  2195. return err
  2196. }
  2197. }
  2198. return db.Model(&model.ApiToken{}).Where("scope IS NULL OR TRIM(scope) = ''").
  2199. Updates(map[string]any{"scope": model.ApiScopeAdmin, "expires_at": 0}).Error
  2200. }
  2201. // openPostgresWithRetry retries the initial PostgreSQL connection with
  2202. // backoff so a database that starts slower than the panel (or drops out
  2203. // briefly) does not immediately kill the process and trip systemd's
  2204. // restart loop. Every failed attempt logs the real driver error, which
  2205. // used to be buried behind a generic startup failure.
  2206. func openPostgresWithRetry(dsn string, c *gorm.Config) (*gorm.DB, error) {
  2207. delays := []time.Duration{0, 2 * time.Second, 5 * time.Second, 10 * time.Second, 20 * time.Second, 30 * time.Second}
  2208. var lastErr error
  2209. for i, delay := range delays {
  2210. if delay > 0 {
  2211. time.Sleep(delay)
  2212. }
  2213. conn, err := gorm.Open(postgres.Open(dsn), c)
  2214. if err == nil {
  2215. if i > 0 {
  2216. log.Printf("postgres connection established on attempt %d/%d", i+1, len(delays))
  2217. }
  2218. return conn, nil
  2219. }
  2220. lastErr = err
  2221. log.Printf("postgres connection attempt %d/%d failed: %v", i+1, len(delays), err)
  2222. }
  2223. return nil, fmt.Errorf("postgres unreachable after %d attempts: %w", len(delays), lastErr)
  2224. }
  2225. // The store holds client secrets, so it and its WAL/SHM side files stay
  2226. // owner-only. Best effort: a store the panel cannot chmod still opens.
  2227. func restrictSQLiteFilePerms(dbPath string) error {
  2228. for _, name := range []string{dbPath, dbPath + "-wal", dbPath + "-shm"} {
  2229. if err := os.Chmod(name, 0o600); err != nil && !errors.Is(err, os.ErrNotExist) {
  2230. return err
  2231. }
  2232. }
  2233. return nil
  2234. }
  2235. func sqliteJournalMode() string {
  2236. switch strings.ToUpper(strings.TrimSpace(os.Getenv("XUI_DB_JOURNAL_MODE"))) {
  2237. case "DELETE":
  2238. return "DELETE"
  2239. default:
  2240. return "WAL"
  2241. }
  2242. }
  2243. func backupSQLiteStepPages() int {
  2244. if sqliteJournalMode() == "DELETE" {
  2245. return 128
  2246. }
  2247. return -1
  2248. }
  2249. func cleanupSQLiteBackupDirs(dir string) error {
  2250. entries, err := os.ReadDir(dir)
  2251. if errors.Is(err, os.ErrNotExist) {
  2252. return nil
  2253. }
  2254. if err != nil {
  2255. return err
  2256. }
  2257. for _, entry := range entries {
  2258. if entry.IsDir() && strings.HasPrefix(entry.Name(), sqliteBackupDirPrefix) {
  2259. if err := os.RemoveAll(filepath.Join(dir, entry.Name())); err != nil {
  2260. return err
  2261. }
  2262. }
  2263. }
  2264. return nil
  2265. }
  2266. func sqliteSynchronous() string {
  2267. switch strings.ToUpper(strings.TrimSpace(os.Getenv("XUI_DB_SYNCHRONOUS"))) {
  2268. case "OFF":
  2269. return "OFF"
  2270. case "NORMAL":
  2271. return "NORMAL"
  2272. case "EXTRA":
  2273. return "EXTRA"
  2274. default:
  2275. return "FULL"
  2276. }
  2277. }
  2278. func envInt(key string, def int) int {
  2279. v := strings.TrimSpace(os.Getenv(key))
  2280. if v == "" {
  2281. return def
  2282. }
  2283. n, err := strconv.Atoi(v)
  2284. if err != nil || n <= 0 {
  2285. return def
  2286. }
  2287. return n
  2288. }
  2289. func CloseDB() error {
  2290. if db != nil {
  2291. sqlDB, err := db.DB()
  2292. if err != nil {
  2293. return err
  2294. }
  2295. return sqlDB.Close()
  2296. }
  2297. return nil
  2298. }
  2299. func GetDB() *gorm.DB {
  2300. return db
  2301. }
  2302. func IsNotFound(err error) bool {
  2303. return errors.Is(err, gorm.ErrRecordNotFound)
  2304. }
  2305. func IsSQLiteDB(file io.ReaderAt) (bool, error) {
  2306. signature := []byte("SQLite format 3\x00")
  2307. buf := make([]byte, len(signature))
  2308. _, err := file.ReadAt(buf, 0)
  2309. if err != nil {
  2310. return false, err
  2311. }
  2312. return bytes.Equal(buf, signature), nil
  2313. }
  2314. func BackupSQLite(dstPath string) (err error) {
  2315. if IsPostgres() {
  2316. return errors.New("sqlite backup is unavailable for PostgreSQL")
  2317. }
  2318. if db == nil {
  2319. return errors.New("database is not initialized")
  2320. }
  2321. if _, err := os.Lstat(dstPath); err == nil {
  2322. return fmt.Errorf("sqlite backup destination already exists: %s", dstPath)
  2323. } else if !errors.Is(err, os.ErrNotExist) {
  2324. return err
  2325. }
  2326. defer func() {
  2327. if err != nil {
  2328. _ = os.Remove(dstPath)
  2329. }
  2330. }()
  2331. ctx, cancel := context.WithTimeout(context.Background(), backupSQLiteTimeout)
  2332. defer cancel()
  2333. sourceDB, err := db.DB()
  2334. if err != nil {
  2335. return err
  2336. }
  2337. sourceConn, err := sourceDB.Conn(ctx)
  2338. if err != nil {
  2339. return err
  2340. }
  2341. defer sourceConn.Close()
  2342. destinationDB, err := sql.Open("sqlite3", dstPath)
  2343. if err != nil {
  2344. return err
  2345. }
  2346. defer destinationDB.Close()
  2347. destinationConn, err := destinationDB.Conn(ctx)
  2348. if err != nil {
  2349. return err
  2350. }
  2351. defer destinationConn.Close()
  2352. return sourceConn.Raw(func(sourceDriver any) error {
  2353. source, ok := sourceDriver.(*sqlite3.SQLiteConn)
  2354. if !ok {
  2355. return fmt.Errorf("unexpected SQLite source connection type %T", sourceDriver)
  2356. }
  2357. return destinationConn.Raw(func(destinationDriver any) error {
  2358. destination, ok := destinationDriver.(*sqlite3.SQLiteConn)
  2359. if !ok {
  2360. return fmt.Errorf("unexpected SQLite destination connection type %T", destinationDriver)
  2361. }
  2362. backup, err := destination.Backup("main", source, "main")
  2363. if err != nil {
  2364. return err
  2365. }
  2366. finished := false
  2367. defer func() {
  2368. if !finished {
  2369. _ = backup.Finish()
  2370. }
  2371. }()
  2372. for {
  2373. done, err := backup.Step(backupSQLiteStepPages())
  2374. if err != nil {
  2375. return err
  2376. }
  2377. if done {
  2378. finished = true
  2379. return backup.Finish()
  2380. }
  2381. select {
  2382. case <-ctx.Done():
  2383. return ctx.Err()
  2384. case <-time.After(10 * time.Millisecond):
  2385. }
  2386. }
  2387. })
  2388. })
  2389. }
  2390. func ValidateSQLiteDB(dbPath string) error {
  2391. if _, err := os.Stat(dbPath); err != nil {
  2392. return err
  2393. }
  2394. gdb, err := gorm.Open(sqlite.Open(dbPath), &gorm.Config{Logger: logger.Discard})
  2395. if err != nil {
  2396. return err
  2397. }
  2398. sqlDB, err := gdb.DB()
  2399. if err != nil {
  2400. return err
  2401. }
  2402. defer sqlDB.Close()
  2403. var res string
  2404. if err := gdb.Raw("PRAGMA integrity_check;").Scan(&res).Error; err != nil {
  2405. return err
  2406. }
  2407. if res != "ok" {
  2408. return errors.New("sqlite integrity check failed: " + res)
  2409. }
  2410. return nil
  2411. }