1
0

setting.go 29 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057
  1. package service
  2. import (
  3. _ "embed"
  4. "encoding/json"
  5. "errors"
  6. "fmt"
  7. "net"
  8. "net/http"
  9. "reflect"
  10. "strconv"
  11. "strings"
  12. "time"
  13. "github.com/google/uuid"
  14. "github.com/mhsanaei/3x-ui/v3/database"
  15. "github.com/mhsanaei/3x-ui/v3/database/model"
  16. "github.com/mhsanaei/3x-ui/v3/logger"
  17. "github.com/mhsanaei/3x-ui/v3/util/common"
  18. "github.com/mhsanaei/3x-ui/v3/util/netproxy"
  19. "github.com/mhsanaei/3x-ui/v3/util/random"
  20. "github.com/mhsanaei/3x-ui/v3/util/reflect_util"
  21. "github.com/mhsanaei/3x-ui/v3/web/entity"
  22. "github.com/mhsanaei/3x-ui/v3/xray"
  23. )
  24. //go:embed config.json
  25. var xrayTemplateConfig string
  26. var defaultValueMap = map[string]string{
  27. "xrayTemplateConfig": xrayTemplateConfig,
  28. "webListen": "",
  29. "webDomain": "",
  30. "webPort": "2053",
  31. "webCertFile": "",
  32. "webKeyFile": "",
  33. "secret": random.Seq(32),
  34. "panelGuid": uuid.NewString(),
  35. "apiToken": "",
  36. "webBasePath": "/",
  37. "sessionMaxAge": "360",
  38. "trustedProxyCIDRs": "127.0.0.1/32,::1/128",
  39. "pageSize": "25",
  40. "expireDiff": "0",
  41. "trafficDiff": "0",
  42. "remarkModel": "-ieo",
  43. "timeLocation": "Local",
  44. "tgBotEnable": "false",
  45. "tgBotToken": "",
  46. "tgBotProxy": "",
  47. "tgBotAPIServer": "",
  48. "tgBotChatId": "",
  49. "tgRunTime": "@daily",
  50. "tgBotBackup": "false",
  51. "tgBotLoginNotify": "true",
  52. "tgCpu": "80",
  53. "tgLang": "en-US",
  54. "twoFactorEnable": "false",
  55. "twoFactorToken": "",
  56. "subEnable": "true",
  57. "subJsonEnable": "false",
  58. "subTitle": "",
  59. "subSupportUrl": "",
  60. "subProfileUrl": "",
  61. "subAnnounce": "",
  62. "subEnableRouting": "false",
  63. "subRoutingRules": "",
  64. "subListen": "",
  65. "subPort": "2096",
  66. "subPath": "/sub/",
  67. "subDomain": "",
  68. "subCertFile": "",
  69. "subKeyFile": "",
  70. "subUpdates": "12",
  71. "subEncrypt": "true",
  72. "subShowInfo": "true",
  73. "subEmailInRemark": "true",
  74. "subURI": "",
  75. "subJsonPath": "/json/",
  76. "subJsonURI": "",
  77. "subClashEnable": "false",
  78. "subClashPath": "/clash/",
  79. "subClashURI": "",
  80. "subClashEnableRouting": "false",
  81. "subClashRules": "",
  82. "subJsonMux": "",
  83. "subJsonRules": "",
  84. "subJsonFinalMask": "",
  85. "subThemeDir": "",
  86. "datepicker": "gregorian",
  87. "warp": "",
  88. "warpUpdateInterval": "0",
  89. "nord": "",
  90. "externalTrafficInformEnable": "false",
  91. "externalTrafficInformURI": "",
  92. "restartXrayOnClientDisable": "true",
  93. "xrayOutboundTestUrl": "https://www.google.com/generate_204",
  94. "panelProxy": "",
  95. // LDAP defaults
  96. "ldapEnable": "false",
  97. "ldapHost": "",
  98. "ldapPort": "389",
  99. "ldapUseTLS": "false",
  100. "ldapBindDN": "",
  101. "ldapPassword": "",
  102. "ldapBaseDN": "",
  103. "ldapUserFilter": "(objectClass=person)",
  104. "ldapUserAttr": "mail",
  105. "ldapVlessField": "vless_enabled",
  106. "ldapSyncCron": "@every 1m",
  107. "ldapFlagField": "",
  108. "ldapTruthyValues": "true,1,yes,on",
  109. "ldapInvertFlag": "false",
  110. "ldapInboundTags": "",
  111. "ldapAutoCreate": "false",
  112. "ldapAutoDelete": "false",
  113. "ldapDefaultTotalGB": "0",
  114. "ldapDefaultExpiryDays": "0",
  115. "ldapDefaultLimitIP": "0",
  116. }
  117. // SettingService provides business logic for application settings management.
  118. // It handles configuration storage, retrieval, and validation for all system settings.
  119. type SettingService struct{}
  120. func (s *SettingService) GetDefaultJSONConfig() (any, error) {
  121. var jsonData any
  122. err := json.Unmarshal([]byte(xrayTemplateConfig), &jsonData)
  123. if err != nil {
  124. return nil, err
  125. }
  126. return jsonData, nil
  127. }
  128. func (s *SettingService) GetAllSetting() (*entity.AllSetting, error) {
  129. db := database.GetDB()
  130. settings := make([]*model.Setting, 0)
  131. err := db.Model(model.Setting{}).Not("key = ?", "xrayTemplateConfig").Find(&settings).Error
  132. if err != nil {
  133. return nil, err
  134. }
  135. allSetting := &entity.AllSetting{}
  136. t := reflect.TypeFor[entity.AllSetting]()
  137. v := reflect.ValueOf(allSetting).Elem()
  138. fields := reflect_util.GetFields(t)
  139. setSetting := func(key, value string) (err error) {
  140. defer func() {
  141. panicErr := recover()
  142. if panicErr != nil {
  143. err = errors.New(fmt.Sprint(panicErr))
  144. }
  145. }()
  146. var found bool
  147. var field reflect.StructField
  148. for _, f := range fields {
  149. if f.Tag.Get("json") == key {
  150. field = f
  151. found = true
  152. break
  153. }
  154. }
  155. if !found {
  156. // Some settings are automatically generated, no need to return to the front end to modify the user
  157. return nil
  158. }
  159. fieldV := v.FieldByName(field.Name)
  160. switch t := fieldV.Interface().(type) {
  161. case int:
  162. n, err := strconv.ParseInt(effectiveSettingValue(key, value), 10, 64)
  163. if err != nil {
  164. return err
  165. }
  166. fieldV.SetInt(n)
  167. case string:
  168. fieldV.SetString(value)
  169. case bool:
  170. fieldV.SetBool(effectiveSettingValue(key, value) == "true")
  171. default:
  172. return common.NewErrorf("unknown field %v type %v", key, t)
  173. }
  174. return
  175. }
  176. keyMap := map[string]bool{}
  177. for _, setting := range settings {
  178. err := setSetting(setting.Key, setting.Value)
  179. if err != nil {
  180. return nil, err
  181. }
  182. keyMap[setting.Key] = true
  183. }
  184. for key, value := range defaultValueMap {
  185. if keyMap[key] {
  186. continue
  187. }
  188. err := setSetting(key, value)
  189. if err != nil {
  190. return nil, err
  191. }
  192. }
  193. return allSetting, nil
  194. }
  195. func (s *SettingService) GetAllSettingView() (*entity.AllSettingView, error) {
  196. allSetting, err := s.GetAllSetting()
  197. if err != nil {
  198. return nil, err
  199. }
  200. view := &entity.AllSettingView{AllSetting: *allSetting}
  201. view.HasTgBotToken = secretConfigured(allSetting.TgBotToken)
  202. view.HasTwoFactorToken = secretConfigured(allSetting.TwoFactorToken)
  203. view.HasLdapPassword = secretConfigured(allSetting.LdapPassword)
  204. view.HasWarpSecret = secretConfigured(mustString(s.GetWarp()))
  205. view.HasNordSecret = secretConfigured(mustString(s.GetNord()))
  206. var apiTokenCount int64
  207. if err := database.GetDB().Model(model.ApiToken{}).Where("enabled = ?", true).Count(&apiTokenCount).Error; err == nil {
  208. view.HasApiToken = apiTokenCount > 0
  209. }
  210. view.TgBotToken = ""
  211. view.TwoFactorToken = ""
  212. view.LdapPassword = ""
  213. return view, nil
  214. }
  215. func secretConfigured(value string) bool {
  216. return strings.TrimSpace(value) != ""
  217. }
  218. func mustString(value string, _ error) string {
  219. return value
  220. }
  221. func (s *SettingService) ResetSettings() error {
  222. db := database.GetDB()
  223. err := db.Where("1 = 1").Delete(model.Setting{}).Error
  224. if err != nil {
  225. return err
  226. }
  227. return db.Model(model.User{}).
  228. Where("1 = 1").Error
  229. }
  230. func (s *SettingService) getSetting(key string) (*model.Setting, error) {
  231. db := database.GetDB()
  232. setting := &model.Setting{}
  233. err := db.Model(model.Setting{}).Where("key = ?", key).First(setting).Error
  234. if err != nil {
  235. return nil, err
  236. }
  237. return setting, nil
  238. }
  239. func (s *SettingService) saveSetting(key string, value string) error {
  240. setting, err := s.getSetting(key)
  241. db := database.GetDB()
  242. if database.IsNotFound(err) {
  243. return db.Create(&model.Setting{
  244. Key: key,
  245. Value: value,
  246. }).Error
  247. } else if err != nil {
  248. return err
  249. }
  250. setting.Key = key
  251. setting.Value = value
  252. return db.Save(setting).Error
  253. }
  254. func (s *SettingService) getString(key string) (string, error) {
  255. setting, err := s.getSetting(key)
  256. if database.IsNotFound(err) {
  257. value, ok := defaultValueMap[key]
  258. if !ok {
  259. return "", common.NewErrorf("key <%v> not in defaultValueMap", key)
  260. }
  261. return value, nil
  262. } else if err != nil {
  263. return "", err
  264. }
  265. return setting.Value, nil
  266. }
  267. func (s *SettingService) setString(key string, value string) error {
  268. return s.saveSetting(key, value)
  269. }
  270. func effectiveSettingValue(key, stored string) string {
  271. if stored == "" {
  272. if def, ok := defaultValueMap[key]; ok {
  273. return def
  274. }
  275. }
  276. return stored
  277. }
  278. func (s *SettingService) getBool(key string) (bool, error) {
  279. str, err := s.getString(key)
  280. if err != nil {
  281. return false, err
  282. }
  283. return strconv.ParseBool(effectiveSettingValue(key, str))
  284. }
  285. func (s *SettingService) setBool(key string, value bool) error {
  286. return s.setString(key, strconv.FormatBool(value))
  287. }
  288. func (s *SettingService) getInt(key string) (int, error) {
  289. str, err := s.getString(key)
  290. if err != nil {
  291. return 0, err
  292. }
  293. return strconv.Atoi(effectiveSettingValue(key, str))
  294. }
  295. func (s *SettingService) setInt(key string, value int) error {
  296. return s.setString(key, strconv.Itoa(value))
  297. }
  298. func (s *SettingService) GetWarpLastUpdate() (int64, error) {
  299. val, err := s.getString("warpLastUpdate")
  300. if err != nil || val == "" {
  301. return 0, err
  302. }
  303. return strconv.ParseInt(val, 10, 64)
  304. }
  305. func (s *SettingService) SetWarpLastUpdate(val int64) error {
  306. return s.saveSetting("warpLastUpdate", strconv.FormatInt(val, 10))
  307. }
  308. func (s *SettingService) SetWarpUpdateInterval(val int) error {
  309. return s.setInt("warpUpdateInterval", val)
  310. }
  311. func (s *SettingService) GetXrayConfigTemplate() (string, error) {
  312. return s.getString("xrayTemplateConfig")
  313. }
  314. func (s *SettingService) GetXrayOutboundTestUrl() (string, error) {
  315. return s.getString("xrayOutboundTestUrl")
  316. }
  317. func (s *SettingService) SetXrayOutboundTestUrl(url string) error {
  318. clean, err := SanitizeHTTPURL(url)
  319. if err != nil {
  320. return err
  321. }
  322. return s.setString("xrayOutboundTestUrl", clean)
  323. }
  324. func (s *SettingService) GetListen() (string, error) {
  325. return s.getString("webListen")
  326. }
  327. func (s *SettingService) SetListen(ip string) error {
  328. return s.setString("webListen", ip)
  329. }
  330. func (s *SettingService) GetWebDomain() (string, error) {
  331. return s.getString("webDomain")
  332. }
  333. func (s *SettingService) GetTgBotToken() (string, error) {
  334. return s.getString("tgBotToken")
  335. }
  336. func (s *SettingService) SetTgBotToken(token string) error {
  337. return s.setString("tgBotToken", token)
  338. }
  339. func (s *SettingService) GetTgBotProxy() (string, error) {
  340. return s.getString("tgBotProxy")
  341. }
  342. func (s *SettingService) SetTgBotProxy(token string) error {
  343. return s.setString("tgBotProxy", token)
  344. }
  345. func (s *SettingService) GetPanelProxy() (string, error) {
  346. return s.getString("panelProxy")
  347. }
  348. func (s *SettingService) SetPanelProxy(proxyUrl string) error {
  349. return s.setString("panelProxy", proxyUrl)
  350. }
  351. // NewProxiedHTTPClient returns an HTTP client that routes the panel's own
  352. // outbound requests through the configured panelProxy setting. An invalid or
  353. // missing proxy falls back to a direct client so existing behavior is preserved.
  354. func (s *SettingService) NewProxiedHTTPClient(timeout time.Duration) *http.Client {
  355. proxyUrl, err := s.GetPanelProxy()
  356. if err != nil {
  357. logger.Warning("Failed to read panel proxy setting:", err)
  358. proxyUrl = ""
  359. }
  360. client, err := netproxy.NewHTTPClient(proxyUrl, timeout)
  361. if err != nil {
  362. logger.Warningf("Invalid panel proxy %q, using direct connection: %v", proxyUrl, err)
  363. return &http.Client{Timeout: timeout}
  364. }
  365. return client
  366. }
  367. func (s *SettingService) GetTgBotAPIServer() (string, error) {
  368. return s.getString("tgBotAPIServer")
  369. }
  370. func (s *SettingService) SetTgBotAPIServer(token string) error {
  371. return s.setString("tgBotAPIServer", token)
  372. }
  373. func (s *SettingService) GetTgBotChatId() (string, error) {
  374. return s.getString("tgBotChatId")
  375. }
  376. func (s *SettingService) SetTgBotChatId(chatIds string) error {
  377. return s.setString("tgBotChatId", chatIds)
  378. }
  379. func (s *SettingService) GetTgbotEnabled() (bool, error) {
  380. return s.getBool("tgBotEnable")
  381. }
  382. func (s *SettingService) SetTgbotEnabled(value bool) error {
  383. return s.setBool("tgBotEnable", value)
  384. }
  385. func (s *SettingService) GetTgbotRuntime() (string, error) {
  386. return s.getString("tgRunTime")
  387. }
  388. func (s *SettingService) SetTgbotRuntime(time string) error {
  389. return s.setString("tgRunTime", time)
  390. }
  391. func (s *SettingService) GetTgBotBackup() (bool, error) {
  392. return s.getBool("tgBotBackup")
  393. }
  394. func (s *SettingService) GetTgBotLoginNotify() (bool, error) {
  395. return s.getBool("tgBotLoginNotify")
  396. }
  397. func (s *SettingService) GetTgCpu() (int, error) {
  398. return s.getInt("tgCpu")
  399. }
  400. func (s *SettingService) GetTgLang() (string, error) {
  401. return s.getString("tgLang")
  402. }
  403. func (s *SettingService) GetTwoFactorEnable() (bool, error) {
  404. return s.getBool("twoFactorEnable")
  405. }
  406. func (s *SettingService) SetTwoFactorEnable(value bool) error {
  407. return s.setBool("twoFactorEnable", value)
  408. }
  409. func (s *SettingService) GetTwoFactorToken() (string, error) {
  410. return s.getString("twoFactorToken")
  411. }
  412. func (s *SettingService) SetTwoFactorToken(value string) error {
  413. return s.setString("twoFactorToken", value)
  414. }
  415. func (s *SettingService) GetPort() (int, error) {
  416. return s.getInt("webPort")
  417. }
  418. func (s *SettingService) SetPort(port int) error {
  419. return s.setInt("webPort", port)
  420. }
  421. func (s *SettingService) SetCertFile(webCertFile string) error {
  422. return s.setString("webCertFile", webCertFile)
  423. }
  424. func (s *SettingService) GetCertFile() (string, error) {
  425. return s.getString("webCertFile")
  426. }
  427. func (s *SettingService) SetKeyFile(webKeyFile string) error {
  428. return s.setString("webKeyFile", webKeyFile)
  429. }
  430. func (s *SettingService) GetKeyFile() (string, error) {
  431. return s.getString("webKeyFile")
  432. }
  433. func (s *SettingService) GetExpireDiff() (int, error) {
  434. return s.getInt("expireDiff")
  435. }
  436. func (s *SettingService) GetTrafficDiff() (int, error) {
  437. return s.getInt("trafficDiff")
  438. }
  439. func (s *SettingService) GetSessionMaxAge() (int, error) {
  440. return s.getInt("sessionMaxAge")
  441. }
  442. func (s *SettingService) GetTrustedProxyCIDRs() (string, error) {
  443. return s.getString("trustedProxyCIDRs")
  444. }
  445. func (s *SettingService) GetRemarkModel() (string, error) {
  446. return s.getString("remarkModel")
  447. }
  448. func (s *SettingService) GetSecret() ([]byte, error) {
  449. secret, err := s.getString("secret")
  450. if secret == defaultValueMap["secret"] {
  451. err := s.saveSetting("secret", secret)
  452. if err != nil {
  453. logger.Warning("save secret failed:", err)
  454. }
  455. }
  456. return []byte(secret), err
  457. }
  458. // GetPanelGuid returns this panel's stable self-identifier, persisting a
  459. // freshly generated UUID on first read. It is the globally stable node
  460. // identity used to attribute online clients and inbounds to the physical
  461. // node that hosts them across a chain of nodes (#4983), where per-panel
  462. // autoincrement node ids are meaningless one hop away.
  463. func (s *SettingService) GetPanelGuid() (string, error) {
  464. guid, err := s.getString("panelGuid")
  465. if err != nil {
  466. return "", err
  467. }
  468. if guid == defaultValueMap["panelGuid"] {
  469. if saveErr := s.saveSetting("panelGuid", guid); saveErr != nil {
  470. logger.Warning("save panelGuid failed:", saveErr)
  471. }
  472. }
  473. return guid, nil
  474. }
  475. func (s *SettingService) SetBasePath(basePath string) error {
  476. if !strings.HasPrefix(basePath, "/") {
  477. basePath = "/" + basePath
  478. }
  479. if !strings.HasSuffix(basePath, "/") {
  480. basePath += "/"
  481. }
  482. return s.setString("webBasePath", basePath)
  483. }
  484. func (s *SettingService) GetBasePath() (string, error) {
  485. basePath, err := s.getString("webBasePath")
  486. if err != nil {
  487. return "", err
  488. }
  489. if !strings.HasPrefix(basePath, "/") {
  490. basePath = "/" + basePath
  491. }
  492. if !strings.HasSuffix(basePath, "/") {
  493. basePath += "/"
  494. }
  495. return basePath, nil
  496. }
  497. func (s *SettingService) GetTimeLocation() (*time.Location, error) {
  498. l, err := s.getString("timeLocation")
  499. if err != nil {
  500. return nil, err
  501. }
  502. location, err := time.LoadLocation(l)
  503. if err != nil {
  504. defaultLocation := defaultValueMap["timeLocation"]
  505. logger.Errorf("location <%v> not exist, using default location: %v", l, defaultLocation)
  506. location, err = time.LoadLocation(defaultLocation)
  507. if err != nil {
  508. logger.Errorf("failed to load default location, using UTC: %v", err)
  509. return time.UTC, nil
  510. }
  511. return location, nil
  512. }
  513. return location, nil
  514. }
  515. func (s *SettingService) GetSubEnable() (bool, error) {
  516. return s.getBool("subEnable")
  517. }
  518. func (s *SettingService) GetSubJsonEnable() (bool, error) {
  519. return s.getBool("subJsonEnable")
  520. }
  521. func (s *SettingService) GetSubTitle() (string, error) {
  522. return s.getString("subTitle")
  523. }
  524. func (s *SettingService) GetSubSupportUrl() (string, error) {
  525. return s.getString("subSupportUrl")
  526. }
  527. func (s *SettingService) GetSubProfileUrl() (string, error) {
  528. return s.getString("subProfileUrl")
  529. }
  530. func (s *SettingService) GetSubAnnounce() (string, error) {
  531. return s.getString("subAnnounce")
  532. }
  533. func (s *SettingService) GetSubEnableRouting() (bool, error) {
  534. return s.getBool("subEnableRouting")
  535. }
  536. func (s *SettingService) GetSubRoutingRules() (string, error) {
  537. return s.getString("subRoutingRules")
  538. }
  539. func (s *SettingService) GetSubListen() (string, error) {
  540. return s.getString("subListen")
  541. }
  542. func (s *SettingService) GetSubPort() (int, error) {
  543. return s.getInt("subPort")
  544. }
  545. func (s *SettingService) GetSubPath() (string, error) {
  546. return s.getString("subPath")
  547. }
  548. func (s *SettingService) GetSubJsonPath() (string, error) {
  549. return s.getString("subJsonPath")
  550. }
  551. func (s *SettingService) GetSubDomain() (string, error) {
  552. return s.getString("subDomain")
  553. }
  554. func (s *SettingService) SetSubCertFile(subCertFile string) error {
  555. return s.setString("subCertFile", subCertFile)
  556. }
  557. func (s *SettingService) GetSubCertFile() (string, error) {
  558. return s.getString("subCertFile")
  559. }
  560. func (s *SettingService) SetSubKeyFile(subKeyFile string) error {
  561. return s.setString("subKeyFile", subKeyFile)
  562. }
  563. func (s *SettingService) GetSubKeyFile() (string, error) {
  564. return s.getString("subKeyFile")
  565. }
  566. func (s *SettingService) GetSubUpdates() (string, error) {
  567. return s.getString("subUpdates")
  568. }
  569. func (s *SettingService) GetSubEncrypt() (bool, error) {
  570. return s.getBool("subEncrypt")
  571. }
  572. func (s *SettingService) GetSubShowInfo() (bool, error) {
  573. return s.getBool("subShowInfo")
  574. }
  575. func (s *SettingService) GetSubEmailInRemark() (bool, error) {
  576. return s.getBool("subEmailInRemark")
  577. }
  578. func (s *SettingService) GetPageSize() (int, error) {
  579. return s.getInt("pageSize")
  580. }
  581. func (s *SettingService) GetSubURI() (string, error) {
  582. return s.getString("subURI")
  583. }
  584. func (s *SettingService) GetSubJsonURI() (string, error) {
  585. return s.getString("subJsonURI")
  586. }
  587. func (s *SettingService) GetSubClashEnable() (bool, error) {
  588. return s.getBool("subClashEnable")
  589. }
  590. func (s *SettingService) GetSubClashPath() (string, error) {
  591. return s.getString("subClashPath")
  592. }
  593. func (s *SettingService) GetSubClashURI() (string, error) {
  594. return s.getString("subClashURI")
  595. }
  596. func (s *SettingService) GetSubClashEnableRouting() (bool, error) {
  597. return s.getBool("subClashEnableRouting")
  598. }
  599. func (s *SettingService) GetSubClashRules() (string, error) {
  600. return s.getString("subClashRules")
  601. }
  602. func (s *SettingService) GetSubJsonMux() (string, error) {
  603. return s.getString("subJsonMux")
  604. }
  605. func (s *SettingService) GetSubJsonRules() (string, error) {
  606. return s.getString("subJsonRules")
  607. }
  608. func (s *SettingService) GetSubJsonFinalMask() (string, error) {
  609. return s.getString("subJsonFinalMask")
  610. }
  611. func (s *SettingService) GetSubThemeDir() (string, error) {
  612. return s.getString("subThemeDir")
  613. }
  614. func (s *SettingService) GetDatepicker() (string, error) {
  615. return s.getString("datepicker")
  616. }
  617. func (s *SettingService) GetWarp() (string, error) {
  618. return s.getString("warp")
  619. }
  620. func (s *SettingService) SetWarp(data string) error {
  621. return s.setString("warp", data)
  622. }
  623. func (s *SettingService) GetNord() (string, error) {
  624. return s.getString("nord")
  625. }
  626. func (s *SettingService) SetNord(data string) error {
  627. return s.setString("nord", data)
  628. }
  629. func (s *SettingService) GetExternalTrafficInformEnable() (bool, error) {
  630. return s.getBool("externalTrafficInformEnable")
  631. }
  632. func (s *SettingService) SetExternalTrafficInformEnable(value bool) error {
  633. return s.setBool("externalTrafficInformEnable", value)
  634. }
  635. func (s *SettingService) GetExternalTrafficInformURI() (string, error) {
  636. return s.getString("externalTrafficInformURI")
  637. }
  638. func (s *SettingService) SetExternalTrafficInformURI(InformURI string) error {
  639. return s.setString("externalTrafficInformURI", InformURI)
  640. }
  641. func (s *SettingService) GetRestartXrayOnClientDisable() (bool, error) {
  642. return s.getBool("restartXrayOnClientDisable")
  643. }
  644. func (s *SettingService) SetRestartXrayOnClientDisable(value bool) error {
  645. return s.setBool("restartXrayOnClientDisable", value)
  646. }
  647. func (s *SettingService) GetIpLimitEnable() (bool, error) {
  648. accessLogPath, err := xray.GetAccessLogPath()
  649. if err != nil {
  650. return false, err
  651. }
  652. return (accessLogPath != "none" && accessLogPath != ""), nil
  653. }
  654. // GetLdapEnable returns whether LDAP is enabled.
  655. func (s *SettingService) GetLdapEnable() (bool, error) {
  656. return s.getBool("ldapEnable")
  657. }
  658. func (s *SettingService) GetLdapHost() (string, error) {
  659. return s.getString("ldapHost")
  660. }
  661. func (s *SettingService) GetLdapPort() (int, error) {
  662. return s.getInt("ldapPort")
  663. }
  664. func (s *SettingService) GetLdapUseTLS() (bool, error) {
  665. return s.getBool("ldapUseTLS")
  666. }
  667. func (s *SettingService) GetLdapBindDN() (string, error) {
  668. return s.getString("ldapBindDN")
  669. }
  670. func (s *SettingService) GetLdapPassword() (string, error) {
  671. return s.getString("ldapPassword")
  672. }
  673. func (s *SettingService) GetLdapBaseDN() (string, error) {
  674. return s.getString("ldapBaseDN")
  675. }
  676. func (s *SettingService) GetLdapUserFilter() (string, error) {
  677. return s.getString("ldapUserFilter")
  678. }
  679. func (s *SettingService) GetLdapUserAttr() (string, error) {
  680. return s.getString("ldapUserAttr")
  681. }
  682. func (s *SettingService) GetLdapVlessField() (string, error) {
  683. return s.getString("ldapVlessField")
  684. }
  685. func (s *SettingService) GetLdapSyncCron() (string, error) {
  686. return s.getString("ldapSyncCron")
  687. }
  688. func (s *SettingService) GetLdapFlagField() (string, error) {
  689. return s.getString("ldapFlagField")
  690. }
  691. func (s *SettingService) GetLdapTruthyValues() (string, error) {
  692. return s.getString("ldapTruthyValues")
  693. }
  694. func (s *SettingService) GetLdapInvertFlag() (bool, error) {
  695. return s.getBool("ldapInvertFlag")
  696. }
  697. func (s *SettingService) GetLdapInboundTags() (string, error) {
  698. return s.getString("ldapInboundTags")
  699. }
  700. func (s *SettingService) GetLdapAutoCreate() (bool, error) {
  701. return s.getBool("ldapAutoCreate")
  702. }
  703. func (s *SettingService) GetLdapAutoDelete() (bool, error) {
  704. return s.getBool("ldapAutoDelete")
  705. }
  706. func (s *SettingService) GetLdapDefaultTotalGB() (int, error) {
  707. return s.getInt("ldapDefaultTotalGB")
  708. }
  709. func (s *SettingService) GetLdapDefaultExpiryDays() (int, error) {
  710. return s.getInt("ldapDefaultExpiryDays")
  711. }
  712. func (s *SettingService) GetLdapDefaultLimitIP() (int, error) {
  713. return s.getInt("ldapDefaultLimitIP")
  714. }
  715. func (s *SettingService) UpdateAllSetting(allSetting *entity.AllSetting) error {
  716. if err := s.preserveRedactedSecrets(allSetting); err != nil {
  717. return err
  718. }
  719. if err := validateSettingsURLs(allSetting); err != nil {
  720. return err
  721. }
  722. if err := allSetting.CheckValid(); err != nil {
  723. return err
  724. }
  725. v := reflect.ValueOf(allSetting).Elem()
  726. t := reflect.TypeFor[entity.AllSetting]()
  727. fields := reflect_util.GetFields(t)
  728. errs := make([]error, 0)
  729. for _, field := range fields {
  730. key := field.Tag.Get("json")
  731. fieldV := v.FieldByName(field.Name)
  732. value := fmt.Sprint(fieldV.Interface())
  733. err := s.saveSetting(key, value)
  734. if err != nil {
  735. errs = append(errs, err)
  736. }
  737. }
  738. return common.Combine(errs...)
  739. }
  740. func (s *SettingService) preserveRedactedSecrets(allSetting *entity.AllSetting) error {
  741. if strings.TrimSpace(allSetting.TgBotToken) == "" {
  742. value, err := s.GetTgBotToken()
  743. if err != nil {
  744. return err
  745. }
  746. allSetting.TgBotToken = value
  747. }
  748. if strings.TrimSpace(allSetting.LdapPassword) == "" {
  749. value, err := s.GetLdapPassword()
  750. if err != nil {
  751. return err
  752. }
  753. allSetting.LdapPassword = value
  754. }
  755. if allSetting.TwoFactorEnable && strings.TrimSpace(allSetting.TwoFactorToken) == "" {
  756. value, err := s.GetTwoFactorToken()
  757. if err != nil {
  758. return err
  759. }
  760. allSetting.TwoFactorToken = value
  761. }
  762. return nil
  763. }
  764. func validateSettingsURLs(allSetting *entity.AllSetting) error {
  765. if allSetting.ExternalTrafficInformURI != "" {
  766. u, err := SanitizeHTTPURL(allSetting.ExternalTrafficInformURI)
  767. if err != nil {
  768. return common.NewError("external traffic inform URI is invalid:", err)
  769. }
  770. allSetting.ExternalTrafficInformURI = u
  771. }
  772. if allSetting.TgBotAPIServer != "" {
  773. u, err := SanitizeHTTPURL(allSetting.TgBotAPIServer)
  774. if err != nil {
  775. return common.NewError("telegram API server URL is invalid:", err)
  776. }
  777. allSetting.TgBotAPIServer = u
  778. }
  779. return nil
  780. }
  781. func (s *SettingService) UpdateSecret(key string, value string) error {
  782. switch key {
  783. case "tgBotToken", "ldapPassword", "twoFactorToken":
  784. return s.saveSetting(key, strings.TrimSpace(value))
  785. default:
  786. return common.NewError("secret key is not replaceable:", key)
  787. }
  788. }
  789. func (s *SettingService) GetDefaultXrayConfig() (any, error) {
  790. var jsonData any
  791. err := json.Unmarshal([]byte(xrayTemplateConfig), &jsonData)
  792. if err != nil {
  793. return nil, err
  794. }
  795. return jsonData, nil
  796. }
  797. func extractHostname(host string) string {
  798. h, _, err := net.SplitHostPort(host)
  799. // Err is not nil means host does not contain port
  800. if err != nil {
  801. h = host
  802. }
  803. ip := net.ParseIP(h)
  804. // If it's not an IP, return as is
  805. if ip == nil {
  806. return h
  807. }
  808. // If it's an IPv4, return as is
  809. if ip.To4() != nil {
  810. return h
  811. }
  812. // IPv6 needs bracketing
  813. return "[" + h + "]"
  814. }
  815. // BuildSubURIBase is shared by GetDefaultSettings (the panel's Client
  816. // Information page) and the subscription page so both render subscription
  817. // URLs identically.
  818. func (s *SettingService) BuildSubURIBase(host string) string {
  819. subPort, _ := s.GetSubPort()
  820. subDomain, _ := s.GetSubDomain()
  821. subKeyFile, _ := s.GetSubKeyFile()
  822. subCertFile, _ := s.GetSubCertFile()
  823. subTLS := subKeyFile != "" && subCertFile != ""
  824. if subDomain == "" {
  825. subDomain = extractHostname(host)
  826. }
  827. scheme := "http"
  828. if subTLS {
  829. scheme = "https"
  830. }
  831. if (subPort == 443 && subTLS) || (subPort == 80 && !subTLS) {
  832. return scheme + "://" + subDomain
  833. }
  834. return fmt.Sprintf("%s://%s:%d", scheme, subDomain, subPort)
  835. }
  836. func (s *SettingService) GetDefaultSettings(host string) (any, error) {
  837. type settingFunc func() (any, error)
  838. settings := map[string]settingFunc{
  839. "expireDiff": func() (any, error) { return s.GetExpireDiff() },
  840. "trafficDiff": func() (any, error) { return s.GetTrafficDiff() },
  841. "pageSize": func() (any, error) { return s.GetPageSize() },
  842. "defaultCert": func() (any, error) { return s.GetCertFile() },
  843. "defaultKey": func() (any, error) { return s.GetKeyFile() },
  844. "tgBotEnable": func() (any, error) { return s.GetTgbotEnabled() },
  845. "subThemeDir": func() (any, error) { return s.GetSubThemeDir() },
  846. "subEnable": func() (any, error) { return s.GetSubEnable() },
  847. "subJsonEnable": func() (any, error) { return s.GetSubJsonEnable() },
  848. "subClashEnable": func() (any, error) { return s.GetSubClashEnable() },
  849. "subTitle": func() (any, error) { return s.GetSubTitle() },
  850. "subURI": func() (any, error) { return s.GetSubURI() },
  851. "subJsonURI": func() (any, error) { return s.GetSubJsonURI() },
  852. "subClashURI": func() (any, error) { return s.GetSubClashURI() },
  853. "remarkModel": func() (any, error) { return s.GetRemarkModel() },
  854. "datepicker": func() (any, error) { return s.GetDatepicker() },
  855. "ipLimitEnable": func() (any, error) { return s.GetIpLimitEnable() },
  856. "webDomain": func() (any, error) { return s.GetWebDomain() },
  857. "subDomain": func() (any, error) { return s.GetSubDomain() },
  858. }
  859. result := make(map[string]any)
  860. for key, fn := range settings {
  861. value, err := fn()
  862. if err != nil {
  863. return "", err
  864. }
  865. result[key] = value
  866. }
  867. subEnable := result["subEnable"].(bool)
  868. subJsonEnable := false
  869. if v, ok := result["subJsonEnable"]; ok {
  870. if b, ok2 := v.(bool); ok2 {
  871. subJsonEnable = b
  872. }
  873. }
  874. subClashEnable := false
  875. if v, ok := result["subClashEnable"]; ok {
  876. if b, ok2 := v.(bool); ok2 {
  877. subClashEnable = b
  878. }
  879. }
  880. if (subEnable && result["subURI"].(string) == "") || (subJsonEnable && result["subJsonURI"].(string) == "") || (subClashEnable && result["subClashURI"].(string) == "") {
  881. subURI := s.BuildSubURIBase(host)
  882. subTitle, _ := s.GetSubTitle()
  883. subPath, _ := s.GetSubPath()
  884. subJsonPath, _ := s.GetSubJsonPath()
  885. subClashPath, _ := s.GetSubClashPath()
  886. if subEnable && result["subURI"].(string) == "" {
  887. result["subURI"] = subURI + subPath
  888. }
  889. if result["subTitle"].(string) == "" {
  890. result["subTitle"] = subTitle
  891. }
  892. if subJsonEnable && result["subJsonURI"].(string) == "" {
  893. result["subJsonURI"] = subURI + subJsonPath
  894. }
  895. if subClashEnable && result["subClashURI"].(string) == "" {
  896. result["subClashURI"] = subURI + subClashPath
  897. }
  898. }
  899. return result, nil
  900. }