mirror of
https://gitee.com/johng/gf
synced 2026-06-06 02:25:47 +08:00
cb7cfa58ab
This pull request improves the reliability and safety of server restart and reload operations by ensuring the correct retrieval of the current executable path and process arguments. It replaces direct usage of `os.Args[0]` with a more robust approach using `gfile.SelfPath()`, and adds error handling for cases where the executable path cannot be determined. Additionally, it introduces a helper function to safely obtain process arguments, and removes an unnecessary import. **Executable Path Handling and Error Checking:** - Replaced usage of `os.Args[0]` with `gfile.SelfPath()` throughout the server admin and process management code to reliably determine the current executable path; added checks and error responses when the path cannot be determined. [[1]](diffhunk://#diff-0d174b149c56c4aa7ffeba2be94d16dc1b8000933f1f2a2e6bf011acdad3272fL122-R134) [[2]](diffhunk://#diff-0d174b149c56c4aa7ffeba2be94d16dc1b8000933f1f2a2e6bf011acdad3272fL168-R184) [[3]](diffhunk://#diff-3b4265be7ef0335b832dacfc2fc7ddc0f9dfae5b81340ff57d2b6a526c60d9e1L62-R65) - Added early returns in initialization functions if `os.Args` is empty, preventing potential panics or misbehavior when the argument list is missing. [[1]](diffhunk://#diff-0aa99f033274ea60b9c466ae4fc98d0816ec13781d8ec787fb3ef106a49a79ecR35-R37) [[2]](diffhunk://#diff-5782fa47aa858b8e8358fd50353b050ee30418b7844b36e313e9c6d01188c092R47-R49) **Process Argument Handling:** - Introduced the `getCurrentProcessArgs()` helper function to safely return process arguments (excluding the program name), ensuring correct behavior even if no arguments are provided. Updated process creation calls to use this helper. **Code Cleanup:** - Removed an unused import of the `os` package from `ghttp_server_admin.go`. --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
116 lines
3.0 KiB
Go
116 lines
3.0 KiB
Go
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
|
|
//
|
|
// This Source Code Form is subject to the terms of the MIT License.
|
|
// If a copy of the MIT was not distributed with this file,
|
|
// You can obtain one at https://github.com/gogf/gf.
|
|
|
|
package ghttp
|
|
|
|
import (
|
|
"context"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/gogf/gf/v2/os/gfile"
|
|
"github.com/gogf/gf/v2/os/gproc"
|
|
"github.com/gogf/gf/v2/os/gtimer"
|
|
"github.com/gogf/gf/v2/os/gview"
|
|
)
|
|
|
|
// utilAdmin is the controller for administration.
|
|
type utilAdmin struct{}
|
|
|
|
// Index shows the administration page.
|
|
func (p *utilAdmin) Index(r *Request) {
|
|
data := map[string]any{
|
|
"pid": gproc.Pid(),
|
|
"path": gfile.SelfPath(),
|
|
"uri": strings.TrimRight(r.URL.Path, "/"),
|
|
}
|
|
buffer, _ := gview.ParseContent(r.Context(), `
|
|
<html>
|
|
<head>
|
|
<title>GoFrame Web Server Admin</title>
|
|
</head>
|
|
<body>
|
|
<p>Pid: {{.pid}}</p>
|
|
<p>File Path: {{.path}}</p>
|
|
<p>
|
|
<a href="{{$.uri}}/restart">Restart</a>
|
|
please make sure it is running using standalone binary not from IDE or "go run"
|
|
</p>
|
|
<p>
|
|
<a href="{{$.uri}}/shutdown">Shutdown</a>
|
|
graceful shutdown the server
|
|
</p>
|
|
</body>
|
|
</html>
|
|
`, data)
|
|
r.Response.Write(buffer)
|
|
}
|
|
|
|
// Restart restarts all the servers in the process.
|
|
func (p *utilAdmin) Restart(r *Request) {
|
|
var (
|
|
ctx = r.Context()
|
|
err error
|
|
)
|
|
// Custom start binary path when this process exits.
|
|
path := r.GetQuery("newExeFilePath").String()
|
|
if path == "" {
|
|
path = gfile.SelfPath()
|
|
}
|
|
if path == "" {
|
|
r.Response.WriteExit("cannot determine current executable path")
|
|
return
|
|
}
|
|
if err = RestartAllServer(ctx, path); err == nil {
|
|
r.Response.WriteExit("server restarted")
|
|
} else {
|
|
r.Response.WriteExit(err.Error())
|
|
}
|
|
}
|
|
|
|
// Shutdown shuts down all the servers.
|
|
func (p *utilAdmin) Shutdown(r *Request) {
|
|
gtimer.SetTimeout(r.Context(), time.Second, func(ctx context.Context) {
|
|
// It shuts down the server after 1 second, which is not triggered by system signal,
|
|
// to ensure the response successfully to the client.
|
|
_ = r.Server.Shutdown()
|
|
})
|
|
r.Response.WriteExit("server shutdown")
|
|
}
|
|
|
|
// EnableAdmin enables the administration feature for the process.
|
|
// The optional parameter `pattern` specifies the URI for the administration page.
|
|
func (s *Server) EnableAdmin(pattern ...string) {
|
|
p := "/debug/admin"
|
|
if len(pattern) > 0 {
|
|
p = pattern[0]
|
|
}
|
|
s.BindObject(p, &utilAdmin{})
|
|
}
|
|
|
|
// Shutdown shuts the current server.
|
|
func (s *Server) Shutdown() error {
|
|
var ctx = context.TODO()
|
|
// Remove plugins.
|
|
if len(s.plugins) > 0 {
|
|
for _, p := range s.plugins {
|
|
s.Logger().Printf(ctx, `remove plugin: %s`, p.Name())
|
|
if err := p.Remove(); err != nil {
|
|
s.Logger().Errorf(ctx, "%+v", err)
|
|
}
|
|
}
|
|
}
|
|
|
|
s.doServiceDeregister()
|
|
// Only shut down current servers.
|
|
// It may have multiple underlying http servers.
|
|
for _, v := range s.servers {
|
|
v.Shutdown(ctx)
|
|
}
|
|
s.Logger().Infof(ctx, "pid[%d]: all servers shutdown", gproc.Pid())
|
|
return nil
|
|
}
|