main.go 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476
  1. package model
  2. import (
  3. "fmt"
  4. "log"
  5. "one-api/common"
  6. "one-api/constant"
  7. "os"
  8. "strings"
  9. "sync"
  10. "time"
  11. "github.com/glebarez/sqlite"
  12. "gorm.io/driver/mysql"
  13. "gorm.io/driver/postgres"
  14. "gorm.io/gorm"
  15. )
  16. var commonGroupCol string
  17. var commonKeyCol string
  18. var commonTrueVal string
  19. var commonFalseVal string
  20. var logKeyCol string
  21. var logGroupCol string
  22. func initCol() {
  23. // init common column names
  24. if common.UsingPostgreSQL {
  25. commonGroupCol = `"group"`
  26. commonKeyCol = `"key"`
  27. commonTrueVal = "true"
  28. commonFalseVal = "false"
  29. } else {
  30. commonGroupCol = "`group`"
  31. commonKeyCol = "`key`"
  32. commonTrueVal = "1"
  33. commonFalseVal = "0"
  34. }
  35. if os.Getenv("LOG_SQL_DSN") != "" {
  36. switch common.LogSqlType {
  37. case common.DatabaseTypePostgreSQL:
  38. logGroupCol = `"group"`
  39. logKeyCol = `"key"`
  40. default:
  41. logGroupCol = commonGroupCol
  42. logKeyCol = commonKeyCol
  43. }
  44. } else {
  45. // LOG_SQL_DSN 为空时,日志数据库与主数据库相同
  46. if common.UsingPostgreSQL {
  47. logGroupCol = `"group"`
  48. logKeyCol = `"key"`
  49. } else {
  50. logGroupCol = commonGroupCol
  51. logKeyCol = commonKeyCol
  52. }
  53. }
  54. // log sql type and database type
  55. //common.SysLog("Using Log SQL Type: " + common.LogSqlType)
  56. }
  57. var DB *gorm.DB
  58. var LOG_DB *gorm.DB
  59. func createRootAccountIfNeed() error {
  60. var user User
  61. //if user.Status != common.UserStatusEnabled {
  62. if err := DB.First(&user).Error; err != nil {
  63. common.SysLog("no user exists, create a root user for you: username is root, password is 123456")
  64. hashedPassword, err := common.Password2Hash("123456")
  65. if err != nil {
  66. return err
  67. }
  68. rootUser := User{
  69. Username: "root",
  70. Password: hashedPassword,
  71. Role: common.RoleRootUser,
  72. Status: common.UserStatusEnabled,
  73. DisplayName: "Root User",
  74. AccessToken: nil,
  75. Quota: 100000000,
  76. }
  77. DB.Create(&rootUser)
  78. }
  79. return nil
  80. }
  81. func CheckSetup() {
  82. setup := GetSetup()
  83. if setup == nil {
  84. // No setup record exists, check if we have a root user
  85. if RootUserExists() {
  86. common.SysLog("system is not initialized, but root user exists")
  87. // Create setup record
  88. newSetup := Setup{
  89. Version: common.Version,
  90. InitializedAt: time.Now().Unix(),
  91. }
  92. err := DB.Create(&newSetup).Error
  93. if err != nil {
  94. common.SysLog("failed to create setup record: " + err.Error())
  95. }
  96. constant.Setup = true
  97. } else {
  98. common.SysLog("system is not initialized and no root user exists")
  99. constant.Setup = false
  100. }
  101. } else {
  102. // Setup record exists, system is initialized
  103. common.SysLog("system is already initialized at: " + time.Unix(setup.InitializedAt, 0).String())
  104. constant.Setup = true
  105. }
  106. }
  107. func chooseDB(envName string, isLog bool) (*gorm.DB, error) {
  108. defer func() {
  109. initCol()
  110. }()
  111. dsn := os.Getenv(envName)
  112. if dsn != "" {
  113. if strings.HasPrefix(dsn, "postgres://") || strings.HasPrefix(dsn, "postgresql://") {
  114. // Use PostgreSQL
  115. common.SysLog("using PostgreSQL as database")
  116. if !isLog {
  117. common.UsingPostgreSQL = true
  118. } else {
  119. common.LogSqlType = common.DatabaseTypePostgreSQL
  120. }
  121. return gorm.Open(postgres.New(postgres.Config{
  122. DSN: dsn,
  123. PreferSimpleProtocol: true, // disables implicit prepared statement usage
  124. }), &gorm.Config{
  125. PrepareStmt: true, // precompile SQL
  126. })
  127. }
  128. if strings.HasPrefix(dsn, "local") {
  129. common.SysLog("SQL_DSN not set, using SQLite as database")
  130. if !isLog {
  131. common.UsingSQLite = true
  132. } else {
  133. common.LogSqlType = common.DatabaseTypeSQLite
  134. }
  135. return gorm.Open(sqlite.Open(common.SQLitePath), &gorm.Config{
  136. PrepareStmt: true, // precompile SQL
  137. })
  138. }
  139. // Use MySQL
  140. common.SysLog("using MySQL as database")
  141. // check parseTime
  142. if !strings.Contains(dsn, "parseTime") {
  143. if strings.Contains(dsn, "?") {
  144. dsn += "&parseTime=true"
  145. } else {
  146. dsn += "?parseTime=true"
  147. }
  148. }
  149. if !isLog {
  150. common.UsingMySQL = true
  151. } else {
  152. common.LogSqlType = common.DatabaseTypeMySQL
  153. }
  154. return gorm.Open(mysql.Open(dsn), &gorm.Config{
  155. PrepareStmt: true, // precompile SQL
  156. })
  157. }
  158. // Use SQLite
  159. common.SysLog("SQL_DSN not set, using SQLite as database")
  160. common.UsingSQLite = true
  161. return gorm.Open(sqlite.Open(common.SQLitePath), &gorm.Config{
  162. PrepareStmt: true, // precompile SQL
  163. })
  164. }
  165. func InitDB() (err error) {
  166. db, err := chooseDB("SQL_DSN", false)
  167. if err == nil {
  168. if common.DebugEnabled {
  169. db = db.Debug()
  170. }
  171. DB = db
  172. // MySQL charset/collation startup check: ensure Chinese-capable charset
  173. if common.UsingMySQL {
  174. if err := checkMySQLChineseSupport(DB); err != nil {
  175. panic(err)
  176. }
  177. }
  178. sqlDB, err := DB.DB()
  179. if err != nil {
  180. return err
  181. }
  182. sqlDB.SetMaxIdleConns(common.GetEnvOrDefault("SQL_MAX_IDLE_CONNS", 100))
  183. sqlDB.SetMaxOpenConns(common.GetEnvOrDefault("SQL_MAX_OPEN_CONNS", 1000))
  184. sqlDB.SetConnMaxLifetime(time.Second * time.Duration(common.GetEnvOrDefault("SQL_MAX_LIFETIME", 60)))
  185. if !common.IsMasterNode {
  186. return nil
  187. }
  188. if common.UsingMySQL {
  189. //_, _ = sqlDB.Exec("ALTER TABLE channels MODIFY model_mapping TEXT;") // TODO: delete this line when most users have upgraded
  190. }
  191. common.SysLog("database migration started")
  192. err = migrateDB()
  193. return err
  194. } else {
  195. common.FatalLog(err)
  196. }
  197. return err
  198. }
  199. func InitLogDB() (err error) {
  200. if os.Getenv("LOG_SQL_DSN") == "" {
  201. LOG_DB = DB
  202. return
  203. }
  204. db, err := chooseDB("LOG_SQL_DSN", true)
  205. if err == nil {
  206. if common.DebugEnabled {
  207. db = db.Debug()
  208. }
  209. LOG_DB = db
  210. // If log DB is MySQL, also ensure Chinese-capable charset
  211. if common.LogSqlType == common.DatabaseTypeMySQL {
  212. if err := checkMySQLChineseSupport(LOG_DB); err != nil {
  213. panic(err)
  214. }
  215. }
  216. sqlDB, err := LOG_DB.DB()
  217. if err != nil {
  218. return err
  219. }
  220. sqlDB.SetMaxIdleConns(common.GetEnvOrDefault("SQL_MAX_IDLE_CONNS", 100))
  221. sqlDB.SetMaxOpenConns(common.GetEnvOrDefault("SQL_MAX_OPEN_CONNS", 1000))
  222. sqlDB.SetConnMaxLifetime(time.Second * time.Duration(common.GetEnvOrDefault("SQL_MAX_LIFETIME", 60)))
  223. if !common.IsMasterNode {
  224. return nil
  225. }
  226. common.SysLog("database migration started")
  227. err = migrateLOGDB()
  228. return err
  229. } else {
  230. common.FatalLog(err)
  231. }
  232. return err
  233. }
  234. func migrateDB() error {
  235. err := DB.AutoMigrate(
  236. &Channel{},
  237. &Token{},
  238. &User{},
  239. &Option{},
  240. &Redemption{},
  241. &Ability{},
  242. &Log{},
  243. &Midjourney{},
  244. &TopUp{},
  245. &QuotaData{},
  246. &Task{},
  247. &Model{},
  248. &Vendor{},
  249. &PrefillGroup{},
  250. &Setup{},
  251. &TwoFA{},
  252. &TwoFABackupCode{},
  253. &OAuthClient{},
  254. )
  255. if err != nil {
  256. return err
  257. }
  258. return nil
  259. }
  260. func migrateDBFast() error {
  261. var wg sync.WaitGroup
  262. migrations := []struct {
  263. model interface{}
  264. name string
  265. }{
  266. {&Channel{}, "Channel"},
  267. {&Token{}, "Token"},
  268. {&User{}, "User"},
  269. {&Option{}, "Option"},
  270. {&Redemption{}, "Redemption"},
  271. {&Ability{}, "Ability"},
  272. {&Log{}, "Log"},
  273. {&Midjourney{}, "Midjourney"},
  274. {&TopUp{}, "TopUp"},
  275. {&QuotaData{}, "QuotaData"},
  276. {&Task{}, "Task"},
  277. {&Model{}, "Model"},
  278. {&Vendor{}, "Vendor"},
  279. {&PrefillGroup{}, "PrefillGroup"},
  280. {&Setup{}, "Setup"},
  281. {&TwoFA{}, "TwoFA"},
  282. {&TwoFABackupCode{}, "TwoFABackupCode"},
  283. }
  284. // 动态计算migration数量,确保errChan缓冲区足够大
  285. errChan := make(chan error, len(migrations))
  286. for _, m := range migrations {
  287. wg.Add(1)
  288. go func(model interface{}, name string) {
  289. defer wg.Done()
  290. if err := DB.AutoMigrate(model); err != nil {
  291. errChan <- fmt.Errorf("failed to migrate %s: %v", name, err)
  292. }
  293. }(m.model, m.name)
  294. }
  295. // Wait for all migrations to complete
  296. wg.Wait()
  297. close(errChan)
  298. // Check for any errors
  299. for err := range errChan {
  300. if err != nil {
  301. return err
  302. }
  303. }
  304. common.SysLog("database migrated")
  305. return nil
  306. }
  307. func migrateLOGDB() error {
  308. var err error
  309. if err = LOG_DB.AutoMigrate(&Log{}); err != nil {
  310. return err
  311. }
  312. return nil
  313. }
  314. func closeDB(db *gorm.DB) error {
  315. sqlDB, err := db.DB()
  316. if err != nil {
  317. return err
  318. }
  319. err = sqlDB.Close()
  320. return err
  321. }
  322. func CloseDB() error {
  323. if LOG_DB != DB {
  324. err := closeDB(LOG_DB)
  325. if err != nil {
  326. return err
  327. }
  328. }
  329. return closeDB(DB)
  330. }
  331. // checkMySQLChineseSupport ensures the MySQL connection and current schema
  332. // default charset/collation can store Chinese characters. It allows common
  333. // Chinese-capable charsets (utf8mb4, utf8, gbk, big5, gb18030) and panics otherwise.
  334. func checkMySQLChineseSupport(db *gorm.DB) error {
  335. // 仅检测:当前库默认字符集/排序规则 + 各表的排序规则(隐含字符集)
  336. // Read current schema defaults
  337. var schemaCharset, schemaCollation string
  338. err := db.Raw("SELECT DEFAULT_CHARACTER_SET_NAME, DEFAULT_COLLATION_NAME FROM information_schema.SCHEMATA WHERE SCHEMA_NAME = DATABASE()").Row().Scan(&schemaCharset, &schemaCollation)
  339. if err != nil {
  340. return fmt.Errorf("读取当前库默认字符集/排序规则失败 / Failed to read schema default charset/collation: %v", err)
  341. }
  342. toLower := func(s string) string { return strings.ToLower(s) }
  343. // Allowed charsets that can store Chinese text
  344. allowedCharsets := map[string]string{
  345. "utf8mb4": "utf8mb4_",
  346. "utf8": "utf8_",
  347. "gbk": "gbk_",
  348. "big5": "big5_",
  349. "gb18030": "gb18030_",
  350. }
  351. isChineseCapable := func(cs, cl string) bool {
  352. csLower := toLower(cs)
  353. clLower := toLower(cl)
  354. if prefix, ok := allowedCharsets[csLower]; ok {
  355. if clLower == "" {
  356. return true
  357. }
  358. return strings.HasPrefix(clLower, prefix)
  359. }
  360. // 如果仅提供了排序规则,尝试按排序规则前缀判断
  361. for _, prefix := range allowedCharsets {
  362. if strings.HasPrefix(clLower, prefix) {
  363. return true
  364. }
  365. }
  366. return false
  367. }
  368. // 1) 当前库默认值必须支持中文
  369. if !isChineseCapable(schemaCharset, schemaCollation) {
  370. return fmt.Errorf("当前库默认字符集/排序规则不支持中文:schema(%s/%s)。请将库设置为 utf8mb4/utf8/gbk/big5/gb18030 / Schema default charset/collation is not Chinese-capable: schema(%s/%s). Please set to utf8mb4/utf8/gbk/big5/gb18030",
  371. schemaCharset, schemaCollation, schemaCharset, schemaCollation)
  372. }
  373. // 2) 所有物理表的排序规则(隐含字符集)必须支持中文
  374. type tableInfo struct {
  375. Name string
  376. Collation *string
  377. }
  378. var tables []tableInfo
  379. if err := db.Raw("SELECT TABLE_NAME, TABLE_COLLATION FROM information_schema.TABLES WHERE TABLE_SCHEMA = DATABASE() AND TABLE_TYPE = 'BASE TABLE'").Scan(&tables).Error; err != nil {
  380. return fmt.Errorf("读取表排序规则失败 / Failed to read table collations: %v", err)
  381. }
  382. var badTables []string
  383. for _, t := range tables {
  384. // NULL 或空表示继承库默认设置,已在上面校验库默认,视为通过
  385. if t.Collation == nil || *t.Collation == "" {
  386. continue
  387. }
  388. cl := *t.Collation
  389. // 仅凭排序规则判断是否中文可用
  390. ok := false
  391. lower := strings.ToLower(cl)
  392. for _, prefix := range allowedCharsets {
  393. if strings.HasPrefix(lower, prefix) {
  394. ok = true
  395. break
  396. }
  397. }
  398. if !ok {
  399. badTables = append(badTables, fmt.Sprintf("%s(%s)", t.Name, cl))
  400. }
  401. }
  402. if len(badTables) > 0 {
  403. // 限制输出数量以避免日志过长
  404. maxShow := 20
  405. shown := badTables
  406. if len(shown) > maxShow {
  407. shown = shown[:maxShow]
  408. }
  409. return fmt.Errorf(
  410. "存在不支持中文的表,请修复其排序规则/字符集。示例(最多展示 %d 项):%v / Found tables not Chinese-capable. Please fix their collation/charset. Examples (showing up to %d): %v",
  411. maxShow, shown, maxShow, shown,
  412. )
  413. }
  414. return nil
  415. }
  416. var (
  417. lastPingTime time.Time
  418. pingMutex sync.Mutex
  419. )
  420. func PingDB() error {
  421. pingMutex.Lock()
  422. defer pingMutex.Unlock()
  423. if time.Since(lastPingTime) < time.Second*10 {
  424. return nil
  425. }
  426. sqlDB, err := DB.DB()
  427. if err != nil {
  428. log.Printf("Error getting sql.DB from GORM: %v", err)
  429. return err
  430. }
  431. err = sqlDB.Ping()
  432. if err != nil {
  433. log.Printf("Error pinging DB: %v", err)
  434. return err
  435. }
  436. lastPingTime = time.Now()
  437. common.SysLog("Database pinged successfully")
  438. return nil
  439. }