1
0

setting.go 31 KB

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