panel.go 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395
  1. package panel
  2. import (
  3. "context"
  4. "encoding/json"
  5. "fmt"
  6. "io"
  7. "net/http"
  8. "os"
  9. "os/exec"
  10. "path/filepath"
  11. "regexp"
  12. "runtime"
  13. "strconv"
  14. "strings"
  15. "syscall"
  16. "time"
  17. "github.com/mhsanaei/3x-ui/v3/internal/config"
  18. "github.com/mhsanaei/3x-ui/v3/internal/logger"
  19. "github.com/mhsanaei/3x-ui/v3/internal/web/global"
  20. "github.com/mhsanaei/3x-ui/v3/internal/web/service"
  21. )
  22. // PanelService provides business logic for panel management operations.
  23. // It handles panel restart, updates, and system-level panel controls.
  24. type PanelService struct{}
  25. // PanelUpdateInfo contains the current and latest available panel versions.
  26. // On the dev channel the version fields carry a "dev+<sha>" label and the commit
  27. // fields hold the short SHAs that drive the update-available decision.
  28. type PanelUpdateInfo struct {
  29. Channel string `json:"channel"`
  30. CurrentVersion string `json:"currentVersion"`
  31. LatestVersion string `json:"latestVersion"`
  32. CurrentCommit string `json:"currentCommit,omitempty"`
  33. LatestCommit string `json:"latestCommit,omitempty"`
  34. UpdateAvailable bool `json:"updateAvailable"`
  35. }
  36. const (
  37. panelUpdaterURL = "https://raw.githubusercontent.com/MHSanaei/3x-ui/main/update.sh"
  38. maxPanelUpdaterBytes = 2 << 20
  39. // devReleaseTag is the fixed-tag rolling pre-release the CI force-moves to the
  40. // newest main commit; the dev update channel installs from it.
  41. devReleaseTag = "dev-latest"
  42. )
  43. var releaseCommitRegex = regexp.MustCompile(`(?i)commit=([0-9a-f]{7,40})`)
  44. func (s *PanelService) RestartPanel(delay time.Duration) error {
  45. go func() {
  46. time.Sleep(delay)
  47. if global.TriggerRestart() {
  48. return
  49. }
  50. if runtime.GOOS == "windows" {
  51. logger.Error("panel restart: no restart hook registered (SIGHUP unsupported on Windows)")
  52. return
  53. }
  54. p, err := os.FindProcess(syscall.Getpid())
  55. if err != nil {
  56. logger.Error("panel restart: FindProcess failed:", err)
  57. return
  58. }
  59. if err := p.Signal(syscall.SIGHUP); err != nil {
  60. logger.Error("failed to send SIGHUP signal:", err)
  61. }
  62. }()
  63. return nil
  64. }
  65. // GetUpdateInfo checks GitHub for the latest 3x-ui release. When the dev channel
  66. // is enabled on a dev build it compares commits against the rolling dev release;
  67. // otherwise it compares versions against the latest stable tag.
  68. func (s *PanelService) GetUpdateInfo() (*PanelUpdateInfo, error) {
  69. if devChannelActive() {
  70. return getDevUpdateInfo()
  71. }
  72. latest, err := fetchLatestPanelVersion()
  73. if err != nil {
  74. return nil, err
  75. }
  76. current := config.GetBaseVersion()
  77. return &PanelUpdateInfo{
  78. Channel: "stable",
  79. CurrentVersion: current,
  80. LatestVersion: latest,
  81. UpdateAvailable: isNewerVersion(latest, current),
  82. }, nil
  83. }
  84. // devChannelActive reports whether self-update should track the rolling dev
  85. // release. It is driven solely by the opt-in setting so the panel can
  86. // cross-grade a stable build onto the dev channel once the user enables it;
  87. // nothing updates without an explicit user action, so an unattended stable
  88. // binary with the toggle off stays on the stable channel.
  89. func devChannelActive() bool {
  90. enabled, err := (&service.SettingService{}).GetDevChannelEnable()
  91. return err == nil && enabled
  92. }
  93. // getDevUpdateInfo compares the running commit against the commit recorded in the
  94. // rolling dev release.
  95. func getDevUpdateInfo() (*PanelUpdateInfo, error) {
  96. release, err := fetchPanelRelease(devReleaseTag)
  97. if err != nil {
  98. return nil, err
  99. }
  100. latestCommit := extractReleaseCommit(release)
  101. if latestCommit == "" {
  102. return nil, fmt.Errorf("dev release commit is unknown")
  103. }
  104. currentCommit := config.GetBuildCommit()
  105. return &PanelUpdateInfo{
  106. Channel: "dev",
  107. CurrentVersion: config.GetPanelVersion(),
  108. CurrentCommit: shortCommit(currentCommit),
  109. LatestCommit: shortCommit(latestCommit),
  110. LatestVersion: "dev+" + shortCommit(latestCommit),
  111. UpdateAvailable: !commitsEqual(currentCommit, latestCommit),
  112. }, nil
  113. }
  114. // StartUpdate starts the official updater using this panel's own channel setting.
  115. func (s *PanelService) StartUpdate() error {
  116. return s.startUpdate(devChannelActive())
  117. }
  118. // StartUpdateChannel runs the updater against an explicitly chosen channel,
  119. // overriding the local dev-channel setting. Used by the master node updater so
  120. // a node can be moved to the dev channel from the central panel.
  121. func (s *PanelService) StartUpdateChannel(dev bool) error {
  122. return s.startUpdate(dev)
  123. }
  124. func (s *PanelService) startUpdate(useDev bool) error {
  125. if runtime.GOOS != "linux" {
  126. return fmt.Errorf("panel web update is supported only on Linux installations")
  127. }
  128. bash, err := exec.LookPath("bash")
  129. if err != nil {
  130. return fmt.Errorf("bash is required to run the panel updater: %w", err)
  131. }
  132. scriptPath, err := downloadPanelUpdater()
  133. if err != nil {
  134. return err
  135. }
  136. mainFolder, serviceFolder := resolveUpdateFolders()
  137. updateTag := ""
  138. if useDev {
  139. updateTag = devReleaseTag
  140. }
  141. updateScript := fmt.Sprintf("set -e; trap 'rm -f %s' EXIT; %s %s", shellQuote(scriptPath), shellQuote(bash), shellQuote(scriptPath))
  142. if systemdRun, err := exec.LookPath("systemd-run"); err == nil {
  143. unitName := fmt.Sprintf("x-ui-web-update-%d", time.Now().Unix())
  144. cmd := exec.CommandContext(context.Background(), systemdRun,
  145. "--unit", unitName,
  146. "--setenv", "XUI_MAIN_FOLDER="+mainFolder,
  147. "--setenv", "XUI_SERVICE="+serviceFolder,
  148. "--setenv", "XUI_UPDATE_TAG="+updateTag,
  149. bash, "-lc", updateScript,
  150. )
  151. out, err := cmd.CombinedOutput()
  152. if err != nil {
  153. output := strings.TrimSpace(string(out))
  154. if !strings.Contains(output, "System has not been booted with systemd") &&
  155. !strings.Contains(output, "Failed to connect to bus") {
  156. _ = os.Remove(scriptPath)
  157. return fmt.Errorf("failed to start panel update job: %w: %s", err, output)
  158. }
  159. logger.Warning("systemd-run is unavailable, falling back to detached update process:", output)
  160. } else {
  161. logger.Infof("started panel update job via systemd-run unit %s", unitName)
  162. return nil
  163. }
  164. }
  165. cmd := exec.CommandContext(context.Background(), bash, "-lc", updateScript)
  166. cmd.Env = append(os.Environ(),
  167. "XUI_MAIN_FOLDER="+mainFolder,
  168. "XUI_SERVICE="+serviceFolder,
  169. "XUI_UPDATE_TAG="+updateTag,
  170. )
  171. setDetachedProcess(cmd)
  172. if err := cmd.Start(); err != nil {
  173. _ = os.Remove(scriptPath)
  174. return fmt.Errorf("failed to start panel update job: %w", err)
  175. }
  176. if err := cmd.Process.Release(); err != nil {
  177. logger.Warning("failed to release panel update process:", err)
  178. }
  179. logger.Infof("started panel update job with pid %d", cmd.Process.Pid)
  180. return nil
  181. }
  182. func downloadPanelUpdater() (string, error) {
  183. client := (&service.SettingService{}).NewProxiedHTTPClient(15 * time.Second)
  184. req, reqErr := http.NewRequestWithContext(context.Background(), http.MethodGet, panelUpdaterURL, nil)
  185. if reqErr != nil {
  186. return "", fmt.Errorf("download panel updater: %w", reqErr)
  187. }
  188. resp, err := client.Do(req)
  189. if err != nil {
  190. return "", fmt.Errorf("download panel updater: %w", err)
  191. }
  192. defer resp.Body.Close()
  193. if resp.StatusCode != http.StatusOK {
  194. return "", fmt.Errorf("download panel updater: unexpected HTTP %d", resp.StatusCode)
  195. }
  196. file, err := os.CreateTemp("", "3x-ui-update-*.sh")
  197. if err != nil {
  198. return "", err
  199. }
  200. path := file.Name()
  201. ok := false
  202. defer func() {
  203. _ = file.Close()
  204. if !ok {
  205. _ = os.Remove(path)
  206. }
  207. }()
  208. n, err := io.Copy(file, io.LimitReader(resp.Body, maxPanelUpdaterBytes+1))
  209. if err != nil {
  210. return "", fmt.Errorf("write panel updater: %w", err)
  211. }
  212. if n > maxPanelUpdaterBytes {
  213. return "", fmt.Errorf("panel updater exceeds %d bytes", maxPanelUpdaterBytes)
  214. }
  215. if err := file.Chmod(0o700); err != nil {
  216. return "", err
  217. }
  218. ok = true
  219. return path, nil
  220. }
  221. func fetchLatestPanelVersion() (string, error) {
  222. release, err := fetchPanelRelease("")
  223. if err != nil {
  224. return "", err
  225. }
  226. if release.TagName == "" {
  227. return "", fmt.Errorf("latest panel release tag is empty")
  228. }
  229. return release.TagName, nil
  230. }
  231. // fetchPanelRelease fetches a release from GitHub. An empty tag resolves the
  232. // latest stable release; a non-empty tag (e.g. dev-latest) resolves that tag.
  233. func fetchPanelRelease(tag string) (*service.Release, error) {
  234. url := "https://api.github.com/repos/MHSanaei/3x-ui/releases/latest"
  235. if tag != "" {
  236. url = "https://api.github.com/repos/MHSanaei/3x-ui/releases/tags/" + tag
  237. }
  238. client := (&service.SettingService{}).NewProxiedHTTPClient(10 * time.Second)
  239. req, reqErr := http.NewRequestWithContext(context.Background(), http.MethodGet, url, nil)
  240. if reqErr != nil {
  241. return nil, reqErr
  242. }
  243. resp, err := client.Do(req)
  244. if err != nil {
  245. return nil, err
  246. }
  247. defer resp.Body.Close()
  248. if resp.StatusCode != http.StatusOK {
  249. return nil, fmt.Errorf("GitHub API returned status %d: %s", resp.StatusCode, resp.Status)
  250. }
  251. var release service.Release
  252. if err := json.NewDecoder(resp.Body).Decode(&release); err != nil {
  253. return nil, err
  254. }
  255. return &release, nil
  256. }
  257. // extractReleaseCommit reads the build commit recorded in the dev release: first
  258. // the `commit=<sha>` marker the CI writes into the body, falling back to the
  259. // tag's target commit.
  260. func extractReleaseCommit(release *service.Release) string {
  261. if m := releaseCommitRegex.FindStringSubmatch(release.Body); m != nil {
  262. return strings.ToLower(m[1])
  263. }
  264. if isCommitSHA(release.TargetCommitish) {
  265. return strings.ToLower(release.TargetCommitish)
  266. }
  267. return ""
  268. }
  269. func isCommitSHA(s string) bool {
  270. s = strings.TrimSpace(s)
  271. if len(s) < 7 || len(s) > 40 {
  272. return false
  273. }
  274. for _, r := range s {
  275. if (r < '0' || r > '9') && (r < 'a' || r > 'f') && (r < 'A' || r > 'F') {
  276. return false
  277. }
  278. }
  279. return true
  280. }
  281. func shortCommit(sha string) string {
  282. sha = strings.TrimSpace(sha)
  283. if len(sha) > 8 {
  284. return sha[:8]
  285. }
  286. return sha
  287. }
  288. // commitsEqual compares a short (injected) commit against a full release commit
  289. // by prefix, so an 8-char build stamp matches the 40-char release SHA.
  290. func commitsEqual(a, b string) bool {
  291. a = strings.ToLower(strings.TrimSpace(a))
  292. b = strings.ToLower(strings.TrimSpace(b))
  293. if a == "" || b == "" {
  294. return false
  295. }
  296. if len(a) > len(b) {
  297. a, b = b, a
  298. }
  299. return strings.HasPrefix(b, a)
  300. }
  301. func resolveUpdateFolders() (string, string) {
  302. mainFolder := os.Getenv("XUI_MAIN_FOLDER")
  303. if mainFolder == "" {
  304. if exePath, err := os.Executable(); err == nil {
  305. mainFolder = filepath.Dir(exePath)
  306. }
  307. }
  308. if mainFolder == "" {
  309. mainFolder = "/usr/local/x-ui"
  310. }
  311. serviceFolder := os.Getenv("XUI_SERVICE")
  312. if serviceFolder == "" {
  313. serviceFolder = "/etc/systemd/system"
  314. }
  315. return mainFolder, serviceFolder
  316. }
  317. func isNewerVersion(latest string, current string) bool {
  318. cmp, ok := compareVersionStrings(latest, current)
  319. if !ok {
  320. return normalizeVersionTag(latest) != normalizeVersionTag(current)
  321. }
  322. return cmp > 0
  323. }
  324. func compareVersionStrings(a string, b string) (int, bool) {
  325. aParts, okA := parseVersionParts(a)
  326. bParts, okB := parseVersionParts(b)
  327. if !okA || !okB {
  328. return 0, false
  329. }
  330. for i := range len(aParts) {
  331. if aParts[i] > bParts[i] {
  332. return 1, true
  333. }
  334. if aParts[i] < bParts[i] {
  335. return -1, true
  336. }
  337. }
  338. return 0, true
  339. }
  340. func parseVersionParts(version string) ([3]int, bool) {
  341. var result [3]int
  342. parts := strings.Split(normalizeVersionTag(version), ".")
  343. if len(parts) != 3 {
  344. return result, false
  345. }
  346. for i, part := range parts {
  347. n, err := strconv.Atoi(part)
  348. if err != nil {
  349. return result, false
  350. }
  351. result[i] = n
  352. }
  353. return result, true
  354. }
  355. func normalizeVersionTag(version string) string {
  356. return strings.TrimPrefix(strings.TrimSpace(version), "v")
  357. }
  358. func shellQuote(value string) string {
  359. return "'" + strings.ReplaceAll(value, "'", "'\\''") + "'"
  360. }