panel.go 10 KB

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