remark_vars_test.go 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654
  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 TestExpandRemarkVars_DropEmptySegments(t *testing.T) {
  120. inbound := &model.Inbound{Remark: "host"}
  121. noComment := expandCtx(model.Client{}, xray.ClientTraffic{Enable: true}, inbound)
  122. if got := expandRemarkVars("{{INBOUND}}|{{COMMENT}}", noComment); got != "host" {
  123. t.Errorf("empty comment segment = %q, want %q (no trailing pipe)", got, "host")
  124. }
  125. if got := expandRemarkVars("{{INBOUND}}|📅{{EXPIRE_DATE}}", noComment); got != "host" {
  126. t.Errorf("decorated empty segment = %q, want %q", got, "host")
  127. }
  128. }
  129. func TestClientStatus(t *testing.T) {
  130. cases := []struct {
  131. name string
  132. st xray.ClientTraffic
  133. want string
  134. }{
  135. {"disabled", xray.ClientTraffic{Enable: false}, "disabled"},
  136. {"active", xray.ClientTraffic{Enable: true}, "active"},
  137. {"expired", xray.ClientTraffic{Enable: true, ExpiryTime: 1000}, "expired"}, // 1s past epoch
  138. {"depleted", xray.ClientTraffic{Enable: true, Total: gb, Up: gb}, "depleted"},
  139. }
  140. for _, c := range cases {
  141. if got := clientStatus(c.st); got != c.want {
  142. t.Errorf("%s: clientStatus = %q, want %q", c.name, got, c.want)
  143. }
  144. }
  145. }
  146. // hostRemarkService builds a SubService + inbound + client/stats for remark tests.
  147. func hostRemarkService(template string) (*SubService, *model.Inbound, model.Client) {
  148. s := &SubService{remarkTemplate: template, subscriptionBody: true}
  149. inbound := &model.Inbound{
  150. Remark: "DE",
  151. ClientStats: []xray.ClientTraffic{{
  152. Email: "[email protected]",
  153. Enable: true,
  154. Total: 100 * gb,
  155. Up: 15 * gb,
  156. Down: 5 * gb,
  157. ExpiryTime: -864_000_000, // delayed-start: deterministic 10 days
  158. }},
  159. }
  160. client := model.Client{Email: "[email protected]"}
  161. return s, inbound, client
  162. }
  163. // With no template configured, genHostRemark falls back to the inbound remark,
  164. // host and email joined by "-".
  165. func TestGenHostRemark_NoTemplate_Fallback(t *testing.T) {
  166. s, inbound, client := hostRemarkService("")
  167. if got := s.genHostRemark(inbound, client, "Relay", ""); got != "[email protected]" {
  168. t.Fatalf("genHostRemark = %q, want %q", got, "[email protected]")
  169. }
  170. if got := s.genHostRemark(inbound, client, "", ""); got != "[email protected]" {
  171. t.Fatalf("genHostRemark (no host remark) = %q, want %q", got, "[email protected]")
  172. }
  173. }
  174. // In the body the template applies: {{INBOUND}} is always the inbound's remark
  175. // and {{HOST}} the host's own remark, so the two can be shown side by side.
  176. func TestGenHostRemark_GlobalTemplate(t *testing.T) {
  177. // {{INBOUND}} resolves to the inbound remark regardless of the host remark.
  178. s, inbound, client := hostRemarkService("{{INBOUND}} | {{TRAFFIC_LEFT}} | {{DAYS_LEFT}}d")
  179. if got := s.genHostRemark(inbound, client, "CDN", ""); got != "DE | 80.00GB | 10d" {
  180. t.Fatalf("global template ({{INBOUND}} = inbound) = %q", got)
  181. }
  182. // {{INBOUND}} and {{HOST}} side by side show both, distinctly (#5443).
  183. s2, inbound2, client2 := hostRemarkService("{{INBOUND}}|{{HOST}}|{{TRAFFIC_LEFT}}")
  184. if got := s2.genHostRemark(inbound2, client2, "CDN", ""); got != "DE|CDN|80.00GB" {
  185. t.Fatalf("global template (inbound + host) = %q, want %q", got, "DE|CDN|80.00GB")
  186. }
  187. // {{HOST}} is the host's own remark even when the inbound has one of its own.
  188. s3, inbound3, client3 := hostRemarkService("{{HOST}}")
  189. if got := s3.genHostRemark(inbound3, client3, "CDN", ""); got != "CDN" {
  190. t.Fatalf("{{HOST}} token = %q, want CDN", got)
  191. }
  192. }
  193. // A global template also drives non-host links via genRemark; {{HOST}} = the
  194. // legacy externalProxy remark passed as extra.
  195. func TestGenRemark_GlobalTemplate(t *testing.T) {
  196. s, inbound, _ := hostRemarkService("{{EMAIL}} | {{TRAFFIC_LEFT}}")
  197. got := s.genRemark(inbound, "[email protected]", "", "")
  198. if got != "[email protected] | 80.00GB" {
  199. t.Fatalf("global template (non-host) = %q", got)
  200. }
  201. }
  202. func TestGenRemark_NoTemplate_AppendsEmail(t *testing.T) {
  203. s, inbound, _ := hostRemarkService("")
  204. got := s.genRemark(inbound, "[email protected]", "Relay", "")
  205. if got != "[email protected]" {
  206. t.Fatalf("genRemark = %q, want %q", got, "[email protected]")
  207. }
  208. }
  209. // The per-client info part of the template renders only on a client's first
  210. // link of the request; later links show the name-only template.
  211. func TestUsageOnFirstLinkOnly(t *testing.T) {
  212. s, inbound, client := hostRemarkService("{{INBOUND}}|📊{{TRAFFIC_LEFT}}|⏳{{DAYS_LEFT}}D")
  213. first := s.genHostRemark(inbound, client, "", "")
  214. second := s.genHostRemark(inbound, client, "", "")
  215. if !strings.Contains(first, "📊") || !strings.Contains(first, "80.00GB") {
  216. t.Fatalf("first link should carry usage: %q", first)
  217. }
  218. if strings.ContainsAny(second, "📊⏳") {
  219. t.Fatalf("second link must not carry usage: %q", second)
  220. }
  221. if second != "DE" {
  222. t.Fatalf("second link = %q, want name-only %q", second, "DE")
  223. }
  224. }
  225. func TestRemarkInDisplayContext(t *testing.T) {
  226. s, inbound, client := hostRemarkService("{{INBOUND}}-{{EMAIL}}|📊{{TRAFFIC_LEFT}}|⏳{{DAYS_LEFT}}D")
  227. s.subscriptionBody = false
  228. const want = "[email protected]"
  229. if got := s.genHostRemark(inbound, client, "CDN", ""); got != want {
  230. t.Fatalf("display host link = %q, want %q", got, want)
  231. }
  232. if got := s.genHostRemark(inbound, client, "", ""); got != want {
  233. t.Fatalf("display host link (no host) = %q, want %q", got, want)
  234. }
  235. if got := s.genRemark(inbound, client.Email, "", ""); got != want {
  236. t.Fatalf("display genRemark = %q, want %q", got, want)
  237. }
  238. s2, inbound2, client2 := hostRemarkService("{{INBOUND}}-{{HOST}}|📊{{TRAFFIC_LEFT}}")
  239. s2.subscriptionBody = false
  240. if got := s2.genHostRemark(inbound2, client2, "CDN", ""); got != "DE-CDN" {
  241. t.Fatalf("display host link with HOST token = %q, want %q", got, "DE-CDN")
  242. }
  243. }
  244. func TestFilterRemarkTemplate_BodyRepeat(t *testing.T) {
  245. cases := map[string]string{
  246. "{{INBOUND}}|📊{{TRAFFIC_LEFT}}|{{PROTOCOL}}-{{TRANSPORT}}-{{SECURITY}}": "{{INBOUND}}|{{PROTOCOL}}-{{TRANSPORT}}-{{SECURITY}}",
  247. "{{INBOUND}}|📊{{TRAFFIC_LEFT}}|⏳{{DAYS_LEFT}}D": "{{INBOUND}}",
  248. "{{INBOUND}} {{PROTOCOL}}|📊{{TRAFFIC_LEFT}}": "{{INBOUND}} {{PROTOCOL}}",
  249. "{{INBOUND}}-{{EMAIL}}": "{{INBOUND}}-{{EMAIL}}",
  250. "{{TRAFFIC_LEFT}}|{{SECURITY}}": "{{SECURITY}}",
  251. "{{INBOUND}}|📊{{TRAFFIC_LEFT}} {{PROTOCOL}}": "{{INBOUND}}|{{PROTOCOL}}",
  252. "{{INBOUND}}|📊{{TRAFFIC_LEFT}}|{{EMAIL}}": "{{INBOUND}}|{{EMAIL}}",
  253. "{{INBOUND}}|📊{{TRAFFIC_LEFT}}|⏳{{DAYS_LEFT}}D{{PROTOCOL}}{{TRANSPORT}}{{SECURITY}}": "{{INBOUND}}|{{PROTOCOL}}{{TRANSPORT}}{{SECURITY}}",
  254. "{{EMAIL}} {{TRAFFIC_USED}}5h": "{{EMAIL}}",
  255. "{{PROTOCOL}} {{TRAFFIC_LEFT}}GB": "{{PROTOCOL}}",
  256. "{{EMAIL}}-{{TRAFFIC_LEFT}}D-{{HOST}}": "{{EMAIL}} {{HOST}}",
  257. "{{EMAIL}} 📊{{TRAFFIC_LEFT}} {{PROTOCOL}}": "{{EMAIL}} {{PROTOCOL}}",
  258. }
  259. for tmpl, want := range cases {
  260. if got := filterRemarkTemplate(tmpl, usageInfoTokens); got != want {
  261. t.Errorf("filterRemarkTemplate(%q, usage) = %q, want %q", tmpl, got, want)
  262. }
  263. }
  264. }
  265. func TestFilterRemarkTemplate_Display(t *testing.T) {
  266. cases := map[string]string{
  267. "{{INBOUND}}-{{EMAIL}}|📊{{TRAFFIC_LEFT}}|{{PROTOCOL}}": "{{INBOUND}}-{{EMAIL}}",
  268. "{{INBOUND}} {{PROTOCOL}}": "{{INBOUND}}",
  269. "{{EMAIL}} {{INBOUND}} ⏳{{DAYS_LEFT}}": "{{EMAIL}} {{INBOUND}}",
  270. "{{INBOUND}} | {{STATUS}}": "{{INBOUND}}",
  271. "{{INBOUND}}-{{EMAIL}}": "{{INBOUND}}-{{EMAIL}}",
  272. "{{TRAFFIC_LEFT}}": "",
  273. "{{INBOUND}}|📊{{TRAFFIC_LEFT}}|{{HOST}}": "{{INBOUND}}|{{HOST}}",
  274. "{{EMAIL}} ⏳{{DAYS_LEFT}}D {{HOST}}": "{{EMAIL}} {{HOST}}",
  275. "{{INBOUND}} {{TRAFFIC_LEFT}} {{EMAIL}}": "{{INBOUND}} {{EMAIL}}",
  276. }
  277. for tmpl, want := range cases {
  278. if got := filterRemarkTemplate(tmpl, displayRemoveTokens); got != want {
  279. t.Errorf("filterRemarkTemplate(%q, display) = %q, want %q", tmpl, got, want)
  280. }
  281. }
  282. }
  283. func TestConnectionTokensOnEveryBodyLink(t *testing.T) {
  284. s := &SubService{
  285. remarkTemplate: "{{INBOUND}}|📊{{TRAFFIC_LEFT}}|{{PROTOCOL}} {{TRANSPORT}} {{SECURITY}}",
  286. subscriptionBody: true,
  287. usageShown: map[string]bool{},
  288. }
  289. inbound := &model.Inbound{
  290. Remark: "DE",
  291. Protocol: "vless",
  292. StreamSettings: `{"network":"ws","security":"tls"}`,
  293. ClientStats: []xray.ClientTraffic{{Email: "john@x", Enable: true, Total: 100 * gb, Up: 30 * gb}},
  294. }
  295. client := model.Client{Email: "john@x"}
  296. first := s.genTemplatedRemark(inbound, client, "", "ws")
  297. second := s.genTemplatedRemark(inbound, client, "", "ws")
  298. for _, want := range []string{"VLESS", "ws", "TLS"} {
  299. if !strings.Contains(first, want) {
  300. t.Fatalf("first body link %q missing %q", first, want)
  301. }
  302. if !strings.Contains(second, want) {
  303. t.Fatalf("repeat body link %q missing connection token %q", second, want)
  304. }
  305. }
  306. if strings.ContainsAny(second, "📊") || strings.Contains(second, "GB") {
  307. t.Fatalf("repeat body link must drop the usage block: %q", second)
  308. }
  309. }
  310. func TestConnectionTokensMixedIntoUsageSegment(t *testing.T) {
  311. s := &SubService{
  312. remarkTemplate: "{{INBOUND}}-{{EMAIL}}|📊{{TRAFFIC_LEFT}}|⏳{{DAYS_LEFT}}D {{PROTOCOL}} {{TRANSPORT}} {{SECURITY}}",
  313. subscriptionBody: true,
  314. usageShown: map[string]bool{},
  315. }
  316. inbound := &model.Inbound{
  317. Remark: "DE",
  318. Protocol: "vless",
  319. StreamSettings: `{"network":"grpc","security":"reality"}`,
  320. ClientStats: []xray.ClientTraffic{{Email: "john@x", Enable: true, Total: 100 * gb, Up: 30 * gb}},
  321. }
  322. client := model.Client{Email: "john@x"}
  323. _ = s.genTemplatedRemark(inbound, client, "", "grpc")
  324. second := s.genTemplatedRemark(inbound, client, "", "grpc")
  325. for _, want := range []string{"VLESS", "grpc", "REALITY"} {
  326. if !strings.Contains(second, want) {
  327. t.Fatalf("repeat body link %q missing connection token %q", second, want)
  328. }
  329. }
  330. if strings.Contains(second, "GB") || strings.ContainsRune(second, '⏳') {
  331. t.Fatalf("repeat body link must drop the usage block: %q", second)
  332. }
  333. }
  334. func TestConnectionTokensDisplayContextUnchanged(t *testing.T) {
  335. s := &SubService{
  336. remarkTemplate: "{{INBOUND}}|📊{{TRAFFIC_LEFT}}|{{PROTOCOL}}",
  337. subscriptionBody: false,
  338. }
  339. inbound := &model.Inbound{
  340. Remark: "DE",
  341. Protocol: "vless",
  342. StreamSettings: `{"network":"ws","security":"tls"}`,
  343. ClientStats: []xray.ClientTraffic{{Email: "john@x", Enable: true, Total: 100 * gb, Up: 30 * gb}},
  344. }
  345. if got := s.genTemplatedRemark(inbound, model.Client{Email: "john@x"}, "", "ws"); got != "DE" {
  346. t.Fatalf("display remark = %q, want DE (connection after usage stripped outside the body)", got)
  347. }
  348. }
  349. func TestIdentityTokenBodyVsDisplay(t *testing.T) {
  350. const tmpl = "{{INBOUND}}|📊{{TRAFFIC_LEFT}}|{{EMAIL}}"
  351. inbound := &model.Inbound{
  352. Remark: "DE",
  353. Protocol: "vless",
  354. StreamSettings: `{"network":"ws","security":"tls"}`,
  355. ClientStats: []xray.ClientTraffic{{Email: "john@x", Enable: true, Total: 100 * gb, Up: 30 * gb}},
  356. }
  357. client := model.Client{Email: "john@x"}
  358. body := &SubService{remarkTemplate: tmpl, subscriptionBody: true, usageShown: map[string]bool{}}
  359. _ = body.genTemplatedRemark(inbound, client, "", "ws") // first link consumes the usage block
  360. if second := body.genTemplatedRemark(inbound, client, "", "ws"); strings.Contains(second, "john@x") {
  361. t.Fatalf("repeat body link %q must drop the identity token", second)
  362. }
  363. display := &SubService{remarkTemplate: tmpl, subscriptionBody: false}
  364. if got := display.genTemplatedRemark(inbound, client, "", "ws"); !strings.Contains(got, "john@x") {
  365. t.Fatalf("display remark %q must keep the identity token", got)
  366. }
  367. }
  368. // statsForClient resolves usage from the per-request statsByEmail map when the
  369. // link's own inbound doesn't carry the client's (globally unique) traffic row —
  370. // the multi-inbound case that made {{TRAFFIC_LEFT}} show the full quota (#5443).
  371. func TestStatsForClient_CrossInboundFallback(t *testing.T) {
  372. s := &SubService{
  373. statsByEmail: map[string]xray.ClientTraffic{
  374. "[email protected]": {Email: "[email protected]", Total: 100 * gb, Up: 15 * gb, Down: 5 * gb},
  375. },
  376. }
  377. // Inbound B carries no ClientStats for john (his row is owned by inbound A).
  378. inboundB := &model.Inbound{Remark: "B"}
  379. st := s.statsForClient(inboundB, model.Client{Email: "[email protected]"})
  380. if used := st.Up + st.Down; used != 20*gb {
  381. t.Fatalf("statsForClient used = %d, want %d (cross-inbound fallback)", used, 20*gb)
  382. }
  383. if got := remarkVarValue("TRAFFIC_LEFT", remarkContext{stats: st}); got != "80.00GB" {
  384. t.Fatalf("TRAFFIC_LEFT = %q, want 80.00GB (remaining, not total)", got)
  385. }
  386. }
  387. // Two clients through the same global template get distinct, per-client remarks.
  388. func TestGenHostRemark_PerClient(t *testing.T) {
  389. s := &SubService{remarkTemplate: "{{EMAIL}}", subscriptionBody: true}
  390. inbound := &model.Inbound{}
  391. a := s.genHostRemark(inbound, model.Client{Email: "alice@x"}, "", "")
  392. b := s.genHostRemark(inbound, model.Client{Email: "bob@x"}, "", "")
  393. if a != "alice@x" || b != "bob@x" {
  394. t.Fatalf("per-client expansion failed: a=%q b=%q", a, b)
  395. }
  396. }
  397. func TestStatusEmoji(t *testing.T) {
  398. cases := []struct {
  399. stats xray.ClientTraffic
  400. want string
  401. }{
  402. {xray.ClientTraffic{Enable: true, Total: 10 * gb, Up: gb}, "✅"},
  403. {xray.ClientTraffic{Enable: true, Total: 10 * gb, Up: 10 * gb, Down: 1}, "🚫"},
  404. {xray.ClientTraffic{Enable: false}, "🚫"},
  405. {xray.ClientTraffic{Enable: true, ExpiryTime: 1000}, "⏳"},
  406. }
  407. for _, c := range cases {
  408. if got := statusEmoji(c.stats); got != c.want {
  409. t.Errorf("statusEmoji(%+v) = %q, want %q", c.stats, got, c.want)
  410. }
  411. }
  412. }
  413. func TestUsagePercentage(t *testing.T) {
  414. if got := usagePercentage(xray.ClientTraffic{Total: 100 * gb, Up: 25 * gb, Down: 25 * gb}); got != "50.0%" {
  415. t.Errorf("usagePercentage 50%% = %q", got)
  416. }
  417. if got := usagePercentage(xray.ClientTraffic{Total: 0}); got != "" {
  418. t.Errorf("usagePercentage unlimited = %q, want empty", got)
  419. }
  420. if got := usagePercentage(xray.ClientTraffic{Total: 10 * gb, Up: 10 * gb}); got != "100.0%" {
  421. t.Errorf("usagePercentage 100%% = %q", got)
  422. }
  423. // Over-quota usage clamps to 100%, consistent with TRAFFIC_LEFT.
  424. if got := usagePercentage(xray.ClientTraffic{Total: 10 * gb, Up: 25 * gb}); got != "100.0%" {
  425. t.Errorf("usagePercentage over-quota = %q, want 100.0%%", got)
  426. }
  427. }
  428. func TestTimeLeftLabel(t *testing.T) {
  429. if got := timeLeftLabel(0); got != "∞" {
  430. t.Errorf("timeLeftLabel(0) = %q, want ∞", got)
  431. }
  432. // Delayed-start: negative expiry = duration in ms. 1000ms = 1 second = "0m".
  433. if got := timeLeftLabel(-1000); got != "0m" {
  434. t.Errorf("timeLeftLabel(-1000) = %q, want 0m", got)
  435. }
  436. }
  437. func TestGregorianToJalali(t *testing.T) {
  438. cases := []struct {
  439. gy, gm, gd int
  440. jy, jm, jd int
  441. }{
  442. {2024, 1, 1, 1402, 10, 11},
  443. {2000, 3, 20, 1379, 1, 1},
  444. {1979, 2, 11, 1357, 11, 22},
  445. }
  446. for _, c := range cases {
  447. jy, jm, jd := gregorianToJalali(c.gy, c.gm, c.gd)
  448. if jy != c.jy || jm != c.jm || jd != c.jd {
  449. t.Errorf("gregorianToJalali(%d,%d,%d) = (%d,%d,%d), want (%d,%d,%d)",
  450. c.gy, c.gm, c.gd, jy, jm, jd, c.jy, c.jm, c.jd)
  451. }
  452. }
  453. }
  454. func TestJalaliExpireDateLabel(t *testing.T) {
  455. if got := jalaliExpireDateLabel(0); got != "" {
  456. t.Errorf("jalaliExpireDateLabel(0) = %q, want empty", got)
  457. }
  458. if got := jalaliExpireDateLabel(-1000); got != "" {
  459. t.Errorf("jalaliExpireDateLabel(-1000) = %q, want empty", got)
  460. }
  461. }
  462. func TestExpandNewTokensInTemplate(t *testing.T) {
  463. inbound := &model.Inbound{Remark: "DE", Protocol: "vless"}
  464. client := model.Client{Email: "[email protected]", ID: "abc-123"}
  465. stats := xray.ClientTraffic{Enable: true, Total: 100 * gb, Up: 50 * gb, Down: 0}
  466. ctx := remarkContext{
  467. client: client,
  468. stats: stats,
  469. inbound: inbound,
  470. transport: "ws",
  471. security: "reality",
  472. }
  473. cases := []struct{ tmpl, want string }{
  474. {"{{STATUS_EMOJI}}", "✅"},
  475. {"{{USAGE_PERCENTAGE}}", "50.0%"},
  476. {"{{PROTOCOL}}", "VLESS"},
  477. {"{{TRANSPORT}}", "ws"},
  478. {"{{SECURITY}}", "REALITY"},
  479. {"{{STATUS_EMOJI}} {{INBOUND}}", "✅ DE"},
  480. }
  481. for _, c := range cases {
  482. if got := expandRemarkVars(c.tmpl, ctx); got != c.want {
  483. t.Errorf("expandRemarkVars(%q) = %q, want %q", c.tmpl, got, c.want)
  484. }
  485. }
  486. }
  487. func TestInboundSecurity(t *testing.T) {
  488. cases := []struct{ stream, want string }{
  489. {`{"network":"ws","security":"tls"}`, "tls"},
  490. {`{"network":"tcp","security":"reality"}`, "reality"},
  491. {`{"network":"tcp","security":"none"}`, "none"},
  492. {`{"network":"tcp"}`, ""},
  493. {"", ""},
  494. }
  495. for _, c := range cases {
  496. if got := inboundSecurity(&model.Inbound{StreamSettings: c.stream}); got != c.want {
  497. t.Errorf("inboundSecurity(%q) = %q, want %q", c.stream, got, c.want)
  498. }
  499. }
  500. if got := inboundSecurity(nil); got != "" {
  501. t.Errorf("inboundSecurity(nil) = %q, want empty", got)
  502. }
  503. }
  504. func TestGenTemplatedRemark_SecurityFromStream(t *testing.T) {
  505. s := &SubService{remarkTemplate: "{{INBOUND}} {{SECURITY}}", subscriptionBody: true}
  506. inbound := &model.Inbound{Remark: "DE", StreamSettings: `{"network":"tcp","security":"reality"}`}
  507. if got := s.genTemplatedRemark(inbound, model.Client{Email: "a@x"}, "", "tcp"); got != "DE REALITY" {
  508. t.Fatalf("genTemplatedRemark SECURITY = %q, want %q", got, "DE REALITY")
  509. }
  510. }
  511. func TestTranslateUISingleBrackets(t *testing.T) {
  512. cases := []struct{ in, want string }{
  513. {"{EMAIL}", "{{EMAIL}}"},
  514. {"{DATA_LEFT}", "{{TRAFFIC_LEFT}}"},
  515. {"{DATA_LEFT} of {DATA_LIMIT}", "{{TRAFFIC_LEFT}} of {{TRAFFIC_TOTAL}}"},
  516. {"{STATUS_EMOJI} {INBOUND}", "{{STATUS_EMOJI}} {INBOUND}"},
  517. {"{UNKNOWN_TOKEN}", "{UNKNOWN_TOKEN}"},
  518. {"no braces", "no braces"},
  519. {"{{TRAFFIC_LEFT}}", "{{TRAFFIC_LEFT}}"},
  520. {"{username}", "{username}"},
  521. }
  522. for _, c := range cases {
  523. if got := translateUISingleBrackets(c.in); got != c.want {
  524. t.Errorf("translateUISingleBrackets(%q) = %q, want %q", c.in, got, c.want)
  525. }
  526. }
  527. }
  528. func TestExpandRemarkVars_SingleBracketUI(t *testing.T) {
  529. inbound := &model.Inbound{Remark: "DE", Protocol: "vless"}
  530. stats := xray.ClientTraffic{Enable: true, Total: 100 * gb, Up: 50 * gb, Down: 0}
  531. ctx := remarkContext{
  532. client: model.Client{Email: "[email protected]"},
  533. stats: stats,
  534. inbound: inbound,
  535. transport: "ws",
  536. security: "tls",
  537. }
  538. cases := []struct{ tmpl, want string }{
  539. {"{EMAIL}", "[email protected]"},
  540. {"{DATA_LEFT}", "50.00GB"},
  541. {"{DATA_USAGE}", "50.00GB"},
  542. {"{DATA_LIMIT}", "100.00GB"},
  543. {"{STATUS_EMOJI}", "✅"},
  544. {"{USAGE_PERCENTAGE}", "50.0%"},
  545. {"{PROTOCOL}", "VLESS"},
  546. {"{TRANSPORT}", "ws"},
  547. {"{SECURITY}", "TLS"},
  548. }
  549. for _, c := range cases {
  550. if got := expandRemarkVars(c.tmpl, ctx); got != c.want {
  551. t.Errorf("expandRemarkVars(%q) = %q, want %q", c.tmpl, got, c.want)
  552. }
  553. }
  554. }
  555. func TestUsageOnFirstLinkOnly_SingleBracket(t *testing.T) {
  556. s := &SubService{
  557. remarkTemplate: "{STATUS_EMOJI} {{INBOUND}}|📊{{TRAFFIC_LEFT}}",
  558. subscriptionBody: true,
  559. usageShown: map[string]bool{},
  560. }
  561. inbound := &model.Inbound{
  562. Remark: "DE",
  563. ClientStats: []xray.ClientTraffic{{
  564. Email: "alice@x",
  565. Enable: true,
  566. Total: 100 * gb,
  567. Up: 20 * gb,
  568. Down: 10 * gb,
  569. }},
  570. }
  571. client := model.Client{Email: "alice@x"}
  572. first := s.genTemplatedRemark(inbound, client, "", "ws")
  573. s.usageShown["alice@x"] = true
  574. second := s.genTemplatedRemark(inbound, client, "", "ws")
  575. if !strings.Contains(first, "📊") {
  576. t.Fatalf("first link should carry usage: %q", first)
  577. }
  578. if strings.Contains(second, "📊") {
  579. t.Fatalf("second link must not carry usage: %q", second)
  580. }
  581. }
  582. func TestEmailOnFirstLinkOnly(t *testing.T) {
  583. s := &SubService{
  584. remarkTemplate: "{{INBOUND}} {{EMAIL}}|📊{{TRAFFIC_LEFT}}",
  585. subscriptionBody: true,
  586. usageShown: map[string]bool{},
  587. }
  588. inbound := &model.Inbound{
  589. Remark: "DE",
  590. ClientStats: []xray.ClientTraffic{{
  591. Email: "alice@x",
  592. Enable: true,
  593. Total: 100 * gb,
  594. }},
  595. }
  596. client := model.Client{Email: "alice@x"}
  597. first := s.genTemplatedRemark(inbound, client, "", "ws")
  598. s.usageShown["alice@x"] = true
  599. second := s.genTemplatedRemark(inbound, client, "", "ws")
  600. if !strings.Contains(first, "alice@x") {
  601. t.Fatalf("first link should carry email: %q", first)
  602. }
  603. if strings.Contains(second, "alice@x") {
  604. t.Fatalf("second link must not carry email: %q", second)
  605. }
  606. if !strings.Contains(second, "DE") {
  607. t.Fatalf("second link should still carry the inbound name: %q", second)
  608. }
  609. }