1
0

setting.go 27 KB

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