1
0

setting.go 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083
  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/internal/database"
  15. "github.com/mhsanaei/3x-ui/v3/internal/database/model"
  16. "github.com/mhsanaei/3x-ui/v3/internal/logger"
  17. "github.com/mhsanaei/3x-ui/v3/internal/util/common"
  18. "github.com/mhsanaei/3x-ui/v3/internal/util/netproxy"
  19. "github.com/mhsanaei/3x-ui/v3/internal/util/random"
  20. "github.com/mhsanaei/3x-ui/v3/internal/util/reflect_util"
  21. "github.com/mhsanaei/3x-ui/v3/internal/web/entity"
  22. "github.com/mhsanaei/3x-ui/v3/internal/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. "panelOutbound": "",
  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. // GetPanelOutbound returns the Xray outbound tag the panel's own outbound
  346. // requests (version checks, Telegram, subscription fetches) are routed through.
  347. func (s *SettingService) GetPanelOutbound() (string, error) {
  348. return s.getString("panelOutbound")
  349. }
  350. func (s *SettingService) SetPanelOutbound(tag string) error {
  351. return s.setString("panelOutbound", tag)
  352. }
  353. // PanelEgressProxyURL resolves the loopback SOCKS bridge that the generated
  354. // config exposes when a panel outbound is configured (see injectPanelEgress).
  355. // It returns "" — meaning a direct connection — when the feature is off or
  356. // the bridge is not present in the running core yet.
  357. func (s *SettingService) PanelEgressProxyURL() string {
  358. tag, err := s.GetPanelOutbound()
  359. if err != nil || tag == "" {
  360. return ""
  361. }
  362. proc := XrayProcess()
  363. if proc == nil || !proc.IsRunning() {
  364. logger.Warning("panel outbound [", tag, "] is set but Xray is not running, using a direct connection")
  365. return ""
  366. }
  367. cfg := proc.GetConfig()
  368. if cfg == nil {
  369. return ""
  370. }
  371. for i := range cfg.InboundConfigs {
  372. if cfg.InboundConfigs[i].Tag == PanelEgressInboundTag {
  373. return fmt.Sprintf("socks5://127.0.0.1:%d", cfg.InboundConfigs[i].Port)
  374. }
  375. }
  376. logger.Warning("panel outbound [", tag, "] is set but the egress bridge is not in the running config, using a direct connection")
  377. return ""
  378. }
  379. // NewProxiedHTTPClient returns an HTTP client that routes the panel's own
  380. // outbound requests through the configured panel outbound (via the loopback
  381. // SOCKS bridge in the running Xray). When the feature is off or the bridge
  382. // is unavailable it falls back to a direct client.
  383. func (s *SettingService) NewProxiedHTTPClient(timeout time.Duration) *http.Client {
  384. proxyUrl := s.PanelEgressProxyURL()
  385. client, err := netproxy.NewHTTPClient(proxyUrl, timeout)
  386. if err != nil {
  387. logger.Warningf("Invalid panel egress proxy %q, using direct connection: %v", proxyUrl, err)
  388. return &http.Client{Timeout: timeout}
  389. }
  390. return client
  391. }
  392. func (s *SettingService) GetTgBotAPIServer() (string, error) {
  393. return s.getString("tgBotAPIServer")
  394. }
  395. func (s *SettingService) SetTgBotAPIServer(token string) error {
  396. return s.setString("tgBotAPIServer", token)
  397. }
  398. func (s *SettingService) GetTgBotChatId() (string, error) {
  399. return s.getString("tgBotChatId")
  400. }
  401. func (s *SettingService) SetTgBotChatId(chatIds string) error {
  402. return s.setString("tgBotChatId", chatIds)
  403. }
  404. func (s *SettingService) GetTgbotEnabled() (bool, error) {
  405. return s.getBool("tgBotEnable")
  406. }
  407. func (s *SettingService) SetTgbotEnabled(value bool) error {
  408. return s.setBool("tgBotEnable", value)
  409. }
  410. func (s *SettingService) GetTgbotRuntime() (string, error) {
  411. return s.getString("tgRunTime")
  412. }
  413. func (s *SettingService) SetTgbotRuntime(time string) error {
  414. return s.setString("tgRunTime", time)
  415. }
  416. func (s *SettingService) GetTgBotBackup() (bool, error) {
  417. return s.getBool("tgBotBackup")
  418. }
  419. func (s *SettingService) GetTgBotLoginNotify() (bool, error) {
  420. return s.getBool("tgBotLoginNotify")
  421. }
  422. func (s *SettingService) GetTgCpu() (int, error) {
  423. return s.getInt("tgCpu")
  424. }
  425. func (s *SettingService) GetTgLang() (string, error) {
  426. return s.getString("tgLang")
  427. }
  428. func (s *SettingService) GetTwoFactorEnable() (bool, error) {
  429. return s.getBool("twoFactorEnable")
  430. }
  431. func (s *SettingService) SetTwoFactorEnable(value bool) error {
  432. return s.setBool("twoFactorEnable", value)
  433. }
  434. func (s *SettingService) GetTwoFactorToken() (string, error) {
  435. return s.getString("twoFactorToken")
  436. }
  437. func (s *SettingService) SetTwoFactorToken(value string) error {
  438. return s.setString("twoFactorToken", value)
  439. }
  440. func (s *SettingService) GetPort() (int, error) {
  441. return s.getInt("webPort")
  442. }
  443. func (s *SettingService) SetPort(port int) error {
  444. return s.setInt("webPort", port)
  445. }
  446. func (s *SettingService) SetCertFile(webCertFile string) error {
  447. return s.setString("webCertFile", webCertFile)
  448. }
  449. func (s *SettingService) GetCertFile() (string, error) {
  450. return s.getString("webCertFile")
  451. }
  452. func (s *SettingService) SetKeyFile(webKeyFile string) error {
  453. return s.setString("webKeyFile", webKeyFile)
  454. }
  455. func (s *SettingService) GetKeyFile() (string, error) {
  456. return s.getString("webKeyFile")
  457. }
  458. func (s *SettingService) GetExpireDiff() (int, error) {
  459. return s.getInt("expireDiff")
  460. }
  461. func (s *SettingService) GetTrafficDiff() (int, error) {
  462. return s.getInt("trafficDiff")
  463. }
  464. func (s *SettingService) GetSessionMaxAge() (int, error) {
  465. return s.getInt("sessionMaxAge")
  466. }
  467. func (s *SettingService) GetTrustedProxyCIDRs() (string, error) {
  468. return s.getString("trustedProxyCIDRs")
  469. }
  470. func (s *SettingService) GetRemarkModel() (string, error) {
  471. return s.getString("remarkModel")
  472. }
  473. func (s *SettingService) GetSecret() ([]byte, error) {
  474. secret, err := s.getString("secret")
  475. if secret == defaultValueMap["secret"] {
  476. err := s.saveSetting("secret", secret)
  477. if err != nil {
  478. logger.Warning("save secret failed:", err)
  479. }
  480. }
  481. return []byte(secret), err
  482. }
  483. // GetPanelGuid returns this panel's stable self-identifier, persisting a
  484. // freshly generated UUID on first read. It is the globally stable node
  485. // identity used to attribute online clients and inbounds to the physical
  486. // node that hosts them across a chain of nodes (#4983), where per-panel
  487. // autoincrement node ids are meaningless one hop away.
  488. func (s *SettingService) GetPanelGuid() (string, error) {
  489. guid, err := s.getString("panelGuid")
  490. if err != nil {
  491. return "", err
  492. }
  493. if guid == defaultValueMap["panelGuid"] {
  494. if saveErr := s.saveSetting("panelGuid", guid); saveErr != nil {
  495. logger.Warning("save panelGuid failed:", saveErr)
  496. }
  497. }
  498. return guid, nil
  499. }
  500. func (s *SettingService) SetBasePath(basePath string) error {
  501. if !strings.HasPrefix(basePath, "/") {
  502. basePath = "/" + basePath
  503. }
  504. if !strings.HasSuffix(basePath, "/") {
  505. basePath += "/"
  506. }
  507. return s.setString("webBasePath", basePath)
  508. }
  509. func (s *SettingService) GetBasePath() (string, error) {
  510. basePath, err := s.getString("webBasePath")
  511. if err != nil {
  512. return "", err
  513. }
  514. if !strings.HasPrefix(basePath, "/") {
  515. basePath = "/" + basePath
  516. }
  517. if !strings.HasSuffix(basePath, "/") {
  518. basePath += "/"
  519. }
  520. return basePath, nil
  521. }
  522. func (s *SettingService) GetTimeLocation() (*time.Location, error) {
  523. l, err := s.getString("timeLocation")
  524. if err != nil {
  525. return nil, err
  526. }
  527. location, err := time.LoadLocation(l)
  528. if err != nil {
  529. defaultLocation := defaultValueMap["timeLocation"]
  530. logger.Errorf("location <%v> not exist, using default location: %v", l, defaultLocation)
  531. location, err = time.LoadLocation(defaultLocation)
  532. if err != nil {
  533. logger.Errorf("failed to load default location, using UTC: %v", err)
  534. return time.UTC, nil
  535. }
  536. return location, nil
  537. }
  538. return location, nil
  539. }
  540. func (s *SettingService) GetSubEnable() (bool, error) {
  541. return s.getBool("subEnable")
  542. }
  543. func (s *SettingService) GetSubJsonEnable() (bool, error) {
  544. return s.getBool("subJsonEnable")
  545. }
  546. func (s *SettingService) GetSubTitle() (string, error) {
  547. return s.getString("subTitle")
  548. }
  549. func (s *SettingService) GetSubSupportUrl() (string, error) {
  550. return s.getString("subSupportUrl")
  551. }
  552. func (s *SettingService) GetSubProfileUrl() (string, error) {
  553. return s.getString("subProfileUrl")
  554. }
  555. func (s *SettingService) GetSubAnnounce() (string, error) {
  556. return s.getString("subAnnounce")
  557. }
  558. func (s *SettingService) GetSubEnableRouting() (bool, error) {
  559. return s.getBool("subEnableRouting")
  560. }
  561. func (s *SettingService) GetSubRoutingRules() (string, error) {
  562. return s.getString("subRoutingRules")
  563. }
  564. func (s *SettingService) GetSubListen() (string, error) {
  565. return s.getString("subListen")
  566. }
  567. func (s *SettingService) GetSubPort() (int, error) {
  568. return s.getInt("subPort")
  569. }
  570. func (s *SettingService) GetSubPath() (string, error) {
  571. return s.getString("subPath")
  572. }
  573. func (s *SettingService) GetSubJsonPath() (string, error) {
  574. return s.getString("subJsonPath")
  575. }
  576. func (s *SettingService) GetSubDomain() (string, error) {
  577. return s.getString("subDomain")
  578. }
  579. func (s *SettingService) SetSubCertFile(subCertFile string) error {
  580. return s.setString("subCertFile", subCertFile)
  581. }
  582. func (s *SettingService) GetSubCertFile() (string, error) {
  583. return s.getString("subCertFile")
  584. }
  585. func (s *SettingService) SetSubKeyFile(subKeyFile string) error {
  586. return s.setString("subKeyFile", subKeyFile)
  587. }
  588. func (s *SettingService) GetSubKeyFile() (string, error) {
  589. return s.getString("subKeyFile")
  590. }
  591. func (s *SettingService) GetSubUpdates() (string, error) {
  592. return s.getString("subUpdates")
  593. }
  594. func (s *SettingService) GetSubEncrypt() (bool, error) {
  595. return s.getBool("subEncrypt")
  596. }
  597. func (s *SettingService) GetSubShowInfo() (bool, error) {
  598. return s.getBool("subShowInfo")
  599. }
  600. func (s *SettingService) GetSubEmailInRemark() (bool, error) {
  601. return s.getBool("subEmailInRemark")
  602. }
  603. func (s *SettingService) GetPageSize() (int, error) {
  604. return s.getInt("pageSize")
  605. }
  606. func (s *SettingService) GetSubURI() (string, error) {
  607. return s.getString("subURI")
  608. }
  609. func (s *SettingService) GetSubJsonURI() (string, error) {
  610. return s.getString("subJsonURI")
  611. }
  612. func (s *SettingService) GetSubClashEnable() (bool, error) {
  613. return s.getBool("subClashEnable")
  614. }
  615. func (s *SettingService) GetSubClashPath() (string, error) {
  616. return s.getString("subClashPath")
  617. }
  618. func (s *SettingService) GetSubClashURI() (string, error) {
  619. return s.getString("subClashURI")
  620. }
  621. func (s *SettingService) GetSubClashEnableRouting() (bool, error) {
  622. return s.getBool("subClashEnableRouting")
  623. }
  624. func (s *SettingService) GetSubClashRules() (string, error) {
  625. return s.getString("subClashRules")
  626. }
  627. func (s *SettingService) GetSubJsonMux() (string, error) {
  628. return s.getString("subJsonMux")
  629. }
  630. func (s *SettingService) GetSubJsonRules() (string, error) {
  631. return s.getString("subJsonRules")
  632. }
  633. func (s *SettingService) GetSubJsonFinalMask() (string, error) {
  634. return s.getString("subJsonFinalMask")
  635. }
  636. func (s *SettingService) GetSubThemeDir() (string, error) {
  637. return s.getString("subThemeDir")
  638. }
  639. func (s *SettingService) GetDatepicker() (string, error) {
  640. return s.getString("datepicker")
  641. }
  642. func (s *SettingService) GetWarp() (string, error) {
  643. return s.getString("warp")
  644. }
  645. func (s *SettingService) SetWarp(data string) error {
  646. return s.setString("warp", data)
  647. }
  648. func (s *SettingService) GetNord() (string, error) {
  649. return s.getString("nord")
  650. }
  651. func (s *SettingService) SetNord(data string) error {
  652. return s.setString("nord", data)
  653. }
  654. func (s *SettingService) GetExternalTrafficInformEnable() (bool, error) {
  655. return s.getBool("externalTrafficInformEnable")
  656. }
  657. func (s *SettingService) SetExternalTrafficInformEnable(value bool) error {
  658. return s.setBool("externalTrafficInformEnable", value)
  659. }
  660. func (s *SettingService) GetExternalTrafficInformURI() (string, error) {
  661. return s.getString("externalTrafficInformURI")
  662. }
  663. func (s *SettingService) SetExternalTrafficInformURI(InformURI string) error {
  664. return s.setString("externalTrafficInformURI", InformURI)
  665. }
  666. func (s *SettingService) GetRestartXrayOnClientDisable() (bool, error) {
  667. return s.getBool("restartXrayOnClientDisable")
  668. }
  669. func (s *SettingService) SetRestartXrayOnClientDisable(value bool) error {
  670. return s.setBool("restartXrayOnClientDisable", value)
  671. }
  672. func (s *SettingService) GetIpLimitEnable() (bool, error) {
  673. accessLogPath, err := xray.GetAccessLogPath()
  674. if err != nil {
  675. return false, err
  676. }
  677. return (accessLogPath != "none" && accessLogPath != ""), nil
  678. }
  679. // GetLdapEnable returns whether LDAP is enabled.
  680. func (s *SettingService) GetLdapEnable() (bool, error) {
  681. return s.getBool("ldapEnable")
  682. }
  683. func (s *SettingService) GetLdapHost() (string, error) {
  684. return s.getString("ldapHost")
  685. }
  686. func (s *SettingService) GetLdapPort() (int, error) {
  687. return s.getInt("ldapPort")
  688. }
  689. func (s *SettingService) GetLdapUseTLS() (bool, error) {
  690. return s.getBool("ldapUseTLS")
  691. }
  692. func (s *SettingService) GetLdapBindDN() (string, error) {
  693. return s.getString("ldapBindDN")
  694. }
  695. func (s *SettingService) GetLdapPassword() (string, error) {
  696. return s.getString("ldapPassword")
  697. }
  698. func (s *SettingService) GetLdapBaseDN() (string, error) {
  699. return s.getString("ldapBaseDN")
  700. }
  701. func (s *SettingService) GetLdapUserFilter() (string, error) {
  702. return s.getString("ldapUserFilter")
  703. }
  704. func (s *SettingService) GetLdapUserAttr() (string, error) {
  705. return s.getString("ldapUserAttr")
  706. }
  707. func (s *SettingService) GetLdapVlessField() (string, error) {
  708. return s.getString("ldapVlessField")
  709. }
  710. func (s *SettingService) GetLdapSyncCron() (string, error) {
  711. return s.getString("ldapSyncCron")
  712. }
  713. func (s *SettingService) GetLdapFlagField() (string, error) {
  714. return s.getString("ldapFlagField")
  715. }
  716. func (s *SettingService) GetLdapTruthyValues() (string, error) {
  717. return s.getString("ldapTruthyValues")
  718. }
  719. func (s *SettingService) GetLdapInvertFlag() (bool, error) {
  720. return s.getBool("ldapInvertFlag")
  721. }
  722. func (s *SettingService) GetLdapInboundTags() (string, error) {
  723. return s.getString("ldapInboundTags")
  724. }
  725. func (s *SettingService) GetLdapAutoCreate() (bool, error) {
  726. return s.getBool("ldapAutoCreate")
  727. }
  728. func (s *SettingService) GetLdapAutoDelete() (bool, error) {
  729. return s.getBool("ldapAutoDelete")
  730. }
  731. func (s *SettingService) GetLdapDefaultTotalGB() (int, error) {
  732. return s.getInt("ldapDefaultTotalGB")
  733. }
  734. func (s *SettingService) GetLdapDefaultExpiryDays() (int, error) {
  735. return s.getInt("ldapDefaultExpiryDays")
  736. }
  737. func (s *SettingService) GetLdapDefaultLimitIP() (int, error) {
  738. return s.getInt("ldapDefaultLimitIP")
  739. }
  740. func (s *SettingService) UpdateAllSetting(allSetting *entity.AllSetting) error {
  741. if err := s.preserveRedactedSecrets(allSetting); err != nil {
  742. return err
  743. }
  744. if err := validateSettingsURLs(allSetting); err != nil {
  745. return err
  746. }
  747. if err := allSetting.CheckValid(); err != nil {
  748. return err
  749. }
  750. v := reflect.ValueOf(allSetting).Elem()
  751. t := reflect.TypeFor[entity.AllSetting]()
  752. fields := reflect_util.GetFields(t)
  753. errs := make([]error, 0)
  754. for _, field := range fields {
  755. key := field.Tag.Get("json")
  756. fieldV := v.FieldByName(field.Name)
  757. value := fmt.Sprint(fieldV.Interface())
  758. err := s.saveSetting(key, value)
  759. if err != nil {
  760. errs = append(errs, err)
  761. }
  762. }
  763. return common.Combine(errs...)
  764. }
  765. func (s *SettingService) preserveRedactedSecrets(allSetting *entity.AllSetting) error {
  766. if strings.TrimSpace(allSetting.TgBotToken) == "" {
  767. value, err := s.GetTgBotToken()
  768. if err != nil {
  769. return err
  770. }
  771. allSetting.TgBotToken = value
  772. }
  773. if strings.TrimSpace(allSetting.LdapPassword) == "" {
  774. value, err := s.GetLdapPassword()
  775. if err != nil {
  776. return err
  777. }
  778. allSetting.LdapPassword = value
  779. }
  780. if allSetting.TwoFactorEnable && strings.TrimSpace(allSetting.TwoFactorToken) == "" {
  781. value, err := s.GetTwoFactorToken()
  782. if err != nil {
  783. return err
  784. }
  785. allSetting.TwoFactorToken = value
  786. }
  787. return nil
  788. }
  789. func validateSettingsURLs(allSetting *entity.AllSetting) error {
  790. if allSetting.ExternalTrafficInformURI != "" {
  791. u, err := SanitizeHTTPURL(allSetting.ExternalTrafficInformURI)
  792. if err != nil {
  793. return common.NewError("external traffic inform URI is invalid:", err)
  794. }
  795. allSetting.ExternalTrafficInformURI = u
  796. }
  797. if allSetting.TgBotAPIServer != "" {
  798. u, err := SanitizeHTTPURL(allSetting.TgBotAPIServer)
  799. if err != nil {
  800. return common.NewError("telegram API server URL is invalid:", err)
  801. }
  802. allSetting.TgBotAPIServer = u
  803. }
  804. return nil
  805. }
  806. func (s *SettingService) UpdateSecret(key string, value string) error {
  807. switch key {
  808. case "tgBotToken", "ldapPassword", "twoFactorToken":
  809. return s.saveSetting(key, strings.TrimSpace(value))
  810. default:
  811. return common.NewError("secret key is not replaceable:", key)
  812. }
  813. }
  814. func (s *SettingService) GetDefaultXrayConfig() (any, error) {
  815. var jsonData any
  816. err := json.Unmarshal([]byte(xrayTemplateConfig), &jsonData)
  817. if err != nil {
  818. return nil, err
  819. }
  820. return jsonData, nil
  821. }
  822. func extractHostname(host string) string {
  823. h, _, err := net.SplitHostPort(host)
  824. // Err is not nil means host does not contain port
  825. if err != nil {
  826. h = host
  827. }
  828. ip := net.ParseIP(h)
  829. // If it's not an IP, return as is
  830. if ip == nil {
  831. return h
  832. }
  833. // If it's an IPv4, return as is
  834. if ip.To4() != nil {
  835. return h
  836. }
  837. // IPv6 needs bracketing
  838. return "[" + h + "]"
  839. }
  840. // BuildSubURIBase is shared by GetDefaultSettings (the panel's Client
  841. // Information page) and the subscription page so both render subscription
  842. // URLs identically.
  843. func (s *SettingService) BuildSubURIBase(host string) string {
  844. subPort, _ := s.GetSubPort()
  845. subDomain, _ := s.GetSubDomain()
  846. subKeyFile, _ := s.GetSubKeyFile()
  847. subCertFile, _ := s.GetSubCertFile()
  848. subTLS := subKeyFile != "" && subCertFile != ""
  849. if subDomain == "" {
  850. subDomain = extractHostname(host)
  851. }
  852. scheme := "http"
  853. if subTLS {
  854. scheme = "https"
  855. }
  856. if (subPort == 443 && subTLS) || (subPort == 80 && !subTLS) {
  857. return scheme + "://" + subDomain
  858. }
  859. return fmt.Sprintf("%s://%s:%d", scheme, subDomain, subPort)
  860. }
  861. func (s *SettingService) GetDefaultSettings(host string) (any, error) {
  862. type settingFunc func() (any, error)
  863. settings := map[string]settingFunc{
  864. "expireDiff": func() (any, error) { return s.GetExpireDiff() },
  865. "trafficDiff": func() (any, error) { return s.GetTrafficDiff() },
  866. "pageSize": func() (any, error) { return s.GetPageSize() },
  867. "defaultCert": func() (any, error) { return s.GetCertFile() },
  868. "defaultKey": func() (any, error) { return s.GetKeyFile() },
  869. "tgBotEnable": func() (any, error) { return s.GetTgbotEnabled() },
  870. "subThemeDir": func() (any, error) { return s.GetSubThemeDir() },
  871. "subEnable": func() (any, error) { return s.GetSubEnable() },
  872. "subJsonEnable": func() (any, error) { return s.GetSubJsonEnable() },
  873. "subClashEnable": func() (any, error) { return s.GetSubClashEnable() },
  874. "subTitle": func() (any, error) { return s.GetSubTitle() },
  875. "subURI": func() (any, error) { return s.GetSubURI() },
  876. "subJsonURI": func() (any, error) { return s.GetSubJsonURI() },
  877. "subClashURI": func() (any, error) { return s.GetSubClashURI() },
  878. "remarkModel": func() (any, error) { return s.GetRemarkModel() },
  879. "datepicker": func() (any, error) { return s.GetDatepicker() },
  880. "ipLimitEnable": func() (any, error) { return s.GetIpLimitEnable() },
  881. "webDomain": func() (any, error) { return s.GetWebDomain() },
  882. "subDomain": func() (any, error) { return s.GetSubDomain() },
  883. }
  884. result := make(map[string]any)
  885. for key, fn := range settings {
  886. value, err := fn()
  887. if err != nil {
  888. return "", err
  889. }
  890. result[key] = value
  891. }
  892. subEnable := result["subEnable"].(bool)
  893. subJsonEnable := false
  894. if v, ok := result["subJsonEnable"]; ok {
  895. if b, ok2 := v.(bool); ok2 {
  896. subJsonEnable = b
  897. }
  898. }
  899. subClashEnable := false
  900. if v, ok := result["subClashEnable"]; ok {
  901. if b, ok2 := v.(bool); ok2 {
  902. subClashEnable = b
  903. }
  904. }
  905. if (subEnable && result["subURI"].(string) == "") || (subJsonEnable && result["subJsonURI"].(string) == "") || (subClashEnable && result["subClashURI"].(string) == "") {
  906. subURI := s.BuildSubURIBase(host)
  907. subTitle, _ := s.GetSubTitle()
  908. subPath, _ := s.GetSubPath()
  909. subJsonPath, _ := s.GetSubJsonPath()
  910. subClashPath, _ := s.GetSubClashPath()
  911. if subEnable && result["subURI"].(string) == "" {
  912. result["subURI"] = subURI + subPath
  913. }
  914. if result["subTitle"].(string) == "" {
  915. result["subTitle"] = subTitle
  916. }
  917. if subJsonEnable && result["subJsonURI"].(string) == "" {
  918. result["subJsonURI"] = subURI + subJsonPath
  919. }
  920. if subClashEnable && result["subClashURI"].(string) == "" {
  921. result["subClashURI"] = subURI + subClashPath
  922. }
  923. }
  924. return result, nil
  925. }