mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-06-28 00:24:19 +00:00
41645255f1
* refactor(service): split client.go into focused files
client.go had grown to 4455 lines mixing ~10 responsibilities. Split it
verbatim into cohesive same-package files (no behavior change):
client.go foundation: ClientService, ClientWithAttachments,
ClientCreatePayload, ErrClientNotInInbound, sqlInChunk
client_locks.go inbound mutation locks, delete tombstones, compactOrphans
client_lookup.go read-only lookups (GetByID, List, EffectiveFlow, ...)
client_link.go inbound association sync (SyncInbound, DetachInbound, ...)
client_crud.go single-client CRUD + validation + protocol defaults
client_inbound_apply.go low-level inbound-settings mutators + by-email setters
client_bulk.go bulk attach/detach/adjust/delete/create + DelDepleted
client_traffic.go traffic-reset paths
client_groups.go client group management
client_paging.go paged listing, filtering, sorting, summary
Every declaration moved unchanged (verified: identical func/type/const/var
signature set before vs after). Imports redistributed per file via goimports.
go build ./..., go vet, and go test ./web/service/... all pass.
* refactor(service): split inbound.go into focused files
inbound.go was 4100 lines. Split it verbatim into cohesive same-package
files (no behavior change):
inbound.go core inbound CRUD + InboundService (keeps pkg doc)
inbound_protocol.go protocol / stream capability helpers
inbound_node.go node/runtime/remote coordination + online tracking
inbound_traffic.go traffic accounting, reset, client stats
inbound_client_ips.go per-client IP tracking
inbound_clients.go client lookups within inbounds + copy-clients
inbound_disable.go auto-disable invalid inbounds/clients
inbound_migration.go DB migrations
inbound_sublink.go subscription link providers
inbound_util.go generic slice/string helpers
Identical func/type/const/var signature set before vs after; package doc
comment preserved on inbound.go. Imports redistributed via goimports.
Build, vet, and go test ./web/service/... all pass.
* refactor(service): split tgbot.go into focused files
tgbot.go was 3738 lines dominated by a 1246-line answerCallback. Split it
verbatim into cohesive same-package files (no behavior change):
tgbot.go lifecycle, bot setup, caches, small utils
tgbot_router.go incoming update / command / callback dispatch
tgbot_send.go outbound messaging primitives
tgbot_client.go client views, actions, subscription links
tgbot_inbound.go inbound listing / pickers
tgbot_report.go server usage, exhausted, online, backups, notifications
Identical func/type/const/var signature set before vs after. Imports
redistributed via goimports. Build, vet, and go test ./web/service/... pass.
* refactor(client): dedupe single-field by-email setters
ResetClientIpLimitByEmail, ResetClientExpiryTimeByEmail, and
ResetClientTrafficLimitByEmail shared an identical ~50-line body that
resolves the inbound by email, confirms the client exists, rewrites a
single-client settings payload, and delegates to UpdateInboundClient.
Extract that into applyClientFieldByEmail(inboundSvc, email, mutate) and
reduce each setter to a 3-line wrapper. Behavior is unchanged: same checks
and error strings, same single-client payload contract, same totalGB guard.
SetClientTelegramUserID (resolves by traffic id, different error text) and
ToggleClientEnableByEmail/SetClientEnableByEmail (different return shape and
a pre-read of the old state) intentionally keep their own bodies.
* refactor(service): extract panel/ subpackage
Move the panel-administration leaf services out of the flat service
package into web/service/panel/ (package panel):
user.go UserService (auth / 2FA / LDAP)
panel.go PanelService (restart / self-update) + version helpers
panel_other.go non-unix RestartPanel
panel_unix.go unix RestartPanel
api_token.go ApiTokenService
websocket.go WebSocketService
panel_test.go version/shellQuote unit tests
These are leaves: they depend on core (SettingService, Release) but no
core file references them, so the extraction creates no import cycle.
Core references are now qualified (service.SettingService, service.Release);
callers in main.go, web/web.go, and web/controller/* updated to panel.*.
Build, vet, and go test ./web/... pass.
* refactor(service): extract integration/ subpackage
Move the external-provider integration leaves into web/service/integration/
(package integration):
warp.go WarpService (Cloudflare WARP)
nord.go NordService (NordVPN)
custom_geo.go CustomGeoService (custom geo asset management)
*_test.go custom_geo / panel-proxy tests
These depend on core (SettingService, ServerService, XraySettingService) but
no core file references them. xray_setting.go stays in core because it calls
the unexported SettingService.saveSetting. The shared isBlockedIP SSRF helper
(used by core url_safety.go and by custom_geo) now has a small copy in each
package rather than being exported. Core references qualified; callers in
web/web.go, web/job/*, and web/controller/* updated to integration.*.
Build, vet, and go test ./web/... pass.
* refactor(service): extract tgbot/ subpackage
Move the Telegram bot (6 files + test) into web/service/tgbot/ (package
tgbot). It is a leaf: it embeds five core services (Inbound/Client/Setting/
Server/Xray) and the core never references it, so no import cycle.
To support the package boundary without changing behavior:
- core exposes XrayProcess() *xray.Process so tgbot keeps calling the
exact same running-process methods it used via the package-level `p`;
- three core methods tgbot calls are exported: ClientService.checkIs-
EnabledByEmail -> CheckIsEnabledByEmail, InboundService.getAllEmails ->
GetAllEmails (callers updated in-package);
- tgbot's embedded-field types and the few core type refs (Status,
ClientCreatePayload, SanitizePublicHTTPURL) are now service-qualified.
Callers in main.go, web/web.go, web/job/*, and web/controller/* updated to
tgbot.*. Build, vet, and go test ./web/... pass.
* refactor(service): extract outbound/ subpackage
OutboundService (outbound.go) imports only neutral packages (config,
database, model, xray) and its production code is referenced by no core or
sibling service file — only by web/controller/xray_setting.go and
web/job/xray_traffic_job.go. Move it to web/service/outbound/ (package
outbound); no core qualification needed inside. Callers updated to outbound.*.
The one coupling was a tiny pure test helper, outboundsContainTag, used by
both outbound.go and the core outbound_subscription_test.go; it now has a
small copy in that test file rather than being shared across the boundary.
Build, vet, and go test ./web/... pass.
* refactor(util): move wireguard into its own subpackage
util/wireguard.go was the lone file of the root `util` package (24 lines,
one exported func GenerateWireguardKeypair), while every other util concern
lives in a focused subpackage (util/common, util/crypto, util/netsafe, ...).
Move it to util/wireguard/ (package wireguard) for consistency; its only
importer, web/service/integration/warp.go, is updated. The root `util`
package no longer exists.
* refactor(sub): drop redundant sub prefix from filenames
Inside package sub the subXxx.go prefix just repeats the package name
(like client_*.go did inside service). Rename for consistency; content and
type names are unchanged:
subController.go -> controller.go
subService.go -> service.go
subClashService.go -> clash_service.go
subJsonService.go -> json_service.go
(+ matching _test.go files)
* refactor(controller): rename xui.go -> spa.go
XUIController serves the panel's single-page-app shell; spa.go names that
role plainly (the other controller files are domain-named). File rename only
— the type stays XUIController. api_docs_test.go keys route base paths by
filename, so its "xui.go" case is updated to "spa.go".
* refactor: move backend packages under internal/
Adopt the idiomatic Go application layout: the backend packages now live
under internal/ (a boundary the toolchain enforces), signalling private
implementation instead of a library-style flat root. No runtime behavior
changes — only import paths and a few build/config paths move.
Moved: config, database, logger, mtproto, sub, util, web, xray -> internal/.
main.go stays at the repo root and tools/openapigen stays under tools/ (both
still import internal/* because the internal rule keys off the module root).
The module path github.com/mhsanaei/3x-ui/v3 is unchanged; 149 .go files had
their import prefix rewritten to .../internal/<pkg>.
Couplings the Go compiler can't see, updated to the new layout:
- frontend i18n imports of web/translation (react.ts, setup.components.ts)
- vite outDir + eslint/tsconfig ignore globs -> internal/web/dist
- Dockerfile COPY paths for web/dist and web/translation
- locale.go os.DirFS("web") disk fallback -> "internal/web"
- .gitignore and ci.yml go:embed stub for internal/web/dist
- api_docs_test.go repo-root relative walk (one level deeper)
- tools/openapigen filesystem package paths; ApiTokenView repointed to the
web/service/panel subpackage and codegen regenerated (clears a stale
type the ci.yml codegen check was failing on)
Verified: go build/vet/test (all packages), and frontend typecheck, lint,
vitest (478 tests), and production build into internal/web/dist.
* fix(config): keep test runs from writing logs into the source tree
GetLogFolder() returns a CWD-relative "./log" on Windows. Under `go test`
the working directory is each package's own folder, so InitLogger (called by
tests in web/job, web/service, xray, web/websocket) created stray log/
directories scattered through the source tree (e.g. internal/web/job/log/).
Redirect to a shared temp folder when testing.Testing() reports a test run.
Production behavior is unchanged: Windows still uses ./log next to the binary
and Linux /var/log/x-ui. The log files were always gitignored (*.log) and
never committed; this just stops the noise at the source.
* docs: move subscription-template guide out of root into docs/
sub_templates/ was a top-level folder holding only a README and no actual
templates (3x-ui ships none by design), referenced nowhere and unlinked from
any doc — it read like an empty placeholder cluttering the repo root.
Move the guide to docs/custom-subscription-templates.md (a proper docs home),
reword its intro to read as documentation rather than a folder note, link it
from the Features list in README.md, and drop the empty sub_templates/ folder.
* fix: update stale web/ path references after the internal/ move
The internal/ migration rewrote Go import paths but left some references to
the old top-level layout in docs, comments, and a few runtime disk paths.
Functional (dev-mode only): the disk-serving fallbacks that read the Vite
build from disk when running from source still pointed at web/dist/, which
moved to internal/web/dist/ — so `os.DirFS`/`os.Stat`/`os.ReadFile` in
internal/web/web.go and internal/sub/{sub,controller}.go are corrected.
Production was unaffected (it serves the embedded FS; verified by the Docker
build), but `go run` with a live frontend build silently fell back to embed.
Docs/comments: frontend/README.md, CONTRIBUTING.md, the claude-issue-bot and
release workflows, the openapigen -root help text, and assorted Go comments
now reference internal/web, internal/database, internal/sub, internal/xray,
etc. Package-name mentions (the "web" package), root paths (main.go,
frontend/, install scripts, /etc/x-ui), routes (/panel/api/xray), and the
historical "web/assets no longer exists" note were intentionally left as-is.
* refactor(web): remove the legacy /xui -> /panel redirect middleware
RedirectMiddleware existed only for backward compatibility with the old
`/xui` URL scheme (301-redirecting /xui and /xui/API to /panel and
/panel/api). That cutover was long ago, so drop the middleware, its
registration in initRouter, and the now-inaccurate "URL redirection"
mention in the middleware package doc. Old /xui URLs now 404 like any other
unknown path. HTTPS auto-redirect and auth redirects are unrelated and stay.
* build: fix .dockerignore for internal/ layout and exclude runtime dir
- web/dist -> internal/web/dist: the embedded frontend moved under internal/,
so the stale exclude no longer matched and the locally-built dist could be
sent to the build context (the frontend stage rebuilds it fresh anyway).
- exclude x-ui/: the local runtime directory (SQLite db, geo .dat files, xray
binaries, certs — ~150MB) was being shipped into the build context for no
reason. Verified the pattern excludes only the directory and still keeps
x-ui.sh, which the Dockerfile copies to /usr/bin/x-ui.
231 lines
6.7 KiB
Go
231 lines
6.7 KiB
Go
package service
|
|
|
|
import (
|
|
"context"
|
|
"sync"
|
|
"time"
|
|
|
|
"github.com/mhsanaei/3x-ui/v3/internal/database"
|
|
"github.com/mhsanaei/3x-ui/v3/internal/database/model"
|
|
"github.com/mhsanaei/3x-ui/v3/internal/web/runtime"
|
|
)
|
|
|
|
// LocalDescendants returns this panel's read-only summaries of the nodes it
|
|
// directly manages, so a parent panel can surface them as transitive sub-nodes
|
|
// (#4983). Only nodes with a known GUID are included — a stable identity is
|
|
// required to attribute them one hop up. Not recursive: each panel reports its
|
|
// own direct nodes, and a master walks one level via each direct node's
|
|
// endpoint, which covers the Node1 -> Node2 -> Node3 case.
|
|
func (s *NodeService) LocalDescendants() ([]model.NodeSummary, error) {
|
|
selfGuid, _ := (&SettingService{}).GetPanelGuid()
|
|
db := database.GetDB()
|
|
var nodes []*model.Node
|
|
if err := db.Model(model.Node{}).Order("id asc").Find(&nodes).Error; err != nil {
|
|
return nil, err
|
|
}
|
|
out := make([]model.NodeSummary, 0, len(nodes))
|
|
for _, n := range nodes {
|
|
if n.Guid == "" {
|
|
continue
|
|
}
|
|
out = append(out, model.NodeSummary{
|
|
Guid: n.Guid,
|
|
ParentGuid: selfGuid,
|
|
Name: n.Name,
|
|
Address: n.Address,
|
|
Scheme: n.Scheme,
|
|
Port: n.Port,
|
|
Status: n.Status,
|
|
LastHeartbeat: n.LastHeartbeat,
|
|
LatencyMs: n.LatencyMs,
|
|
PanelVersion: n.PanelVersion,
|
|
XrayVersion: n.XrayVersion,
|
|
XrayState: n.XrayState,
|
|
XrayError: n.XrayError,
|
|
})
|
|
}
|
|
return out, nil
|
|
}
|
|
|
|
var (
|
|
nodeDescendantsMu sync.RWMutex
|
|
nodeDescendantsCache = map[int][]model.NodeSummary{}
|
|
)
|
|
|
|
// RefreshDescendants pulls a direct node's published sub-node summaries and
|
|
// caches them keyed by node id. Best-effort: a fetch error keeps the last good
|
|
// set (the node may be briefly unreachable). Called from the heartbeat job.
|
|
func (s *NodeService) RefreshDescendants(ctx context.Context, n *model.Node) {
|
|
if n == nil {
|
|
return
|
|
}
|
|
mgr := runtime.GetManager()
|
|
if mgr == nil {
|
|
return
|
|
}
|
|
rt, err := mgr.RemoteFor(n)
|
|
if err != nil {
|
|
return
|
|
}
|
|
summaries, err := rt.GetDescendants(ctx)
|
|
if err != nil {
|
|
return
|
|
}
|
|
nodeDescendantsMu.Lock()
|
|
if len(summaries) == 0 {
|
|
delete(nodeDescendantsCache, n.Id)
|
|
} else {
|
|
nodeDescendantsCache[n.Id] = summaries
|
|
}
|
|
nodeDescendantsMu.Unlock()
|
|
}
|
|
|
|
// ClearDescendants drops a node's cached sub-node summaries (its probe failed).
|
|
func (s *NodeService) ClearDescendants(nodeID int) {
|
|
nodeDescendantsMu.Lock()
|
|
delete(nodeDescendantsCache, nodeID)
|
|
nodeDescendantsMu.Unlock()
|
|
}
|
|
|
|
func cachedDescendants() []model.NodeSummary {
|
|
nodeDescendantsMu.RLock()
|
|
defer nodeDescendantsMu.RUnlock()
|
|
out := make([]model.NodeSummary, 0)
|
|
for _, list := range nodeDescendantsCache {
|
|
out = append(out, list...)
|
|
}
|
|
return out
|
|
}
|
|
|
|
// GetNodeTree returns the direct nodes plus any transitive sub-nodes learned
|
|
// from them, with per-GUID counts so each node shows only the inbounds/online
|
|
// it physically hosts (#4983). Direct nodes carry the master's own GUID as
|
|
// ParentGuid; a transitive node carries its parent node's GUID. Transitive
|
|
// nodes are read-only projections (Id == 0). Used by the Nodes page and the
|
|
// heartbeat broadcast — never for probing/syncing, which stay on GetAll.
|
|
func (s *NodeService) GetNodeTree() ([]*model.Node, error) {
|
|
nodes, err := s.GetAll()
|
|
if err != nil {
|
|
return nodes, err
|
|
}
|
|
selfGuid, _ := (&SettingService{}).GetPanelGuid()
|
|
directGuids := make(map[string]struct{}, len(nodes))
|
|
for _, n := range nodes {
|
|
n.ParentGuid = selfGuid
|
|
if n.Guid != "" {
|
|
directGuids[n.Guid] = struct{}{}
|
|
}
|
|
}
|
|
|
|
seen := make(map[string]struct{})
|
|
var transitive []*model.Node
|
|
for _, sum := range cachedDescendants() {
|
|
if sum.Guid == "" {
|
|
continue
|
|
}
|
|
if _, ok := directGuids[sum.Guid]; ok {
|
|
continue // already shown as a direct node
|
|
}
|
|
if _, ok := seen[sum.Guid]; ok {
|
|
continue
|
|
}
|
|
seen[sum.Guid] = struct{}{}
|
|
transitive = append(transitive, &model.Node{
|
|
Guid: sum.Guid,
|
|
ParentGuid: sum.ParentGuid,
|
|
Name: sum.Name,
|
|
Address: sum.Address,
|
|
Scheme: sum.Scheme,
|
|
Port: sum.Port,
|
|
Status: sum.Status,
|
|
LastHeartbeat: sum.LastHeartbeat,
|
|
LatencyMs: sum.LatencyMs,
|
|
PanelVersion: sum.PanelVersion,
|
|
XrayVersion: sum.XrayVersion,
|
|
XrayState: sum.XrayState,
|
|
XrayError: sum.XrayError,
|
|
Transitive: true,
|
|
})
|
|
}
|
|
if len(transitive) == 0 {
|
|
return nodes, nil
|
|
}
|
|
|
|
all := make([]*model.Node, 0, len(nodes)+len(transitive))
|
|
all = append(all, nodes...)
|
|
all = append(all, transitive...)
|
|
s.recountByGuid(all, selfGuid)
|
|
return all, nil
|
|
}
|
|
|
|
// recountByGuid recomputes InboundCount/OnlineCount/DepletedCount for every node
|
|
// in the tree, keyed by the GUID that physically hosts each inbound, so a direct
|
|
// node shows only its own inbounds and each transitive node shows its own
|
|
// (#4983). In a flat topology the per-GUID and per-node-id counts coincide, so
|
|
// this only changes behaviour once a transitive node exists.
|
|
func (s *NodeService) recountByGuid(nodes []*model.Node, selfGuid string) {
|
|
db := database.GetDB()
|
|
type ibRow struct {
|
|
Id int
|
|
NodeID *int `gorm:"column:node_id"`
|
|
OriginNodeGuid string `gorm:"column:origin_node_guid"`
|
|
}
|
|
var ibRows []ibRow
|
|
if err := db.Table("inbounds").Select("id, node_id, origin_node_guid").Scan(&ibRows).Error; err != nil {
|
|
return
|
|
}
|
|
effByInbound := make(map[int]string, len(ibRows))
|
|
inboundCountByGuid := make(map[string]int)
|
|
ids := make([]int, 0, len(ibRows))
|
|
for _, r := range ibRows {
|
|
guid := r.OriginNodeGuid
|
|
if guid == "" {
|
|
if r.NodeID != nil {
|
|
guid = synthNodeGuid(*r.NodeID)
|
|
} else {
|
|
guid = selfGuid
|
|
}
|
|
}
|
|
effByInbound[r.Id] = guid
|
|
inboundCountByGuid[guid]++
|
|
ids = append(ids, r.Id)
|
|
}
|
|
|
|
now := time.Now().UnixMilli()
|
|
depletedByGuid := make(map[string]int)
|
|
if len(ids) > 0 {
|
|
type tRow struct {
|
|
InboundID int `gorm:"column:inbound_id"`
|
|
Enable bool
|
|
Total int64
|
|
Up int64
|
|
Down int64
|
|
ExpiryTime int64 `gorm:"column:expiry_time"`
|
|
}
|
|
var tRows []tRow
|
|
if err := db.Table("client_traffics").
|
|
Select("inbound_id, enable, total, up, down, expiry_time").
|
|
Where("inbound_id IN ?", ids).Scan(&tRows).Error; err == nil {
|
|
for _, row := range tRows {
|
|
guid, ok := effByInbound[row.InboundID]
|
|
if !ok {
|
|
continue
|
|
}
|
|
expired := row.ExpiryTime > 0 && row.ExpiryTime <= now
|
|
exhausted := row.Total > 0 && row.Up+row.Down >= row.Total
|
|
if expired || exhausted || !row.Enable {
|
|
depletedByGuid[guid]++
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
onlineByGuid := s.onlineEmailsByGuid()
|
|
for _, n := range nodes {
|
|
guid := effectiveNodeGuid(n)
|
|
n.InboundCount = inboundCountByGuid[guid]
|
|
n.OnlineCount = len(onlineByGuid[guid])
|
|
n.DepletedCount = depletedByGuid[guid]
|
|
}
|
|
}
|