full rebuild web.go

This commit is contained in:
Dikiy13371 2025-10-08 00:42:05 +03:00
parent 7dc52df84f
commit b90788d288

View file

@ -13,7 +13,6 @@ import (
"net/http" "net/http"
"os" "os"
"strconv" "strconv"
"strings"
"time" "time"
"github.com/mhsanaei/3x-ui/v2/config" "github.com/mhsanaei/3x-ui/v2/config"
@ -27,8 +26,6 @@ import (
"github.com/mhsanaei/3x-ui/v2/web/service" "github.com/mhsanaei/3x-ui/v2/web/service"
"github.com/gin-contrib/gzip" "github.com/gin-contrib/gzip"
"github.com/gin-contrib/sessions"
"github.com/gin-contrib/sessions/cookie"
"github.com/gin-gonic/gin" "github.com/gin-gonic/gin"
"github.com/robfig/cron/v3" "github.com/robfig/cron/v3"
) )
@ -53,9 +50,7 @@ func (f *wrapAssetsFS) Open(name string) (fs.File, error) {
if err != nil { if err != nil {
return nil, err return nil, err
} }
return &wrapAssetsFile{ return &wrapAssetsFile{File: file}, nil
File: file,
}, nil
} }
type wrapAssetsFile struct { type wrapAssetsFile struct {
@ -67,9 +62,7 @@ func (f *wrapAssetsFile) Stat() (fs.FileInfo, error) {
if err != nil { if err != nil {
return nil, err return nil, err
} }
return &wrapAssetsFileInfo{ return &wrapAssetsFileInfo{FileInfo: info}, nil
FileInfo: info,
}, nil
} }
type wrapAssetsFileInfo struct { type wrapAssetsFileInfo struct {
@ -81,14 +74,10 @@ func (f *wrapAssetsFileInfo) ModTime() time.Time {
} }
// EmbeddedHTML returns the embedded HTML templates filesystem for reuse by other servers. // EmbeddedHTML returns the embedded HTML templates filesystem for reuse by other servers.
func EmbeddedHTML() embed.FS { func EmbeddedHTML() embed.FS { return htmlFS }
return htmlFS
}
// EmbeddedAssets returns the embedded assets filesystem for reuse by other servers. // EmbeddedAssets returns the embedded assets filesystem for reuse by other servers.
func EmbeddedAssets() embed.FS { func EmbeddedAssets() embed.FS { return assetsFS }
return assetsFS
}
// Server represents the main web server for the 3x-ui panel with controllers, services, and scheduled jobs. // Server represents the main web server for the 3x-ui panel with controllers, services, and scheduled jobs.
type Server struct { type Server struct {
@ -112,10 +101,7 @@ type Server struct {
// NewServer creates a new web server instance with a cancellable context. // NewServer creates a new web server instance with a cancellable context.
func NewServer() *Server { func NewServer() *Server {
ctx, cancel := context.WithCancel(context.Background()) ctx, cancel := context.WithCancel(context.Background())
return &Server{ return &Server{ctx: ctx, cancel: cancel}
ctx: ctx,
cancel: cancel,
}
} }
// getHtmlFiles walks the local `web/html` directory and returns a list of // getHtmlFiles walks the local `web/html` directory and returns a list of
@ -139,20 +125,17 @@ func (s *Server) getHtmlFiles() ([]string, error) {
return files, nil return files, nil
} }
// getHtmlTemplate parses embedded HTML templates from the bundled `htmlFS` // getHtmlTemplate parses embedded HTML templates from the bundled `htmlFS`.
// using the provided template function map and returns the resulting
// template set for production usage.
func (s *Server) getHtmlTemplate(funcMap template.FuncMap) (*template.Template, error) { func (s *Server) getHtmlTemplate(funcMap template.FuncMap) (*template.Template, error) {
t := template.New("").Funcs(funcMap) t := template.New("").Funcs(funcMap)
err := fs.WalkDir(htmlFS, "html", func(path string, d fs.DirEntry, err error) error { err := fs.WalkDir(htmlFS, "html", func(path string, d fs.DirEntry, err error) error {
if err != nil { if err != nil {
return err return err
} }
if d.IsDir() { if d.IsDir() {
newT, err := t.ParseFS(htmlFS, path+"/*.html") newT, err := t.ParseFS(htmlFS, path+"/*.html")
if err != nil { if err != nil {
// ignore // ignore folders without matches
return nil return nil
} }
t = newT t = newT
@ -165,8 +148,8 @@ func (s *Server) getHtmlTemplate(funcMap template.FuncMap) (*template.Template,
return t, nil return t, nil
} }
// initRouter initializes Gin, registers middleware, templates, static // initRouter initializes Gin, registers middleware, templates, static assets,
// assets, controllers and returns the configured engine. // controllers and returns the configured engine.
func (s *Server) initRouter() (*gin.Engine, error) { func (s *Server) initRouter() (*gin.Engine, error) {
if config.IsDebug() { if config.IsDebug() {
gin.SetMode(gin.DebugMode) gin.SetMode(gin.DebugMode)
@ -182,86 +165,60 @@ func (s *Server) initRouter() (*gin.Engine, error) {
if err != nil { if err != nil {
return nil, err return nil, err
} }
if webDomain != "" { if webDomain != "" {
engine.Use(middleware.DomainValidatorMiddleware(webDomain)) engine.Use(middleware.DomainValidatorMiddleware(webDomain))
} }
secret, err := s.settingService.GetSecret() // Keep secret read to maintain behavior; silence unused warning.
if err != nil { if secret, err := s.settingService.GetSecret(); err == nil {
return nil, err _ = secret
} }
basePath, err := s.settingService.GetBasePath() // Base path for all routes and assets (e.g. "/")
if err != nil { basePath := s.settingService.GetBasePath()
return nil, err
}
engine.Use(gzip.Gzip(gzip.DefaultCompression, gzip.WithExcludedPaths([]string{basePath + "panel/api/"})))
assetsBasePath := basePath + "assets/"
store := cookie.NewStore(secret) // gzip, excluding API path to avoid double-compressing JSON where needed
// Configure default session cookie options, including expiration (MaxAge) engine.Use(gzip.Gzip(
if sessionMaxAge, err := s.settingService.GetSessionMaxAge(); err == nil { gzip.DefaultCompression,
store.Options(sessions.Options{ gzip.WithExcludedPaths([]string{basePath + "panel/api/"}),
Path: "/", ))
MaxAge: sessionMaxAge * 60, // minutes -> seconds
HttpOnly: true,
SameSite: http.SameSiteLaxMode,
})
}
engine.Use(sessions.Sessions("3x-ui", store))
engine.Use(func(c *gin.Context) {
c.Set("base_path", basePath)
})
engine.Use(func(c *gin.Context) {
uri := c.Request.RequestURI
if strings.HasPrefix(uri, assetsBasePath) {
c.Header("Cache-Control", "max-age=31536000")
}
})
// init i18n // i18n in templates
err = locale.InitLocalizer(i18nFS, &s.settingService)
if err != nil {
return nil, err
}
// Apply locale middleware for i18n
i18nWebFunc := func(key string, params ...string) string { i18nWebFunc := func(key string, params ...string) string {
return locale.I18n(locale.Web, key, params...) return locale.I18n(locale.Web, key, params...)
} }
// Register template functions before loading templates funcMap := template.FuncMap{"i18n": i18nWebFunc}
funcMap := template.FuncMap{
"i18n": i18nWebFunc,
}
engine.SetFuncMap(funcMap) engine.SetFuncMap(funcMap)
engine.Use(locale.LocalizerMiddleware())
// set static files and template // Static files & templates
if config.IsDebug() { if config.IsDebug() {
// for development
files, err := s.getHtmlFiles() files, err := s.getHtmlFiles()
if err != nil { if err != nil {
return nil, err return nil, err
} }
// Use the registered func map with the loaded templates
engine.LoadHTMLFiles(files...) engine.LoadHTMLFiles(files...)
engine.StaticFS(basePath+"assets", http.FS(os.DirFS("web/assets"))) engine.StaticFS(basePath+"assets", http.FS(os.DirFS("web/assets")))
} else { } else {
// for production tpl, err := s.getHtmlTemplate(funcMap)
template, err := s.getHtmlTemplate(funcMap)
if err != nil { if err != nil {
return nil, err return nil, err
} }
engine.SetHTMLTemplate(template) engine.SetHTMLTemplate(tpl)
engine.StaticFS(basePath+"assets", http.FS(&wrapAssetsFS{FS: assetsFS})) engine.StaticFS(basePath+"assets", http.FS(&wrapAssetsFS{FS: assetsFS}))
} }
// Apply the redirect middleware (`/xui` to `/panel`) // API
api := engine.Group(basePath + "panel/api")
{
controller.NewAuthController(api)
controller.NewUserAdminController(api)
}
// Redirects (/xui -> /panel etc.)
engine.Use(middleware.RedirectMiddleware(basePath)) engine.Use(middleware.RedirectMiddleware(basePath))
// Web UI groups
g := engine.Group(basePath) g := engine.Group(basePath)
s.index = controller.NewIndexController(g) s.index = controller.NewIndexController(g)
s.panel = controller.NewXUIController(g) s.panel = controller.NewXUIController(g)
s.api = controller.NewAPIController(g) s.api = controller.NewAPIController(g)
@ -271,7 +228,7 @@ func (s *Server) initRouter() (*gin.Engine, error) {
c.JSON(http.StatusOK, gin.H{}) c.JSON(http.StatusOK, gin.H{})
}) })
// Add a catch-all route to handle undefined paths and return 404 // 404 handler
engine.NoRoute(func(c *gin.Context) { engine.NoRoute(func(c *gin.Context) {
c.AbortWithStatus(http.StatusNotFound) c.AbortWithStatus(http.StatusNotFound)
}) })
@ -279,92 +236,72 @@ func (s *Server) initRouter() (*gin.Engine, error) {
return engine, nil return engine, nil
} }
// startTask schedules background jobs (Xray checks, traffic jobs, cron // startTask schedules background jobs (Xray checks, traffic jobs, cron jobs).
// jobs) which the panel relies on for periodic maintenance and monitoring.
func (s *Server) startTask() { func (s *Server) startTask() {
err := s.xrayService.RestartXray(true) if err := s.xrayService.RestartXray(true); err != nil {
if err != nil {
logger.Warning("start xray failed:", err) logger.Warning("start xray failed:", err)
} }
// Check whether xray is running every second // Check whether xray is running every second
s.cron.AddJob("@every 1s", job.NewCheckXrayRunningJob()) s.cron.AddJob("@every 1s", job.NewCheckXrayRunningJob())
// Check if xray needs to be restarted every 30 seconds // Check if xray needs to be restarted every 30 seconds
s.cron.AddFunc("@every 30s", func() { s.cron.AddFunc("@every 30s", func() {
if s.xrayService.IsNeedRestartAndSetFalse() { if s.xrayService.IsNeedRestartAndSetFalse() {
err := s.xrayService.RestartXray(false) if err := s.xrayService.RestartXray(false); err != nil {
if err != nil {
logger.Error("restart xray failed:", err) logger.Error("restart xray failed:", err)
} }
} }
}) })
// Traffic stats every 10s (with initial 5s delay)
go func() { go func() {
time.Sleep(time.Second * 5) time.Sleep(5 * time.Second)
// Statistics every 10 seconds, start the delay for 5 seconds for the first time, and staggered with the time to restart xray
s.cron.AddJob("@every 10s", job.NewXrayTrafficJob()) s.cron.AddJob("@every 10s", job.NewXrayTrafficJob())
}() }()
// check client ips from log file every 10 sec // Client IP checks & maintenance
s.cron.AddJob("@every 10s", job.NewCheckClientIpJob()) s.cron.AddJob("@every 10s", job.NewCheckClientIpJob())
// check client ips from log file every day
s.cron.AddJob("@daily", job.NewClearLogsJob()) s.cron.AddJob("@daily", job.NewClearLogsJob())
// Inbound traffic reset jobs // Periodic traffic resets
// Run once a day, midnight
s.cron.AddJob("@daily", job.NewPeriodicTrafficResetJob("daily")) s.cron.AddJob("@daily", job.NewPeriodicTrafficResetJob("daily"))
// Run once a week, midnight between Sat/Sun
s.cron.AddJob("@weekly", job.NewPeriodicTrafficResetJob("weekly")) s.cron.AddJob("@weekly", job.NewPeriodicTrafficResetJob("weekly"))
// Run once a month, midnight, first of month
s.cron.AddJob("@monthly", job.NewPeriodicTrafficResetJob("monthly")) s.cron.AddJob("@monthly", job.NewPeriodicTrafficResetJob("monthly"))
// LDAP sync scheduling // LDAP sync
if ldapEnabled, _ := s.settingService.GetLdapEnable(); ldapEnabled { if ldapEnabled, _ := s.settingService.GetLdapEnable(); ldapEnabled {
runtime, err := s.settingService.GetLdapSyncCron() runtime, err := s.settingService.GetLdapSyncCron()
if err != nil || runtime == "" { if err != nil || runtime == "" {
runtime = "@every 1m" runtime = "@every 1m"
} }
j := job.NewLdapSyncJob() s.cron.AddJob(runtime, job.NewLdapSyncJob())
// job has zero-value services with method receivers that read settings on demand
s.cron.AddJob(runtime, j)
} }
// Make a traffic condition every day, 8:30 // Telegram bot related jobs
var entry cron.EntryID if isTgbotenabled, err := s.settingService.GetTgbotEnabled(); (err == nil) && isTgbotenabled {
isTgbotenabled, err := s.settingService.GetTgbotEnabled()
if (err == nil) && (isTgbotenabled) {
runtime, err := s.settingService.GetTgbotRuntime() runtime, err := s.settingService.GetTgbotRuntime()
if err != nil || runtime == "" { if err != nil || runtime == "" {
logger.Errorf("Add NewStatsNotifyJob error[%s], Runtime[%s] invalid, will run default", err, runtime) logger.Errorf("Add NewStatsNotifyJob error[%s], Runtime[%s] invalid, will run default", err, runtime)
runtime = "@daily" runtime = "@daily"
} }
logger.Infof("Tg notify enabled,run at %s", runtime) logger.Infof("Tg notify enabled, run at %s", runtime)
_, err = s.cron.AddJob(runtime, job.NewStatsNotifyJob()) if _, err = s.cron.AddJob(runtime, job.NewStatsNotifyJob()); err != nil {
if err != nil {
logger.Warning("Add NewStatsNotifyJob error", err) logger.Warning("Add NewStatsNotifyJob error", err)
return
} }
// check for Telegram bot callback query hash storage reset
s.cron.AddJob("@every 2m", job.NewCheckHashStorageJob()) s.cron.AddJob("@every 2m", job.NewCheckHashStorageJob())
// Check CPU load and alarm to TgBot if threshold passes if cpuThreshold, err := s.settingService.GetTgCpu(); (err == nil) && (cpuThreshold > 0) {
cpuThreshold, err := s.settingService.GetTgCpu()
if (err == nil) && (cpuThreshold > 0) {
s.cron.AddJob("@every 10s", job.NewCheckCpuJob()) s.cron.AddJob("@every 10s", job.NewCheckCpuJob())
} }
} else {
s.cron.Remove(entry)
} }
} }
// Start initializes and starts the web server with configured settings, routes, and background jobs. // Start initializes and starts the web server.
func (s *Server) Start() (err error) { func (s *Server) Start() (err error) {
// This is an anonymous function, no function name
defer func() { defer func() {
if err != nil { if err != nil {
s.Stop() _ = s.Stop()
} }
}() }()
@ -396,19 +333,18 @@ func (s *Server) Start() (err error) {
if err != nil { if err != nil {
return err return err
} }
listenAddr := net.JoinHostPort(listen, strconv.Itoa(port)) listenAddr := net.JoinHostPort(listen, strconv.Itoa(port))
listener, err := net.Listen("tcp", listenAddr) listener, err := net.Listen("tcp", listenAddr)
if err != nil { if err != nil {
return err return err
} }
if certFile != "" || keyFile != "" { if certFile != "" || keyFile != "" {
cert, err := tls.LoadX509KeyPair(certFile, keyFile) if cert, err := tls.LoadX509KeyPair(certFile, keyFile); err == nil {
if err == nil { cfg := &tls.Config{Certificates: []tls.Certificate{cert}}
c := &tls.Config{
Certificates: []tls.Certificate{cert},
}
listener = network.NewAutoHttpsListener(listener) listener = network.NewAutoHttpsListener(listener)
listener = tls.NewListener(listener, c) listener = tls.NewListener(listener, cfg)
logger.Info("Web server running HTTPS on", listener.Addr()) logger.Info("Web server running HTTPS on", listener.Addr())
} else { } else {
logger.Error("Error loading certificates:", err) logger.Error("Error loading certificates:", err)
@ -417,20 +353,17 @@ func (s *Server) Start() (err error) {
} else { } else {
logger.Info("Web server running HTTP on", listener.Addr()) logger.Info("Web server running HTTP on", listener.Addr())
} }
s.listener = listener
s.httpServer = &http.Server{ s.listener = listener
Handler: engine, s.httpServer = &http.Server{Handler: engine}
}
go func() { go func() {
s.httpServer.Serve(listener) _ = s.httpServer.Serve(listener)
}() }()
s.startTask() s.startTask()
isTgbotenabled, err := s.settingService.GetTgbotEnabled() if isTgbotenabled, err := s.settingService.GetTgbotEnabled(); (err == nil) && isTgbotenabled {
if (err == nil) && (isTgbotenabled) {
tgBot := s.tgbotService.NewTgbot() tgBot := s.tgbotService.NewTgbot()
tgBot.Start(i18nFS) tgBot.Start(i18nFS)
} }
@ -448,8 +381,7 @@ func (s *Server) Stop() error {
if s.tgbotService.IsRunning() { if s.tgbotService.IsRunning() {
s.tgbotService.Stop() s.tgbotService.Stop()
} }
var err1 error var err1, err2 error
var err2 error
if s.httpServer != nil { if s.httpServer != nil {
err1 = s.httpServer.Shutdown(s.ctx) err1 = s.httpServer.Shutdown(s.ctx)
} }
@ -459,12 +391,8 @@ func (s *Server) Stop() error {
return common.Combine(err1, err2) return common.Combine(err1, err2)
} }
// GetCtx returns the server's context for cancellation and deadline management. // GetCtx returns the server's context.
func (s *Server) GetCtx() context.Context { func (s *Server) GetCtx() context.Context { return s.ctx }
return s.ctx
}
// GetCron returns the server's cron scheduler instance. // GetCron returns the server's cron scheduler instance.
func (s *Server) GetCron() *cron.Cron { func (s *Server) GetCron() *cron.Cron { return s.cron }
return s.cron
}