thepaperpilot/forgejo
1
0
Fork 0
Code Issues Pull requests Releases Activity Actions

Some refactor for git http (#28995)

Browse source 
# Purpose

This PR makes git http related functions use the same `context.Context`
so they can be maintained easier.
This commit is contained in:
Lunny Xiao 2024-01-31 23:23:22 +08:00 committed by GitHub
parent adc3598a75
commit 3b50dd95ce
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 85 additions and 100 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

185
routers/web/repo/githttp.go
View file

@ -11,7 +11,7 @@ import (
"fmt" "fmt"
"net/http" "net/http"
"os" "os"
"path" "path/filepath"
"regexp" "regexp"
"strconv" "strconv"
"strings" "strings"
@ -90,11 +90,10 @@ func httpBase(ctx *context.Context) *serviceHandler {
isWiki := false isWiki := false
unitType := unit.TypeCode unitType := unit.TypeCode
var wikiRepoName string
if strings.HasSuffix(reponame, ".wiki") { if strings.HasSuffix(reponame, ".wiki") {
isWiki = true isWiki = true
unitType = unit.TypeWiki unitType = unit.TypeWiki
wikiRepoName = reponame
reponame = reponame[:len(reponame)-5] reponame = reponame[:len(reponame)-5]
} }
@ -107,16 +106,16 @@ func httpBase(ctx *context.Context) *serviceHandler {
repoExist := true repoExist := true
repo, err := repo_model.GetRepositoryByName(ctx, owner.ID, reponame) repo, err := repo_model.GetRepositoryByName(ctx, owner.ID, reponame)
if err != nil { if err != nil {
if repo_model.IsErrRepoNotExist(err) { if !repo_model.IsErrRepoNotExist(err) {
if redirectRepoID, err := repo_model.LookupRedirect(ctx, owner.ID, reponame); err == nil {
context.RedirectToRepo(ctx.Base, redirectRepoID)
return nil
}
repoExist = false
} else {
ctx.ServerError("GetRepositoryByName", err) ctx.ServerError("GetRepositoryByName", err)
return nil return nil
} }
if redirectRepoID, err := repo_model.LookupRedirect(ctx, owner.ID, reponame); err == nil {
context.RedirectToRepo(ctx.Base, redirectRepoID)
return nil
}
repoExist = false
} }
// Don't allow pushing if the repo is archived // Don't allow pushing if the repo is archived
@ -292,22 +291,9 @@ func httpBase(ctx *context.Context) *serviceHandler {
environ = append(environ, repo_module.EnvRepoID+fmt.Sprintf("=%d", repo.ID)) environ = append(environ, repo_module.EnvRepoID+fmt.Sprintf("=%d", repo.ID))
w := ctx.Resp ctx.Req.URL.Path = strings.ToLower(ctx.Req.URL.Path) // blue: In case some repo name has upper case name
r := ctx.Req
cfg := &serviceConfig{
UploadPack: true,
ReceivePack: true,
Env: environ,
}
r.URL.Path = strings.ToLower(r.URL.Path) // blue: In case some repo name has upper case name return &serviceHandler{repo, isWiki, environ}
dir := repo_model.RepoPath(username, reponame)
if isWiki {
dir = repo_model.RepoPath(username, wikiRepoName)
}
return &serviceHandler{cfg, w, r, dir, cfg.Env}
} }
var ( var (
@ -352,32 +338,31 @@ func dummyInfoRefs(ctx *context.Context) {
_, _ = ctx.Write(infoRefsCache) _, _ = ctx.Write(infoRefsCache)
} }
type serviceConfig struct {
UploadPack bool
ReceivePack bool
Env []string
}
type serviceHandler struct { type serviceHandler struct {
cfg *serviceConfig repo *repo_model.Repository
w http.ResponseWriter isWiki bool
r *http.Request
dir string
environ []string environ []string
} }
func (h *serviceHandler) setHeaderNoCache() { func (h *serviceHandler) getRepoDir() string {
h.w.Header().Set("Expires", "Fri, 01 Jan 1980 00:00:00 GMT") if h.isWiki {
h.w.Header().Set("Pragma", "no-cache") return h.repo.WikiPath()
h.w.Header().Set("Cache-Control", "no-cache, max-age=0, must-revalidate") }
return h.repo.RepoPath()
} }
func (h *serviceHandler) setHeaderCacheForever() { func setHeaderNoCache(ctx *context.Context) {
ctx.Resp.Header().Set("Expires", "Fri, 01 Jan 1980 00:00:00 GMT")
ctx.Resp.Header().Set("Pragma", "no-cache")
ctx.Resp.Header().Set("Cache-Control", "no-cache, max-age=0, must-revalidate")
}
func setHeaderCacheForever(ctx *context.Context) {
now := time.Now().Unix() now := time.Now().Unix()
expires := now + 31536000 expires := now + 31536000
h.w.Header().Set("Date", fmt.Sprintf("%d", now)) ctx.Resp.Header().Set("Date", fmt.Sprintf("%d", now))
h.w.Header().Set("Expires", fmt.Sprintf("%d", expires)) ctx.Resp.Header().Set("Expires", fmt.Sprintf("%d", expires))
h.w.Header().Set("Cache-Control", "public, max-age=31536000") ctx.Resp.Header().Set("Cache-Control", "public, max-age=31536000")
} }
func containsParentDirectorySeparator(v string) bool { func containsParentDirectorySeparator(v string) bool {
@ -394,71 +379,71 @@ func containsParentDirectorySeparator(v string) bool {
func isSlashRune(r rune) bool { return r == '/' || r == '\\' } func isSlashRune(r rune) bool { return r == '/' || r == '\\' }
func (h *serviceHandler) sendFile(contentType, file string) { func (h *serviceHandler) sendFile(ctx *context.Context, contentType, file string) {
if containsParentDirectorySeparator(file) { if containsParentDirectorySeparator(file) {
log.Error("request file path contains invalid path: %v", file) log.Error("request file path contains invalid path: %v", file)
h.w.WriteHeader(http.StatusBadRequest) ctx.Resp.WriteHeader(http.StatusBadRequest)
return return
} }
reqFile := path.Join(h.dir, file) reqFile := filepath.Join(h.getRepoDir(), file)
fi, err := os.Stat(reqFile) fi, err := os.Stat(reqFile)
if os.IsNotExist(err) { if os.IsNotExist(err) {
h.w.WriteHeader(http.StatusNotFound) ctx.Resp.WriteHeader(http.StatusNotFound)
return return
} }
h.w.Header().Set("Content-Type", contentType) ctx.Resp.Header().Set("Content-Type", contentType)
h.w.Header().Set("Content-Length", fmt.Sprintf("%d", fi.Size())) ctx.Resp.Header().Set("Content-Length", fmt.Sprintf("%d", fi.Size()))
h.w.Header().Set("Last-Modified", fi.ModTime().Format(http.TimeFormat)) ctx.Resp.Header().Set("Last-Modified", fi.ModTime().Format(http.TimeFormat))
http.ServeFile(h.w, h.r, reqFile) http.ServeFile(ctx.Resp, ctx.Req, reqFile)
} }
// one or more key=value pairs separated by colons // one or more key=value pairs separated by colons
var safeGitProtocolHeader = regexp.MustCompile(`^[0-9a-zA-Z]+=[0-9a-zA-Z]+(:[0-9a-zA-Z]+=[0-9a-zA-Z]+)*$`) var safeGitProtocolHeader = regexp.MustCompile(`^[0-9a-zA-Z]+=[0-9a-zA-Z]+(:[0-9a-zA-Z]+=[0-9a-zA-Z]+)*$`)
func prepareGitCmdWithAllowedService(service string, h *serviceHandler) (*git.Command, error) { func prepareGitCmdWithAllowedService(ctx *context.Context, service string) (*git.Command, error) {
if service == "receive-pack" && h.cfg.ReceivePack { if service == "receive-pack" {
return git.NewCommand(h.r.Context(), "receive-pack"), nil return git.NewCommand(ctx, "receive-pack"), nil
} }
if service == "upload-pack" && h.cfg.UploadPack { if service == "upload-pack" {
return git.NewCommand(h.r.Context(), "upload-pack"), nil return git.NewCommand(ctx, "upload-pack"), nil
} }
return nil, fmt.Errorf("service %q is not allowed", service) return nil, fmt.Errorf("service %q is not allowed", service)
} }
func serviceRPC(h *serviceHandler, service string) { func serviceRPC(ctx *context.Context, h *serviceHandler, service string) {
defer func() { defer func() {
if err := h.r.Body.Close(); err != nil { if err := ctx.Req.Body.Close(); err != nil {
log.Error("serviceRPC: Close: %v", err) log.Error("serviceRPC: Close: %v", err)
} }
}() }()
expectedContentType := fmt.Sprintf("application/x-git-%s-request", service) expectedContentType := fmt.Sprintf("application/x-git-%s-request", service)
if h.r.Header.Get("Content-Type") != expectedContentType { if ctx.Req.Header.Get("Content-Type") != expectedContentType {
log.Error("Content-Type (%q) doesn't match expected: %q", h.r.Header.Get("Content-Type"), expectedContentType) log.Error("Content-Type (%q) doesn't match expected: %q", ctx.Req.Header.Get("Content-Type"), expectedContentType)
h.w.WriteHeader(http.StatusUnauthorized) ctx.Resp.WriteHeader(http.StatusUnauthorized)
return return
} }
cmd, err := prepareGitCmdWithAllowedService(service, h) cmd, err := prepareGitCmdWithAllowedService(ctx, service)
if err != nil { if err != nil {
log.Error("Failed to prepareGitCmdWithService: %v", err) log.Error("Failed to prepareGitCmdWithService: %v", err)
h.w.WriteHeader(http.StatusUnauthorized) ctx.Resp.WriteHeader(http.StatusUnauthorized)
return return
} }
h.w.Header().Set("Content-Type", fmt.Sprintf("application/x-git-%s-result", service)) ctx.Resp.Header().Set("Content-Type", fmt.Sprintf("application/x-git-%s-result", service))
reqBody := h.r.Body reqBody := ctx.Req.Body
// Handle GZIP. // Handle GZIP.
if h.r.Header.Get("Content-Encoding") == "gzip" { if ctx.Req.Header.Get("Content-Encoding") == "gzip" {
reqBody, err = gzip.NewReader(reqBody) reqBody, err = gzip.NewReader(reqBody)
if err != nil { if err != nil {
log.Error("Fail to create gzip reader: %v", err) log.Error("Fail to create gzip reader: %v", err)
h.w.WriteHeader(http.StatusInternalServerError) ctx.Resp.WriteHeader(http.StatusInternalServerError)
return return
} }
} }
@ -466,23 +451,23 @@ func serviceRPC(h *serviceHandler, service string) {
// set this for allow pre-receive and post-receive execute // set this for allow pre-receive and post-receive execute
h.environ = append(h.environ, "SSH_ORIGINAL_COMMAND="+service) h.environ = append(h.environ, "SSH_ORIGINAL_COMMAND="+service)
if protocol := h.r.Header.Get("Git-Protocol"); protocol != "" && safeGitProtocolHeader.MatchString(protocol) { if protocol := ctx.Req.Header.Get("Git-Protocol"); protocol != "" && safeGitProtocolHeader.MatchString(protocol) {
h.environ = append(h.environ, "GIT_PROTOCOL="+protocol) h.environ = append(h.environ, "GIT_PROTOCOL="+protocol)
} }
var stderr bytes.Buffer var stderr bytes.Buffer
cmd.AddArguments("--stateless-rpc").AddDynamicArguments(h.dir) cmd.AddArguments("--stateless-rpc").AddDynamicArguments(h.getRepoDir())
cmd.SetDescription(fmt.Sprintf("%s %s %s [repo_path: %s]", git.GitExecutable, service, "--stateless-rpc", h.dir)) cmd.SetDescription(fmt.Sprintf("%s %s %s [repo_path: %s]", git.GitExecutable, service, "--stateless-rpc", h.getRepoDir()))
if err := cmd.Run(&git.RunOpts{ if err := cmd.Run(&git.RunOpts{
Dir: h.dir, Dir: h.getRepoDir(),
Env: append(os.Environ(), h.environ...), Env: append(os.Environ(), h.environ...),
Stdout: h.w, Stdout: ctx.Resp,
Stdin: reqBody, Stdin: reqBody,
Stderr: &stderr, Stderr: &stderr,
UseContextTimeout: true, UseContextTimeout: true,
}); err != nil { }); err != nil {
if err.Error() != "signal: killed" { if err.Error() != "signal: killed" {
log.Error("Fail to serve RPC(%s) in %s: %v - %s", service, h.dir, err, stderr.String()) log.Error("Fail to serve RPC(%s) in %s: %v - %s", service, h.getRepoDir(), err, stderr.String())
} }
return return
} }
@ -492,7 +477,7 @@ func serviceRPC(h *serviceHandler, service string) {
func ServiceUploadPack(ctx *context.Context) { func ServiceUploadPack(ctx *context.Context) {
h := httpBase(ctx) h := httpBase(ctx)
if h != nil { if h != nil {
serviceRPC(h, "upload-pack") serviceRPC(ctx, h, "upload-pack")
} }
} }
@ -500,12 +485,12 @@ func ServiceUploadPack(ctx *context.Context) {
func ServiceReceivePack(ctx *context.Context) { func ServiceReceivePack(ctx *context.Context) {
h := httpBase(ctx) h := httpBase(ctx)
if h != nil { if h != nil {
serviceRPC(h, "receive-pack") serviceRPC(ctx, h, "receive-pack")
} }
} }
func getServiceType(r *http.Request) string { func getServiceType(ctx *context.Context) string {
serviceType := r.FormValue("service") serviceType := ctx.Req.FormValue("service")
if !strings.HasPrefix(serviceType, "git-") { if !strings.HasPrefix(serviceType, "git-") {
return "" return ""
} }
@ -534,28 +519,28 @@ func GetInfoRefs(ctx *context.Context) {
if h == nil { if h == nil {
return return
} }
h.setHeaderNoCache() setHeaderNoCache(ctx)
service := getServiceType(h.r) service := getServiceType(ctx)
cmd, err := prepareGitCmdWithAllowedService(service, h) cmd, err := prepareGitCmdWithAllowedService(ctx, service)
if err == nil { if err == nil {
if protocol := h.r.Header.Get("Git-Protocol"); protocol != "" && safeGitProtocolHeader.MatchString(protocol) { if protocol := ctx.Req.Header.Get("Git-Protocol"); protocol != "" && safeGitProtocolHeader.MatchString(protocol) {
h.environ = append(h.environ, "GIT_PROTOCOL="+protocol) h.environ = append(h.environ, "GIT_PROTOCOL="+protocol)
} }
h.environ = append(os.Environ(), h.environ...) h.environ = append(os.Environ(), h.environ...)
refs, _, err := cmd.AddArguments("--stateless-rpc", "--advertise-refs", ".").RunStdBytes(&git.RunOpts{Env: h.environ, Dir: h.dir}) refs, _, err := cmd.AddArguments("--stateless-rpc", "--advertise-refs", ".").RunStdBytes(&git.RunOpts{Env: h.environ, Dir: h.getRepoDir()})
if err != nil { if err != nil {
log.Error(fmt.Sprintf("%v - %s", err, string(refs))) log.Error(fmt.Sprintf("%v - %s", err, string(refs)))
} }
h.w.Header().Set("Content-Type", fmt.Sprintf("application/x-git-%s-advertisement", service)) ctx.Resp.Header().Set("Content-Type", fmt.Sprintf("application/x-git-%s-advertisement", service))
h.w.WriteHeader(http.StatusOK) ctx.Resp.WriteHeader(http.StatusOK)
_, _ = h.w.Write(packetWrite("# service=git-" + service + "\n")) _, _ = ctx.Resp.Write(packetWrite("# service=git-" + service + "\n"))
_, _ = h.w.Write([]byte("0000")) _, _ = ctx.Resp.Write([]byte("0000"))
_, _ = h.w.Write(refs) _, _ = ctx.Resp.Write(refs)
} else { } else {
updateServerInfo(ctx, h.dir) updateServerInfo(ctx, h.getRepoDir())
h.sendFile("text/plain; charset=utf-8", "info/refs") h.sendFile(ctx, "text/plain; charset=utf-8", "info/refs")
} }
} }
@ -564,12 +549,12 @@ func GetTextFile(p string) func(*context.Context) {
return func(ctx *context.Context) { return func(ctx *context.Context) {
h := httpBase(ctx) h := httpBase(ctx)
if h != nil { if h != nil {
h.setHeaderNoCache() setHeaderNoCache(ctx)
file := ctx.Params("file") file := ctx.Params("file")
if file != "" { if file != "" {
h.sendFile("text/plain", "objects/info/"+file) h.sendFile(ctx, "text/plain", "objects/info/"+file)
} else { } else {
h.sendFile("text/plain", p) h.sendFile(ctx, "text/plain", p)
} }
} }
} }
@ -579,8 +564,8 @@ func GetTextFile(p string) func(*context.Context) {
func GetInfoPacks(ctx *context.Context) { func GetInfoPacks(ctx *context.Context) {
h := httpBase(ctx) h := httpBase(ctx)
if h != nil { if h != nil {
h.setHeaderCacheForever() setHeaderCacheForever(ctx)
h.sendFile("text/plain; charset=utf-8", "objects/info/packs") h.sendFile(ctx, "text/plain; charset=utf-8", "objects/info/packs")
} }
} }
@ -588,8 +573,8 @@ func GetInfoPacks(ctx *context.Context) {
func GetLooseObject(ctx *context.Context) { func GetLooseObject(ctx *context.Context) {
h := httpBase(ctx) h := httpBase(ctx)
if h != nil { if h != nil {
h.setHeaderCacheForever() setHeaderCacheForever(ctx)
h.sendFile("application/x-git-loose-object", fmt.Sprintf("objects/%s/%s", h.sendFile(ctx, "application/x-git-loose-object", fmt.Sprintf("objects/%s/%s",
ctx.Params("head"), ctx.Params("hash"))) ctx.Params("head"), ctx.Params("hash")))
} }
} }
@ -598,8 +583,8 @@ func GetLooseObject(ctx *context.Context) {
func GetPackFile(ctx *context.Context) { func GetPackFile(ctx *context.Context) {
h := httpBase(ctx) h := httpBase(ctx)
if h != nil { if h != nil {
h.setHeaderCacheForever() setHeaderCacheForever(ctx)
h.sendFile("application/x-git-packed-objects", "objects/pack/pack-"+ctx.Params("file")+".pack") h.sendFile(ctx, "application/x-git-packed-objects", "objects/pack/pack-"+ctx.Params("file")+".pack")
} }
} }
@ -607,7 +592,7 @@ func GetPackFile(ctx *context.Context) {
func GetIdxFile(ctx *context.Context) { func GetIdxFile(ctx *context.Context) {
h := httpBase(ctx) h := httpBase(ctx)
if h != nil { if h != nil {
h.setHeaderCacheForever() setHeaderCacheForever(ctx)
h.sendFile("application/x-git-packed-objects-toc", "objects/pack/pack-"+ctx.Params("file")+".idx") h.sendFile(ctx, "application/x-git-packed-objects-toc", "objects/pack/pack-"+ctx.Params("file")+".idx")
} }
} }