remark_vars_test.go 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612
  1. package sub
  2. import (
  3. "strings"
  4. "testing"
  5. "github.com/mhsanaei/3x-ui/v3/internal/database/model"
  6. "github.com/mhsanaei/3x-ui/v3/internal/xray"
  7. )
  8. const gb = int64(1024 * 1024 * 1024)
  9. // expandCtx builds a remarkContext from explicit pieces for token tests.
  10. func expandCtx(client model.Client, stats xray.ClientTraffic, inbound *model.Inbound) remarkContext {
  11. return remarkContext{client: client, stats: stats, inbound: inbound}
  12. }
  13. func TestExpandRemarkVars(t *testing.T) {
  14. inbound := &model.Inbound{Remark: "Germany"}
  15. client := model.Client{
  16. Email: "[email protected]",
  17. ID: "3f2a9c1b-aaaa-bbbb-cccc-1234567890ab",
  18. TgID: 123456789,
  19. SubID: "subABC",
  20. Comment: "vip",
  21. Reset: 30,
  22. CreatedAt: 1_700_000_000_000,
  23. }
  24. // 50GB total, 8GB used (5 up + 3 down), enabled, no expiry.
  25. stats := xray.ClientTraffic{
  26. Enable: true,
  27. Total: 50 * gb,
  28. Up: 5 * gb,
  29. Down: 3 * gb,
  30. }
  31. ctx := expandCtx(client, stats, inbound)
  32. cases := []struct{ tmpl, want string }{
  33. {"{{EMAIL}}", "[email protected]"},
  34. {"{{INBOUND}}", "Germany"}, // no host remark in ctx → inbound remark
  35. {"{{HOST}}", ""}, // no host remark in ctx → empty
  36. {"{{ID}}", client.ID},
  37. {"{{SHORT_ID}}", "3f2a9c1b"},
  38. {"{{TELEGRAM_ID}}", "123456789"},
  39. {"{{SUB_ID}}", "subABC"},
  40. {"{{COMMENT}}", "vip"},
  41. {"{{RESET_DAYS}}", "30"},
  42. {"{{CREATED_UNIX}}", "1700000000"},
  43. {"{{TRAFFIC_USED}}", "8.00GB"},
  44. {"{{TRAFFIC_LEFT}}", "42.00GB"},
  45. {"{{TRAFFIC_TOTAL}}", "50.00GB"},
  46. {"{{TRAFFIC_USED_BYTES}}", "8589934592"},
  47. {"{{TRAFFIC_TOTAL_BYTES}}", "53687091200"},
  48. {"{{UP}}", "5.00GB"},
  49. {"{{DOWN}}", "3.00GB"},
  50. {"{{STATUS}}", "active"},
  51. {"{{EXPIRE_UNIX}}", "0"}, // no expiry
  52. {"{{EXPIRE_DATE}}", ""}, // no fixed date
  53. {"{{UNKNOWN_TOKEN}}", ""}, // unknown → empty, never literal
  54. {"DE {{EMAIL}} ok", "DE [email protected] ok"},
  55. {"{{EMAIL}}-{{SHORT_ID}}", "[email protected]"},
  56. {"no tokens here", "no tokens here"},
  57. }
  58. for _, c := range cases {
  59. if got := expandRemarkVars(c.tmpl, ctx); got != c.want {
  60. t.Errorf("expandRemarkVars(%q) = %q, want %q", c.tmpl, got, c.want)
  61. }
  62. }
  63. // The unlimited tokens still render ∞ at the value layer; expandRemarkVars
  64. // is what drops an all-unlimited segment (see TestExpandRemarkVars_DropUnlimitedSegments).
  65. if got := remarkVarValue("DAYS_LEFT", ctx); got != "∞" {
  66. t.Errorf("remarkVarValue(DAYS_LEFT) = %q, want ∞", got)
  67. }
  68. }
  69. func TestExpandRemarkVars_EdgeCases(t *testing.T) {
  70. // Unlimited total → ∞ for human forms, 0 bytes for *_BYTES left. Checked at
  71. // the value layer: expandRemarkVars would drop a bare ∞ segment.
  72. unlimited := expandCtx(model.Client{}, xray.ClientTraffic{Enable: true, Total: 0, Up: gb}, nil)
  73. if got := remarkVarValue("TRAFFIC_TOTAL", unlimited); got != "∞" {
  74. t.Errorf("unlimited TRAFFIC_TOTAL = %q, want ∞", got)
  75. }
  76. if got := remarkVarValue("TRAFFIC_LEFT", unlimited); got != "∞" {
  77. t.Errorf("unlimited TRAFFIC_LEFT = %q, want ∞", got)
  78. }
  79. if got := expandRemarkVars("{{TRAFFIC_LEFT_BYTES}}", unlimited); got != "0" {
  80. t.Errorf("unlimited TRAFFIC_LEFT_BYTES = %q, want 0", got)
  81. }
  82. // TgID zero → empty.
  83. if got := expandRemarkVars("{{TELEGRAM_ID}}", unlimited); got != "" {
  84. t.Errorf("zero TgID = %q, want empty", got)
  85. }
  86. // Over-quota usage clamps left to 0, not negative.
  87. over := expandCtx(model.Client{}, xray.ClientTraffic{Enable: true, Total: gb, Up: 2 * gb}, nil)
  88. if got := expandRemarkVars("{{TRAFFIC_LEFT_BYTES}}", over); got != "0" {
  89. t.Errorf("over-quota TRAFFIC_LEFT_BYTES = %q, want 0", got)
  90. }
  91. // Delayed-start (negative expiry) gives deterministic whole days.
  92. delayed := expandCtx(model.Client{}, xray.ClientTraffic{Enable: true, ExpiryTime: -864_000_000}, nil)
  93. if got := expandRemarkVars("{{DAYS_LEFT}}", delayed); got != "10" {
  94. t.Errorf("delayed-start DAYS_LEFT = %q, want 10", got)
  95. }
  96. }
  97. // An unlimited client drops the quota/expiry segments whole — decoration and the
  98. // "|" separator included — instead of printing "📊∞|⏳∞D".
  99. func TestExpandRemarkVars_DropUnlimitedSegments(t *testing.T) {
  100. const tmpl = "{{INBOUND}}|📊{{TRAFFIC_LEFT}}|⏳{{DAYS_LEFT}}D"
  101. inbound := &model.Inbound{Remark: "host"}
  102. // No limit at all → only the name segment survives.
  103. unlimited := expandCtx(model.Client{}, xray.ClientTraffic{Enable: true}, inbound)
  104. if got := expandRemarkVars(tmpl, unlimited); got != "host" {
  105. t.Errorf("fully unlimited = %q, want %q", got, "host")
  106. }
  107. // Limited traffic but no expiry → traffic stays, the expiry segment drops.
  108. noExpiry := expandCtx(model.Client{}, xray.ClientTraffic{Enable: true, Total: 50 * gb, Up: 8 * gb}, inbound)
  109. if got := expandRemarkVars(tmpl, noExpiry); got != "host|📊42.00GB" {
  110. t.Errorf("no-expiry = %q, want %q", got, "host|📊42.00GB")
  111. }
  112. // A segment mixing an unlimited token with another value is kept whole,
  113. // decoration and ∞ included — only all-unlimited segments drop.
  114. mixed := expandCtx(model.Client{Email: "john"}, xray.ClientTraffic{Enable: true}, inbound)
  115. if got := expandRemarkVars("{{EMAIL}} 📊{{TRAFFIC_LEFT}}", mixed); got != "john 📊∞" {
  116. t.Errorf("mixed segment = %q, want %q", got, "john 📊∞")
  117. }
  118. }
  119. func TestClientStatus(t *testing.T) {
  120. cases := []struct {
  121. name string
  122. st xray.ClientTraffic
  123. want string
  124. }{
  125. {"disabled", xray.ClientTraffic{Enable: false}, "disabled"},
  126. {"active", xray.ClientTraffic{Enable: true}, "active"},
  127. {"expired", xray.ClientTraffic{Enable: true, ExpiryTime: 1000}, "expired"}, // 1s past epoch
  128. {"depleted", xray.ClientTraffic{Enable: true, Total: gb, Up: gb}, "depleted"},
  129. }
  130. for _, c := range cases {
  131. if got := clientStatus(c.st); got != c.want {
  132. t.Errorf("%s: clientStatus = %q, want %q", c.name, got, c.want)
  133. }
  134. }
  135. }
  136. // hostRemarkService builds a SubService + inbound + client/stats for remark tests.
  137. func hostRemarkService(template string) (*SubService, *model.Inbound, model.Client) {
  138. s := &SubService{remarkTemplate: template, subscriptionBody: true}
  139. inbound := &model.Inbound{
  140. Remark: "DE",
  141. ClientStats: []xray.ClientTraffic{{
  142. Email: "[email protected]",
  143. Enable: true,
  144. Total: 100 * gb,
  145. Up: 15 * gb,
  146. Down: 5 * gb,
  147. ExpiryTime: -864_000_000, // delayed-start: deterministic 10 days
  148. }},
  149. }
  150. client := model.Client{Email: "[email protected]"}
  151. return s, inbound, client
  152. }
  153. // With no template configured, genHostRemark falls back to the inbound remark,
  154. // host and email joined by "-".
  155. func TestGenHostRemark_NoTemplate_Fallback(t *testing.T) {
  156. s, inbound, client := hostRemarkService("")
  157. if got := s.genHostRemark(inbound, client, "Relay", ""); got != "[email protected]" {
  158. t.Fatalf("genHostRemark = %q, want %q", got, "[email protected]")
  159. }
  160. if got := s.genHostRemark(inbound, client, "", ""); got != "[email protected]" {
  161. t.Fatalf("genHostRemark (no host remark) = %q, want %q", got, "[email protected]")
  162. }
  163. }
  164. // In the body the template applies: {{INBOUND}} is always the inbound's remark
  165. // and {{HOST}} the host's own remark, so the two can be shown side by side.
  166. func TestGenHostRemark_GlobalTemplate(t *testing.T) {
  167. // {{INBOUND}} resolves to the inbound remark regardless of the host remark.
  168. s, inbound, client := hostRemarkService("{{INBOUND}} | {{TRAFFIC_LEFT}} | {{DAYS_LEFT}}d")
  169. if got := s.genHostRemark(inbound, client, "CDN", ""); got != "DE | 80.00GB | 10d" {
  170. t.Fatalf("global template ({{INBOUND}} = inbound) = %q", got)
  171. }
  172. // {{INBOUND}} and {{HOST}} side by side show both, distinctly (#5443).
  173. s2, inbound2, client2 := hostRemarkService("{{INBOUND}}|{{HOST}}|{{TRAFFIC_LEFT}}")
  174. if got := s2.genHostRemark(inbound2, client2, "CDN", ""); got != "DE|CDN|80.00GB" {
  175. t.Fatalf("global template (inbound + host) = %q, want %q", got, "DE|CDN|80.00GB")
  176. }
  177. // {{HOST}} is the host's own remark even when the inbound has one of its own.
  178. s3, inbound3, client3 := hostRemarkService("{{HOST}}")
  179. if got := s3.genHostRemark(inbound3, client3, "CDN", ""); got != "CDN" {
  180. t.Fatalf("{{HOST}} token = %q, want CDN", got)
  181. }
  182. }
  183. // A global template also drives non-host links via genRemark; {{HOST}} = the
  184. // legacy externalProxy remark passed as extra.
  185. func TestGenRemark_GlobalTemplate(t *testing.T) {
  186. s, inbound, _ := hostRemarkService("{{EMAIL}} | {{TRAFFIC_LEFT}}")
  187. got := s.genRemark(inbound, "[email protected]", "", "")
  188. if got != "[email protected] | 80.00GB" {
  189. t.Fatalf("global template (non-host) = %q", got)
  190. }
  191. }
  192. func TestGenRemark_NoTemplate_AppendsEmail(t *testing.T) {
  193. s, inbound, _ := hostRemarkService("")
  194. got := s.genRemark(inbound, "[email protected]", "Relay", "")
  195. if got != "[email protected]" {
  196. t.Fatalf("genRemark = %q, want %q", got, "[email protected]")
  197. }
  198. }
  199. // The per-client info part of the template renders only on a client's first
  200. // link of the request; later links show the name-only template.
  201. func TestUsageOnFirstLinkOnly(t *testing.T) {
  202. s, inbound, client := hostRemarkService("{{INBOUND}}|📊{{TRAFFIC_LEFT}}|⏳{{DAYS_LEFT}}D")
  203. first := s.genHostRemark(inbound, client, "", "")
  204. second := s.genHostRemark(inbound, client, "", "")
  205. if !strings.Contains(first, "📊") || !strings.Contains(first, "80.00GB") {
  206. t.Fatalf("first link should carry usage: %q", first)
  207. }
  208. if strings.ContainsAny(second, "📊⏳") {
  209. t.Fatalf("second link must not carry usage: %q", second)
  210. }
  211. if second != "DE" {
  212. t.Fatalf("second link = %q, want name-only %q", second, "DE")
  213. }
  214. }
  215. func TestRemarkInDisplayContext(t *testing.T) {
  216. s, inbound, client := hostRemarkService("{{INBOUND}}-{{EMAIL}}|📊{{TRAFFIC_LEFT}}|⏳{{DAYS_LEFT}}D")
  217. s.subscriptionBody = false
  218. const want = "[email protected]"
  219. if got := s.genHostRemark(inbound, client, "CDN", ""); got != want {
  220. t.Fatalf("display host link = %q, want %q", got, want)
  221. }
  222. if got := s.genHostRemark(inbound, client, "", ""); got != want {
  223. t.Fatalf("display host link (no host) = %q, want %q", got, want)
  224. }
  225. if got := s.genRemark(inbound, client.Email, "", ""); got != want {
  226. t.Fatalf("display genRemark = %q, want %q", got, want)
  227. }
  228. s2, inbound2, client2 := hostRemarkService("{{INBOUND}}-{{HOST}}|📊{{TRAFFIC_LEFT}}")
  229. s2.subscriptionBody = false
  230. if got := s2.genHostRemark(inbound2, client2, "CDN", ""); got != "DE-CDN" {
  231. t.Fatalf("display host link with HOST token = %q, want %q", got, "DE-CDN")
  232. }
  233. }
  234. func TestFilterRemarkTemplate_BodyRepeat(t *testing.T) {
  235. cases := map[string]string{
  236. "{{INBOUND}}|📊{{TRAFFIC_LEFT}}|{{PROTOCOL}}-{{TRANSPORT}}-{{SECURITY}}": "{{INBOUND}}|{{PROTOCOL}}-{{TRANSPORT}}-{{SECURITY}}",
  237. "{{INBOUND}}|📊{{TRAFFIC_LEFT}}|⏳{{DAYS_LEFT}}D": "{{INBOUND}}",
  238. "{{INBOUND}} {{PROTOCOL}}|📊{{TRAFFIC_LEFT}}": "{{INBOUND}} {{PROTOCOL}}",
  239. "{{INBOUND}}-{{EMAIL}}": "{{INBOUND}}-{{EMAIL}}",
  240. "{{TRAFFIC_LEFT}}|{{SECURITY}}": "{{SECURITY}}",
  241. "{{INBOUND}}|📊{{TRAFFIC_LEFT}} {{PROTOCOL}}": "{{INBOUND}}|{{PROTOCOL}}",
  242. "{{INBOUND}}|📊{{TRAFFIC_LEFT}}|{{EMAIL}}": "{{INBOUND}}|{{EMAIL}}",
  243. "{{INBOUND}}|📊{{TRAFFIC_LEFT}}|⏳{{DAYS_LEFT}}D{{PROTOCOL}}{{TRANSPORT}}{{SECURITY}}": "{{INBOUND}}|{{PROTOCOL}}{{TRANSPORT}}{{SECURITY}}",
  244. "{{EMAIL}} {{TRAFFIC_USED}}5h": "{{EMAIL}}",
  245. "{{PROTOCOL}} {{TRAFFIC_LEFT}}GB": "{{PROTOCOL}}",
  246. "{{EMAIL}}-{{TRAFFIC_LEFT}}D-{{HOST}}": "{{EMAIL}} {{HOST}}",
  247. "{{EMAIL}} 📊{{TRAFFIC_LEFT}} {{PROTOCOL}}": "{{EMAIL}} {{PROTOCOL}}",
  248. }
  249. for tmpl, want := range cases {
  250. if got := filterRemarkTemplate(tmpl, usageInfoTokens); got != want {
  251. t.Errorf("filterRemarkTemplate(%q, usage) = %q, want %q", tmpl, got, want)
  252. }
  253. }
  254. }
  255. func TestFilterRemarkTemplate_Display(t *testing.T) {
  256. cases := map[string]string{
  257. "{{INBOUND}}-{{EMAIL}}|📊{{TRAFFIC_LEFT}}|{{PROTOCOL}}": "{{INBOUND}}-{{EMAIL}}",
  258. "{{INBOUND}} {{PROTOCOL}}": "{{INBOUND}}",
  259. "{{EMAIL}} {{INBOUND}} ⏳{{DAYS_LEFT}}": "{{EMAIL}} {{INBOUND}}",
  260. "{{INBOUND}} | {{STATUS}}": "{{INBOUND}}",
  261. "{{INBOUND}}-{{EMAIL}}": "{{INBOUND}}-{{EMAIL}}",
  262. "{{TRAFFIC_LEFT}}": "",
  263. "{{INBOUND}}|📊{{TRAFFIC_LEFT}}|{{HOST}}": "{{INBOUND}}|{{HOST}}",
  264. "{{EMAIL}} ⏳{{DAYS_LEFT}}D {{HOST}}": "{{EMAIL}} {{HOST}}",
  265. "{{INBOUND}} {{TRAFFIC_LEFT}} {{EMAIL}}": "{{INBOUND}} {{EMAIL}}",
  266. }
  267. for tmpl, want := range cases {
  268. if got := filterRemarkTemplate(tmpl, displayRemoveTokens); got != want {
  269. t.Errorf("filterRemarkTemplate(%q, display) = %q, want %q", tmpl, got, want)
  270. }
  271. }
  272. }
  273. func TestConnectionTokensOnEveryBodyLink(t *testing.T) {
  274. s := &SubService{
  275. remarkTemplate: "{{INBOUND}}|📊{{TRAFFIC_LEFT}}|{{PROTOCOL}} {{TRANSPORT}} {{SECURITY}}",
  276. subscriptionBody: true,
  277. usageShown: map[string]bool{},
  278. }
  279. inbound := &model.Inbound{
  280. Remark: "DE",
  281. Protocol: "vless",
  282. StreamSettings: `{"network":"ws","security":"tls"}`,
  283. ClientStats: []xray.ClientTraffic{{Email: "john@x", Enable: true, Total: 100 * gb, Up: 30 * gb}},
  284. }
  285. client := model.Client{Email: "john@x"}
  286. first := s.genTemplatedRemark(inbound, client, "", "ws")
  287. second := s.genTemplatedRemark(inbound, client, "", "ws")
  288. for _, want := range []string{"VLESS", "ws", "TLS"} {
  289. if !strings.Contains(first, want) {
  290. t.Fatalf("first body link %q missing %q", first, want)
  291. }
  292. if !strings.Contains(second, want) {
  293. t.Fatalf("repeat body link %q missing connection token %q", second, want)
  294. }
  295. }
  296. if strings.ContainsAny(second, "📊") || strings.Contains(second, "GB") {
  297. t.Fatalf("repeat body link must drop the usage block: %q", second)
  298. }
  299. }
  300. func TestConnectionTokensMixedIntoUsageSegment(t *testing.T) {
  301. s := &SubService{
  302. remarkTemplate: "{{INBOUND}}-{{EMAIL}}|📊{{TRAFFIC_LEFT}}|⏳{{DAYS_LEFT}}D {{PROTOCOL}} {{TRANSPORT}} {{SECURITY}}",
  303. subscriptionBody: true,
  304. usageShown: map[string]bool{},
  305. }
  306. inbound := &model.Inbound{
  307. Remark: "DE",
  308. Protocol: "vless",
  309. StreamSettings: `{"network":"grpc","security":"reality"}`,
  310. ClientStats: []xray.ClientTraffic{{Email: "john@x", Enable: true, Total: 100 * gb, Up: 30 * gb}},
  311. }
  312. client := model.Client{Email: "john@x"}
  313. _ = s.genTemplatedRemark(inbound, client, "", "grpc")
  314. second := s.genTemplatedRemark(inbound, client, "", "grpc")
  315. for _, want := range []string{"VLESS", "grpc", "REALITY"} {
  316. if !strings.Contains(second, want) {
  317. t.Fatalf("repeat body link %q missing connection token %q", second, want)
  318. }
  319. }
  320. if strings.Contains(second, "GB") || strings.ContainsRune(second, '⏳') {
  321. t.Fatalf("repeat body link must drop the usage block: %q", second)
  322. }
  323. }
  324. func TestConnectionTokensDisplayContextUnchanged(t *testing.T) {
  325. s := &SubService{
  326. remarkTemplate: "{{INBOUND}}|📊{{TRAFFIC_LEFT}}|{{PROTOCOL}}",
  327. subscriptionBody: false,
  328. }
  329. inbound := &model.Inbound{
  330. Remark: "DE",
  331. Protocol: "vless",
  332. StreamSettings: `{"network":"ws","security":"tls"}`,
  333. ClientStats: []xray.ClientTraffic{{Email: "john@x", Enable: true, Total: 100 * gb, Up: 30 * gb}},
  334. }
  335. if got := s.genTemplatedRemark(inbound, model.Client{Email: "john@x"}, "", "ws"); got != "DE" {
  336. t.Fatalf("display remark = %q, want DE (connection after usage stripped outside the body)", got)
  337. }
  338. }
  339. func TestIdentityTokensEverywhere(t *testing.T) {
  340. const tmpl = "{{INBOUND}}|📊{{TRAFFIC_LEFT}}|{{EMAIL}}"
  341. inbound := &model.Inbound{
  342. Remark: "DE",
  343. Protocol: "vless",
  344. StreamSettings: `{"network":"ws","security":"tls"}`,
  345. ClientStats: []xray.ClientTraffic{{Email: "john@x", Enable: true, Total: 100 * gb, Up: 30 * gb}},
  346. }
  347. client := model.Client{Email: "john@x"}
  348. body := &SubService{remarkTemplate: tmpl, subscriptionBody: true, usageShown: map[string]bool{}}
  349. _ = body.genTemplatedRemark(inbound, client, "", "ws") // first link consumes the usage block
  350. if second := body.genTemplatedRemark(inbound, client, "", "ws"); !strings.Contains(second, "john@x") {
  351. t.Fatalf("repeat body link %q must keep the identity token", second)
  352. }
  353. display := &SubService{remarkTemplate: tmpl, subscriptionBody: false}
  354. if got := display.genTemplatedRemark(inbound, client, "", "ws"); !strings.Contains(got, "john@x") {
  355. t.Fatalf("display remark %q must keep the identity token", got)
  356. }
  357. }
  358. // statsForClient resolves usage from the per-request statsByEmail map when the
  359. // link's own inbound doesn't carry the client's (globally unique) traffic row —
  360. // the multi-inbound case that made {{TRAFFIC_LEFT}} show the full quota (#5443).
  361. func TestStatsForClient_CrossInboundFallback(t *testing.T) {
  362. s := &SubService{
  363. statsByEmail: map[string]xray.ClientTraffic{
  364. "[email protected]": {Email: "[email protected]", Total: 100 * gb, Up: 15 * gb, Down: 5 * gb},
  365. },
  366. }
  367. // Inbound B carries no ClientStats for john (his row is owned by inbound A).
  368. inboundB := &model.Inbound{Remark: "B"}
  369. st := s.statsForClient(inboundB, model.Client{Email: "[email protected]"})
  370. if used := st.Up + st.Down; used != 20*gb {
  371. t.Fatalf("statsForClient used = %d, want %d (cross-inbound fallback)", used, 20*gb)
  372. }
  373. if got := remarkVarValue("TRAFFIC_LEFT", remarkContext{stats: st}); got != "80.00GB" {
  374. t.Fatalf("TRAFFIC_LEFT = %q, want 80.00GB (remaining, not total)", got)
  375. }
  376. }
  377. // Two clients through the same global template get distinct, per-client remarks.
  378. func TestGenHostRemark_PerClient(t *testing.T) {
  379. s := &SubService{remarkTemplate: "{{EMAIL}}", subscriptionBody: true}
  380. inbound := &model.Inbound{}
  381. a := s.genHostRemark(inbound, model.Client{Email: "alice@x"}, "", "")
  382. b := s.genHostRemark(inbound, model.Client{Email: "bob@x"}, "", "")
  383. if a != "alice@x" || b != "bob@x" {
  384. t.Fatalf("per-client expansion failed: a=%q b=%q", a, b)
  385. }
  386. }
  387. func TestStatusEmoji(t *testing.T) {
  388. cases := []struct {
  389. stats xray.ClientTraffic
  390. want string
  391. }{
  392. {xray.ClientTraffic{Enable: true, Total: 10 * gb, Up: gb}, "✅"},
  393. {xray.ClientTraffic{Enable: true, Total: 10 * gb, Up: 10 * gb, Down: 1}, "🚫"},
  394. {xray.ClientTraffic{Enable: false}, "🚫"},
  395. {xray.ClientTraffic{Enable: true, ExpiryTime: 1000}, "⏳"},
  396. }
  397. for _, c := range cases {
  398. if got := statusEmoji(c.stats); got != c.want {
  399. t.Errorf("statusEmoji(%+v) = %q, want %q", c.stats, got, c.want)
  400. }
  401. }
  402. }
  403. func TestUsagePercentage(t *testing.T) {
  404. if got := usagePercentage(xray.ClientTraffic{Total: 100 * gb, Up: 25 * gb, Down: 25 * gb}); got != "50.0%" {
  405. t.Errorf("usagePercentage 50%% = %q", got)
  406. }
  407. if got := usagePercentage(xray.ClientTraffic{Total: 0}); got != "" {
  408. t.Errorf("usagePercentage unlimited = %q, want empty", got)
  409. }
  410. if got := usagePercentage(xray.ClientTraffic{Total: 10 * gb, Up: 10 * gb}); got != "100.0%" {
  411. t.Errorf("usagePercentage 100%% = %q", got)
  412. }
  413. // Over-quota usage clamps to 100%, consistent with TRAFFIC_LEFT.
  414. if got := usagePercentage(xray.ClientTraffic{Total: 10 * gb, Up: 25 * gb}); got != "100.0%" {
  415. t.Errorf("usagePercentage over-quota = %q, want 100.0%%", got)
  416. }
  417. }
  418. func TestTimeLeftLabel(t *testing.T) {
  419. if got := timeLeftLabel(0); got != "∞" {
  420. t.Errorf("timeLeftLabel(0) = %q, want ∞", got)
  421. }
  422. // Delayed-start: negative expiry = duration in ms. 1000ms = 1 second = "0m".
  423. if got := timeLeftLabel(-1000); got != "0m" {
  424. t.Errorf("timeLeftLabel(-1000) = %q, want 0m", got)
  425. }
  426. }
  427. func TestGregorianToJalali(t *testing.T) {
  428. cases := []struct {
  429. gy, gm, gd int
  430. jy, jm, jd int
  431. }{
  432. {2024, 1, 1, 1402, 10, 11},
  433. {2000, 3, 20, 1379, 1, 1},
  434. {1979, 2, 11, 1357, 11, 22},
  435. }
  436. for _, c := range cases {
  437. jy, jm, jd := gregorianToJalali(c.gy, c.gm, c.gd)
  438. if jy != c.jy || jm != c.jm || jd != c.jd {
  439. t.Errorf("gregorianToJalali(%d,%d,%d) = (%d,%d,%d), want (%d,%d,%d)",
  440. c.gy, c.gm, c.gd, jy, jm, jd, c.jy, c.jm, c.jd)
  441. }
  442. }
  443. }
  444. func TestJalaliExpireDateLabel(t *testing.T) {
  445. if got := jalaliExpireDateLabel(0); got != "" {
  446. t.Errorf("jalaliExpireDateLabel(0) = %q, want empty", got)
  447. }
  448. if got := jalaliExpireDateLabel(-1000); got != "" {
  449. t.Errorf("jalaliExpireDateLabel(-1000) = %q, want empty", got)
  450. }
  451. }
  452. func TestExpandNewTokensInTemplate(t *testing.T) {
  453. inbound := &model.Inbound{Remark: "DE", Protocol: "vless"}
  454. client := model.Client{Email: "[email protected]", ID: "abc-123"}
  455. stats := xray.ClientTraffic{Enable: true, Total: 100 * gb, Up: 50 * gb, Down: 0}
  456. ctx := remarkContext{
  457. client: client,
  458. stats: stats,
  459. inbound: inbound,
  460. transport: "ws",
  461. security: "reality",
  462. }
  463. cases := []struct{ tmpl, want string }{
  464. {"{{STATUS_EMOJI}}", "✅"},
  465. {"{{USAGE_PERCENTAGE}}", "50.0%"},
  466. {"{{PROTOCOL}}", "VLESS"},
  467. {"{{TRANSPORT}}", "ws"},
  468. {"{{SECURITY}}", "REALITY"},
  469. {"{{STATUS_EMOJI}} {{INBOUND}}", "✅ DE"},
  470. }
  471. for _, c := range cases {
  472. if got := expandRemarkVars(c.tmpl, ctx); got != c.want {
  473. t.Errorf("expandRemarkVars(%q) = %q, want %q", c.tmpl, got, c.want)
  474. }
  475. }
  476. }
  477. func TestInboundSecurity(t *testing.T) {
  478. cases := []struct{ stream, want string }{
  479. {`{"network":"ws","security":"tls"}`, "tls"},
  480. {`{"network":"tcp","security":"reality"}`, "reality"},
  481. {`{"network":"tcp","security":"none"}`, "none"},
  482. {`{"network":"tcp"}`, ""},
  483. {"", ""},
  484. }
  485. for _, c := range cases {
  486. if got := inboundSecurity(&model.Inbound{StreamSettings: c.stream}); got != c.want {
  487. t.Errorf("inboundSecurity(%q) = %q, want %q", c.stream, got, c.want)
  488. }
  489. }
  490. if got := inboundSecurity(nil); got != "" {
  491. t.Errorf("inboundSecurity(nil) = %q, want empty", got)
  492. }
  493. }
  494. func TestGenTemplatedRemark_SecurityFromStream(t *testing.T) {
  495. s := &SubService{remarkTemplate: "{{INBOUND}} {{SECURITY}}", subscriptionBody: true}
  496. inbound := &model.Inbound{Remark: "DE", StreamSettings: `{"network":"tcp","security":"reality"}`}
  497. if got := s.genTemplatedRemark(inbound, model.Client{Email: "a@x"}, "", "tcp"); got != "DE REALITY" {
  498. t.Fatalf("genTemplatedRemark SECURITY = %q, want %q", got, "DE REALITY")
  499. }
  500. }
  501. func TestTranslateUISingleBrackets(t *testing.T) {
  502. cases := []struct{ in, want string }{
  503. {"{EMAIL}", "{{EMAIL}}"},
  504. {"{DATA_LEFT}", "{{TRAFFIC_LEFT}}"},
  505. {"{DATA_LEFT} of {DATA_LIMIT}", "{{TRAFFIC_LEFT}} of {{TRAFFIC_TOTAL}}"},
  506. {"{STATUS_EMOJI} {INBOUND}", "{{STATUS_EMOJI}} {INBOUND}"},
  507. {"{UNKNOWN_TOKEN}", "{UNKNOWN_TOKEN}"},
  508. {"no braces", "no braces"},
  509. {"{{TRAFFIC_LEFT}}", "{{TRAFFIC_LEFT}}"},
  510. {"{username}", "{username}"},
  511. }
  512. for _, c := range cases {
  513. if got := translateUISingleBrackets(c.in); got != c.want {
  514. t.Errorf("translateUISingleBrackets(%q) = %q, want %q", c.in, got, c.want)
  515. }
  516. }
  517. }
  518. func TestExpandRemarkVars_SingleBracketUI(t *testing.T) {
  519. inbound := &model.Inbound{Remark: "DE", Protocol: "vless"}
  520. stats := xray.ClientTraffic{Enable: true, Total: 100 * gb, Up: 50 * gb, Down: 0}
  521. ctx := remarkContext{
  522. client: model.Client{Email: "[email protected]"},
  523. stats: stats,
  524. inbound: inbound,
  525. transport: "ws",
  526. security: "tls",
  527. }
  528. cases := []struct{ tmpl, want string }{
  529. {"{EMAIL}", "[email protected]"},
  530. {"{DATA_LEFT}", "50.00GB"},
  531. {"{DATA_USAGE}", "50.00GB"},
  532. {"{DATA_LIMIT}", "100.00GB"},
  533. {"{STATUS_EMOJI}", "✅"},
  534. {"{USAGE_PERCENTAGE}", "50.0%"},
  535. {"{PROTOCOL}", "VLESS"},
  536. {"{TRANSPORT}", "ws"},
  537. {"{SECURITY}", "TLS"},
  538. }
  539. for _, c := range cases {
  540. if got := expandRemarkVars(c.tmpl, ctx); got != c.want {
  541. t.Errorf("expandRemarkVars(%q) = %q, want %q", c.tmpl, got, c.want)
  542. }
  543. }
  544. }
  545. func TestUsageOnFirstLinkOnly_SingleBracket(t *testing.T) {
  546. s := &SubService{
  547. remarkTemplate: "{STATUS_EMOJI} {{INBOUND}}|📊{{TRAFFIC_LEFT}}",
  548. subscriptionBody: true,
  549. usageShown: map[string]bool{},
  550. }
  551. inbound := &model.Inbound{
  552. Remark: "DE",
  553. ClientStats: []xray.ClientTraffic{{
  554. Email: "alice@x",
  555. Enable: true,
  556. Total: 100 * gb,
  557. Up: 20 * gb,
  558. Down: 10 * gb,
  559. }},
  560. }
  561. client := model.Client{Email: "alice@x"}
  562. first := s.genTemplatedRemark(inbound, client, "", "ws")
  563. s.usageShown["alice@x"] = true
  564. second := s.genTemplatedRemark(inbound, client, "", "ws")
  565. if !strings.Contains(first, "📊") {
  566. t.Fatalf("first link should carry usage: %q", first)
  567. }
  568. if strings.Contains(second, "📊") {
  569. t.Fatalf("second link must not carry usage: %q", second)
  570. }
  571. }