repo/http: clean code

This commit is contained in:
Unknwon 2016-06-01 04:19:01 -07:00
parent fb970b9d87
commit c041273dd3
4 changed files with 241 additions and 305 deletions

View File

@ -3,7 +3,7 @@ Gogs - Go Git Service [![Build Status](https://travis-ci.org/gogits/gogs.svg?bra
![](https://github.com/gogits/gogs/blob/master/public/img/gogs-large-resize.png?raw=true) ![](https://github.com/gogits/gogs/blob/master/public/img/gogs-large-resize.png?raw=true)
##### Current version: 0.9.29 ##### Current version: 0.9.30
| Web | UI | Preview | | Web | UI | Preview |
|:-------------:|:-------:|:-------:| |:-------------:|:-------:|:-------:|

View File

@ -17,7 +17,7 @@ import (
"github.com/gogits/gogs/modules/setting" "github.com/gogits/gogs/modules/setting"
) )
const APP_VER = "0.9.29.0530" const APP_VER = "0.9.30.0601"
func init() { func init() {
runtime.GOMAXPROCS(runtime.NumCPU()) runtime.GOMAXPROCS(runtime.NumCPU())

View File

@ -14,7 +14,6 @@ import (
"os" "os"
"os/exec" "os/exec"
"path" "path"
"path/filepath"
"regexp" "regexp"
"runtime" "runtime"
"strconv" "strconv"
@ -28,12 +27,6 @@ import (
"github.com/gogits/gogs/modules/setting" "github.com/gogits/gogs/modules/setting"
) )
func authRequired(ctx *context.Context) {
ctx.Resp.Header().Set("WWW-Authenticate", "Basic realm=\".\"")
ctx.Data["ErrorMsg"] = "no basic auth and digit auth"
ctx.Error(401)
}
func HTTP(ctx *context.Context) { func HTTP(ctx *context.Context) {
username := ctx.Params(":username") username := ctx.Params(":username")
reponame := strings.TrimSuffix(ctx.Params(":reponame"), ".git") reponame := strings.TrimSuffix(ctx.Params(":reponame"), ".git")
@ -59,9 +52,9 @@ func HTTP(ctx *context.Context) {
repoUser, err := models.GetUserByName(username) repoUser, err := models.GetUserByName(username)
if err != nil { if err != nil {
if models.IsErrUserNotExist(err) { if models.IsErrUserNotExist(err) {
ctx.Handle(404, "GetUserByName", nil) ctx.Handle(http.StatusNotFound, "GetUserByName", nil)
} else { } else {
ctx.Handle(500, "GetUserByName", err) ctx.Handle(http.StatusInternalServerError, "GetUserByName", err)
} }
return return
} }
@ -69,9 +62,9 @@ func HTTP(ctx *context.Context) {
repo, err := models.GetRepositoryByName(repoUser.Id, reponame) repo, err := models.GetRepositoryByName(repoUser.Id, reponame)
if err != nil { if err != nil {
if models.IsErrRepoNotExist(err) { if models.IsErrRepoNotExist(err) {
ctx.Handle(404, "GetRepositoryByName", nil) ctx.Handle(http.StatusNotFound, "GetRepositoryByName", nil)
} else { } else {
ctx.Handle(500, "GetRepositoryByName", err) ctx.Handle(http.StatusInternalServerError, "GetRepositoryByName", err)
} }
return return
} }
@ -89,7 +82,8 @@ func HTTP(ctx *context.Context) {
if askAuth { if askAuth {
authHead := ctx.Req.Header.Get("Authorization") authHead := ctx.Req.Header.Get("Authorization")
if len(authHead) == 0 { if len(authHead) == 0 {
authRequired(ctx) ctx.Resp.Header().Set("WWW-Authenticate", "Basic realm=\".\"")
ctx.Error(http.StatusUnauthorized)
return return
} }
@ -99,19 +93,19 @@ func HTTP(ctx *context.Context) {
// FIXME: middlewares/context.go did basic auth check already, // FIXME: middlewares/context.go did basic auth check already,
// maybe could use that one. // maybe could use that one.
if len(auths) != 2 || auths[0] != "Basic" { if len(auths) != 2 || auths[0] != "Basic" {
ctx.HandleText(401, "no basic auth and digit auth") ctx.HandleText(http.StatusUnauthorized, "no basic auth and digit auth")
return return
} }
authUsername, authPasswd, err = base.BasicAuthDecode(auths[1]) authUsername, authPasswd, err = base.BasicAuthDecode(auths[1])
if err != nil { if err != nil {
ctx.HandleText(401, "no basic auth and digit auth") ctx.HandleText(http.StatusUnauthorized, "no basic auth and digit auth")
return return
} }
authUser, err = models.UserSignIn(authUsername, authPasswd) authUser, err = models.UserSignIn(authUsername, authPasswd)
if err != nil { if err != nil {
if !models.IsErrUserNotExist(err) { if !models.IsErrUserNotExist(err) {
ctx.Handle(500, "UserSignIn error: %v", err) ctx.Handle(http.StatusInternalServerError, "UserSignIn error: %v", err)
return return
} }
@ -119,19 +113,19 @@ func HTTP(ctx *context.Context) {
token, err := models.GetAccessTokenBySHA(authUsername) token, err := models.GetAccessTokenBySHA(authUsername)
if err != nil { if err != nil {
if models.IsErrAccessTokenNotExist(err) { if models.IsErrAccessTokenNotExist(err) {
ctx.HandleText(401, "invalid token") ctx.HandleText(http.StatusUnauthorized, "invalid token")
} else { } else {
ctx.Handle(500, "GetAccessTokenBySha", err) ctx.Handle(http.StatusInternalServerError, "GetAccessTokenBySha", err)
} }
return return
} }
token.Updated = time.Now() token.Updated = time.Now()
if err = models.UpdateAccessToken(token); err != nil { if err = models.UpdateAccessToken(token); err != nil {
ctx.Handle(500, "UpdateAccessToken", err) ctx.Handle(http.StatusInternalServerError, "UpdateAccessToken", err)
} }
authUser, err = models.GetUserByID(token.UID) authUser, err = models.GetUserByID(token.UID)
if err != nil { if err != nil {
ctx.Handle(500, "GetUserByID", err) ctx.Handle(http.StatusInternalServerError, "GetUserByID", err)
return return
} }
} }
@ -144,26 +138,26 @@ func HTTP(ctx *context.Context) {
has, err := models.HasAccess(authUser, repo, tp) has, err := models.HasAccess(authUser, repo, tp)
if err != nil { if err != nil {
ctx.Handle(500, "HasAccess", err) ctx.Handle(http.StatusInternalServerError, "HasAccess", err)
return return
} else if !has { } else if !has {
if tp == models.ACCESS_MODE_READ { if tp == models.ACCESS_MODE_READ {
has, err = models.HasAccess(authUser, repo, models.ACCESS_MODE_WRITE) has, err = models.HasAccess(authUser, repo, models.ACCESS_MODE_WRITE)
if err != nil { if err != nil {
ctx.Handle(500, "HasAccess2", err) ctx.Handle(http.StatusInternalServerError, "HasAccess2", err)
return return
} else if !has { } else if !has {
ctx.HandleText(403, "User permission denied") ctx.HandleText(http.StatusForbidden, "User permission denied")
return return
} }
} else { } else {
ctx.HandleText(403, "User permission denied") ctx.HandleText(http.StatusForbidden, "User permission denied")
return return
} }
} }
if !isPull && repo.IsMirror { if !isPull && repo.IsMirror {
ctx.HandleText(403, "mirror repository is read-only") ctx.HandleText(http.StatusForbidden, "mirror repository is read-only")
return return
} }
} }
@ -194,6 +188,7 @@ func HTTP(ctx *context.Context) {
if idx > -1 { if idx > -1 {
line = line[:idx] line = line[:idx]
} }
fields := strings.Fields(string(line)) fields := strings.Fields(string(line))
if len(fields) >= 3 { if len(fields) >= 3 {
oldCommitId := fields[0][4:] oldCommitId := fields[0][4:]
@ -222,37 +217,62 @@ func HTTP(ctx *context.Context) {
} }
} }
HTTPBackend(ctx, &Config{ HTTPBackend(ctx, &serviceConfig{
RepoRootPath: setting.RepoRootPath, UploadPack: true,
GitBinPath: "git", ReceivePack: true,
UploadPack: true, OnSucceed: callback,
ReceivePack: true,
OnSucceed: callback,
})(ctx.Resp, ctx.Req.Request) })(ctx.Resp, ctx.Req.Request)
runtime.GC() runtime.GC()
} }
type Config struct { type serviceConfig struct {
RepoRootPath string UploadPack bool
GitBinPath string ReceivePack bool
UploadPack bool OnSucceed func(rpc string, input []byte)
ReceivePack bool
OnSucceed func(rpc string, input []byte)
} }
type handler struct { type serviceHandler struct {
*Config cfg *serviceConfig
w http.ResponseWriter w http.ResponseWriter
r *http.Request r *http.Request
Dir string dir string
File string file string
}
func (h *serviceHandler) setHeaderNoCache() {
h.w.Header().Set("Expires", "Fri, 01 Jan 1980 00:00:00 GMT")
h.w.Header().Set("Pragma", "no-cache")
h.w.Header().Set("Cache-Control", "no-cache, max-age=0, must-revalidate")
}
func (h *serviceHandler) setHeaderCacheForever() {
now := time.Now().Unix()
expires := now + 31536000
h.w.Header().Set("Date", fmt.Sprintf("%d", now))
h.w.Header().Set("Expires", fmt.Sprintf("%d", expires))
h.w.Header().Set("Cache-Control", "public, max-age=31536000")
}
func (h *serviceHandler) sendFile(contentType string) {
reqFile := path.Join(h.dir, h.file)
fi, err := os.Stat(reqFile)
if os.IsNotExist(err) {
h.w.WriteHeader(http.StatusNotFound)
return
}
h.w.Header().Set("Content-Type", contentType)
h.w.Header().Set("Content-Length", fmt.Sprintf("%d", fi.Size()))
h.w.Header().Set("Last-Modified", fi.ModTime().Format(http.TimeFormat))
http.ServeFile(h.w, h.r, reqFile)
} }
type route struct { type route struct {
cr *regexp.Regexp reg *regexp.Regexp
method string method string
handler func(handler) handler func(serviceHandler)
} }
var routes = []route{ var routes = []route{
@ -269,304 +289,220 @@ var routes = []route{
{regexp.MustCompile("(.*?)/objects/pack/pack-[0-9a-f]{40}\\.idx$"), "GET", getIdxFile}, {regexp.MustCompile("(.*?)/objects/pack/pack-[0-9a-f]{40}\\.idx$"), "GET", getIdxFile},
} }
func getGitDir(config *Config, fPath string) (string, error) { // FIXME: use process module
root := config.RepoRootPath func gitCommand(dir string, args ...string) []byte {
if len(root) == 0 { cmd := exec.Command("git", args...)
cwd, err := os.Getwd()
if err != nil {
log.GitLogger.Error(4, err.Error())
return "", err
}
root = cwd
}
if !strings.HasSuffix(fPath, ".git") {
fPath = fPath + ".git"
}
f := filepath.Join(root, fPath)
if _, err := os.Stat(f); os.IsNotExist(err) {
return "", err
}
return f, nil
}
// Request handling function
func HTTPBackend(ctx *context.Context, config *Config) http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
for _, route := range routes {
r.URL.Path = strings.ToLower(r.URL.Path) // blue: In case some repo name has upper case name
if m := route.cr.FindStringSubmatch(r.URL.Path); m != nil {
if route.method != r.Method {
renderMethodNotAllowed(w, r)
return
}
file := strings.Replace(r.URL.Path, m[1]+"/", "", 1)
dir, err := getGitDir(config, m[1])
if err != nil {
log.GitLogger.Error(4, err.Error())
ctx.Handle(404, "HTTPBackend", err)
return
}
route.handler(handler{config, w, r, dir, file})
return
}
}
ctx.Handle(404, "HTTPBackend", nil)
return
}
}
// Actual command handling functions
func serviceUploadPack(hr handler) {
serviceRpc("upload-pack", hr)
}
func serviceReceivePack(hr handler) {
serviceRpc("receive-pack", hr)
}
func serviceRpc(rpc string, hr handler) {
w, r, dir := hr.w, hr.r, hr.Dir
defer r.Body.Close()
if !hasAccess(r, hr.Config, dir, rpc, true) {
renderNoAccess(w)
return
}
w.Header().Set("Content-Type", fmt.Sprintf("application/x-git-%s-result", rpc))
var (
reqBody = r.Body
input []byte
br io.Reader
err error
)
// Handle GZIP.
if r.Header.Get("Content-Encoding") == "gzip" {
reqBody, err = gzip.NewReader(reqBody)
if err != nil {
log.GitLogger.Error(2, "fail to create gzip reader: %v", err)
w.WriteHeader(http.StatusInternalServerError)
return
}
}
if hr.Config.OnSucceed != nil {
input, err = ioutil.ReadAll(reqBody)
if err != nil {
log.GitLogger.Error(2, "fail to read request body: %v", err)
w.WriteHeader(http.StatusInternalServerError)
return
}
br = bytes.NewReader(input)
} else {
br = reqBody
}
args := []string{rpc, "--stateless-rpc", dir}
cmd := exec.Command(hr.Config.GitBinPath, args...)
cmd.Dir = dir cmd.Dir = dir
cmd.Stdout = w out, err := cmd.Output()
cmd.Stdin = br if err != nil {
log.GitLogger.Error(4, fmt.Sprintf("%v - %s", err, out))
if err := cmd.Run(); err != nil {
log.GitLogger.Error(2, "fail to serve RPC(%s): %v", rpc, err)
w.WriteHeader(http.StatusInternalServerError)
return
}
if hr.Config.OnSucceed != nil {
hr.Config.OnSucceed(rpc, input)
} }
return out
} }
func getInfoRefs(hr handler) { func getGitConfig(option, dir string) string {
w, r, dir := hr.w, hr.r, hr.Dir out := string(gitCommand(dir, "config", option))
serviceName := getServiceType(r) return out[0 : len(out)-1]
access := hasAccess(r, hr.Config, dir, serviceName, false)
if access {
args := []string{serviceName, "--stateless-rpc", "--advertise-refs", "."}
refs := gitCommand(hr.Config.GitBinPath, dir, args...)
hdrNocache(w)
w.Header().Set("Content-Type", fmt.Sprintf("application/x-git-%s-advertisement", serviceName))
w.WriteHeader(http.StatusOK)
w.Write(packetWrite("# service=git-" + serviceName + "\n"))
w.Write(packetFlush())
w.Write(refs)
} else {
updateServerInfo(hr.Config.GitBinPath, dir)
hdrNocache(w)
sendFile("text/plain; charset=utf-8", hr)
}
} }
func getInfoPacks(hr handler) { func getConfigSetting(service, dir string) bool {
hdrCacheForever(hr.w) service = strings.Replace(service, "-", "", -1)
sendFile("text/plain; charset=utf-8", hr) setting := getGitConfig("http."+service, dir)
}
func getLooseObject(hr handler) { if service == "uploadpack" {
hdrCacheForever(hr.w)
sendFile("application/x-git-loose-object", hr)
}
func getPackFile(hr handler) {
hdrCacheForever(hr.w)
sendFile("application/x-git-packed-objects", hr)
}
func getIdxFile(hr handler) {
hdrCacheForever(hr.w)
sendFile("application/x-git-packed-objects-toc", hr)
}
func getTextFile(hr handler) {
hdrNocache(hr.w)
sendFile("text/plain", hr)
}
// Logic helping functions
func sendFile(contentType string, hr handler) {
w, r := hr.w, hr.r
reqFile := path.Join(hr.Dir, hr.File)
f, err := os.Stat(reqFile)
if os.IsNotExist(err) {
renderNotFound(w)
return
}
w.Header().Set("Content-Type", contentType)
w.Header().Set("Content-Length", fmt.Sprintf("%d", f.Size()))
w.Header().Set("Last-Modified", f.ModTime().Format(http.TimeFormat))
http.ServeFile(w, r, reqFile)
}
func getServiceType(r *http.Request) string {
serviceType := r.FormValue("service")
if s := strings.HasPrefix(serviceType, "git-"); !s {
return ""
}
return strings.Replace(serviceType, "git-", "", 1)
}
func hasAccess(r *http.Request, config *Config, dir string, rpc string, checkContentType bool) bool {
if checkContentType {
if r.Header.Get("Content-Type") != fmt.Sprintf("application/x-git-%s-request", rpc) {
return false
}
}
if !(rpc == "upload-pack" || rpc == "receive-pack") {
return false
}
if rpc == "receive-pack" {
return config.ReceivePack
}
if rpc == "upload-pack" {
return config.UploadPack
}
return getConfigSetting(config.GitBinPath, rpc, dir)
}
func getConfigSetting(gitBinPath, serviceName string, dir string) bool {
serviceName = strings.Replace(serviceName, "-", "", -1)
setting := getGitConfig(gitBinPath, "http."+serviceName, dir)
if serviceName == "uploadpack" {
return setting != "false" return setting != "false"
} }
return setting == "true" return setting == "true"
} }
func getGitConfig(gitBinPath, configName string, dir string) string { func hasAccess(service string, h serviceHandler, checkContentType bool) bool {
args := []string{"config", configName} if checkContentType {
out := string(gitCommand(gitBinPath, dir, args...)) if h.r.Header.Get("Content-Type") != fmt.Sprintf("application/x-git-%s-request", service) {
return out[0 : len(out)-1] return false
} }
func updateServerInfo(gitBinPath, dir string) []byte {
args := []string{"update-server-info"}
return gitCommand(gitBinPath, dir, args...)
}
// FIXME: use process module
func gitCommand(gitBinPath, dir string, args ...string) []byte {
command := exec.Command(gitBinPath, args...)
command.Dir = dir
out, err := command.Output()
if err != nil {
log.GitLogger.Error(4, fmt.Sprintf("%v - %s", err, out))
} }
return out if !(service == "upload-pack" || service == "receive-pack") {
return false
}
if service == "receive-pack" {
return h.cfg.ReceivePack
}
if service == "upload-pack" {
return h.cfg.UploadPack
}
return getConfigSetting(service, h.dir)
} }
// HTTP error response handling functions func serviceRPC(h serviceHandler, service string) {
defer h.r.Body.Close()
func renderMethodNotAllowed(w http.ResponseWriter, r *http.Request) { if !hasAccess(service, h, true) {
if r.Proto == "HTTP/1.1" { h.w.WriteHeader(http.StatusUnauthorized)
w.WriteHeader(http.StatusMethodNotAllowed) return
w.Write([]byte("Method Not Allowed")) }
h.w.Header().Set("Content-Type", fmt.Sprintf("application/x-git-%s-result", service))
var (
reqBody = h.r.Body
input []byte
br io.Reader
err error
)
// Handle GZIP.
if h.r.Header.Get("Content-Encoding") == "gzip" {
reqBody, err = gzip.NewReader(reqBody)
if err != nil {
log.GitLogger.Error(2, "fail to create gzip reader: %v", err)
h.w.WriteHeader(http.StatusInternalServerError)
return
}
}
if h.cfg.OnSucceed != nil {
input, err = ioutil.ReadAll(reqBody)
if err != nil {
log.GitLogger.Error(2, "fail to read request body: %v", err)
h.w.WriteHeader(http.StatusInternalServerError)
return
}
br = bytes.NewReader(input)
} else { } else {
w.WriteHeader(http.StatusBadRequest) br = reqBody
w.Write([]byte("Bad Request")) }
cmd := exec.Command("git", service, "--stateless-rpc", h.dir)
cmd.Dir = h.dir
cmd.Stdout = h.w
cmd.Stdin = br
if err := cmd.Run(); err != nil {
log.GitLogger.Error(2, "fail to serve RPC(%s): %v", service, err)
h.w.WriteHeader(http.StatusInternalServerError)
return
}
if h.cfg.OnSucceed != nil {
h.cfg.OnSucceed(service, input)
} }
} }
func renderNotFound(w http.ResponseWriter) { func serviceUploadPack(h serviceHandler) {
w.WriteHeader(http.StatusNotFound) serviceRPC(h, "upload-pack")
w.Write([]byte("Not Found"))
} }
func renderNoAccess(w http.ResponseWriter) { func serviceReceivePack(h serviceHandler) {
w.WriteHeader(http.StatusForbidden) serviceRPC(h, "receive-pack")
w.Write([]byte("Forbidden"))
} }
// Packet-line handling function func getServiceType(r *http.Request) string {
serviceType := r.FormValue("service")
if !strings.HasPrefix(serviceType, "git-") {
return ""
}
return strings.Replace(serviceType, "git-", "", 1)
}
func packetFlush() []byte { func updateServerInfo(dir string) []byte {
return []byte("0000") return gitCommand(dir, "update-server-info")
} }
func packetWrite(str string) []byte { func packetWrite(str string) []byte {
s := strconv.FormatInt(int64(len(str)+4), 16) s := strconv.FormatInt(int64(len(str)+4), 16)
if len(s)%4 != 0 { if len(s)%4 != 0 {
s = strings.Repeat("0", 4-len(s)%4) + s s = strings.Repeat("0", 4-len(s)%4) + s
} }
return []byte(s + str) return []byte(s + str)
} }
// Header writing functions func getInfoRefs(h serviceHandler) {
h.setHeaderNoCache()
if hasAccess(getServiceType(h.r), h, false) {
service := getServiceType(h.r)
refs := gitCommand(h.dir, service, "--stateless-rpc", "--advertise-refs", ".")
func hdrNocache(w http.ResponseWriter) { h.w.Header().Set("Content-Type", fmt.Sprintf("application/x-git-%s-advertisement", service))
w.Header().Set("Expires", "Fri, 01 Jan 1980 00:00:00 GMT") h.w.WriteHeader(http.StatusOK)
w.Header().Set("Pragma", "no-cache") h.w.Write(packetWrite("# service=git-" + service + "\n"))
w.Header().Set("Cache-Control", "no-cache, max-age=0, must-revalidate") h.w.Write([]byte("0000"))
h.w.Write(refs)
} else {
updateServerInfo(h.dir)
h.sendFile("text/plain; charset=utf-8")
}
} }
func hdrCacheForever(w http.ResponseWriter) { func getTextFile(h serviceHandler) {
now := time.Now().Unix() h.setHeaderNoCache()
expires := now + 31536000 h.sendFile("text/plain")
w.Header().Set("Date", fmt.Sprintf("%d", now)) }
w.Header().Set("Expires", fmt.Sprintf("%d", expires))
w.Header().Set("Cache-Control", "public, max-age=31536000") func getInfoPacks(h serviceHandler) {
h.setHeaderCacheForever()
h.sendFile("text/plain; charset=utf-8")
}
func getLooseObject(h serviceHandler) {
h.setHeaderCacheForever()
h.sendFile("application/x-git-loose-object")
}
func getPackFile(h serviceHandler) {
h.setHeaderCacheForever()
h.sendFile("application/x-git-packed-objects")
}
func getIdxFile(h serviceHandler) {
h.setHeaderCacheForever()
h.sendFile("application/x-git-packed-objects-toc")
}
func getGitRepoPath(subdir string) (string, error) {
if !strings.HasSuffix(subdir, ".git") {
subdir += ".git"
}
fpath := path.Join(setting.RepoRootPath, subdir)
if _, err := os.Stat(fpath); os.IsNotExist(err) {
return "", err
}
return fpath, nil
}
func HTTPBackend(ctx *context.Context, cfg *serviceConfig) http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
for _, route := range routes {
r.URL.Path = strings.ToLower(r.URL.Path) // blue: In case some repo name has upper case name
if m := route.reg.FindStringSubmatch(r.URL.Path); m != nil {
if route.method != r.Method {
if r.Proto == "HTTP/1.1" {
w.WriteHeader(http.StatusMethodNotAllowed)
w.Write([]byte("Method Not Allowed"))
} else {
w.WriteHeader(http.StatusBadRequest)
w.Write([]byte("Bad Request"))
}
return
}
file := strings.Replace(r.URL.Path, m[1]+"/", "", 1)
dir, err := getGitRepoPath(m[1])
if err != nil {
log.GitLogger.Error(4, err.Error())
ctx.Handle(http.StatusNotFound, "HTTPBackend", err)
return
}
route.handler(serviceHandler{cfg, w, r, dir, file})
return
}
}
ctx.Handle(http.StatusNotFound, "HTTPBackend", nil)
return
}
} }

View File

@ -1 +1 @@
0.9.29.0530 0.9.30.0601