Return go-get info on subdirs (#15642)
This PR is an alternative to #15628 and makes the go get handler a handler. Fix #15625 Close #15628 Signed-off-by: Andrew Thornton <art27@cantab.net>
This commit is contained in:
parent
4a84022d25
commit
038e1db4df
3 changed files with 123 additions and 65 deletions
35
integrations/goget_test.go
Normal file
35
integrations/goget_test.go
Normal file
|
@ -0,0 +1,35 @@
|
||||||
|
// Copyright 2021 The Gitea Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a MIT-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package integrations
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"net/http"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"code.gitea.io/gitea/modules/setting"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestGoGet(t *testing.T) {
|
||||||
|
defer prepareTestEnv(t)()
|
||||||
|
|
||||||
|
req := NewRequest(t, "GET", "/blah/glah/plah?go-get=1")
|
||||||
|
resp := MakeRequest(t, req, http.StatusOK)
|
||||||
|
|
||||||
|
expected := fmt.Sprintf(`<!doctype html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta name="go-import" content="%[1]s:%[2]s/blah/glah git %[3]sblah/glah.git">
|
||||||
|
<meta name="go-source" content="%[1]s:%[2]s/blah/glah _ %[3]sblah/glah/src/branch/master{/dir} %[3]sblah/glah/src/branch/master{/dir}/{file}#L{line}">
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
go get --insecure %[1]s:%[2]s/blah/glah
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
`, setting.Domain, setting.HTTPPort, setting.AppURL)
|
||||||
|
|
||||||
|
assert.Equal(t, expected, resp.Body.String())
|
||||||
|
}
|
86
routers/routes/goget.go
Normal file
86
routers/routes/goget.go
Normal file
|
@ -0,0 +1,86 @@
|
||||||
|
// Copyright 2021 The Gitea Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a MIT-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package routes
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/http"
|
||||||
|
"net/url"
|
||||||
|
"path"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"code.gitea.io/gitea/models"
|
||||||
|
"code.gitea.io/gitea/modules/context"
|
||||||
|
"code.gitea.io/gitea/modules/setting"
|
||||||
|
"code.gitea.io/gitea/modules/util"
|
||||||
|
"github.com/unknwon/com"
|
||||||
|
)
|
||||||
|
|
||||||
|
func goGet(ctx *context.Context) {
|
||||||
|
if ctx.Req.Method != "GET" || ctx.Query("go-get") != "1" || len(ctx.Req.URL.Query()) > 1 {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
parts := strings.SplitN(ctx.Req.URL.EscapedPath(), "/", 4)
|
||||||
|
|
||||||
|
if len(parts) < 3 {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
ownerName := parts[1]
|
||||||
|
repoName := parts[2]
|
||||||
|
|
||||||
|
// Quick responses appropriate go-get meta with status 200
|
||||||
|
// regardless of if user have access to the repository,
|
||||||
|
// or the repository does not exist at all.
|
||||||
|
// This is particular a workaround for "go get" command which does not respect
|
||||||
|
// .netrc file.
|
||||||
|
|
||||||
|
trimmedRepoName := strings.TrimSuffix(repoName, ".git")
|
||||||
|
|
||||||
|
if ownerName == "" || trimmedRepoName == "" {
|
||||||
|
_, _ = ctx.Write([]byte(`<!doctype html>
|
||||||
|
<html>
|
||||||
|
<body>
|
||||||
|
invalid import path
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
`))
|
||||||
|
ctx.Status(400)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
branchName := setting.Repository.DefaultBranch
|
||||||
|
|
||||||
|
repo, err := models.GetRepositoryByOwnerAndName(ownerName, repoName)
|
||||||
|
if err == nil && len(repo.DefaultBranch) > 0 {
|
||||||
|
branchName = repo.DefaultBranch
|
||||||
|
}
|
||||||
|
prefix := setting.AppURL + path.Join(url.PathEscape(ownerName), url.PathEscape(repoName), "src", "branch", util.PathEscapeSegments(branchName))
|
||||||
|
|
||||||
|
appURL, _ := url.Parse(setting.AppURL)
|
||||||
|
|
||||||
|
insecure := ""
|
||||||
|
if appURL.Scheme == string(setting.HTTP) {
|
||||||
|
insecure = "--insecure "
|
||||||
|
}
|
||||||
|
ctx.Header().Set("Content-Type", "text/html")
|
||||||
|
ctx.Status(http.StatusOK)
|
||||||
|
_, _ = ctx.Write([]byte(com.Expand(`<!doctype html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta name="go-import" content="{GoGetImport} git {CloneLink}">
|
||||||
|
<meta name="go-source" content="{GoGetImport} _ {GoDocDirectory} {GoDocFile}">
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
go get {Insecure}{GoGetImport}
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
`, map[string]string{
|
||||||
|
"GoGetImport": context.ComposeGoGetImport(ownerName, trimmedRepoName),
|
||||||
|
"CloneLink": models.ComposeHTTPSCloneURL(ownerName, repoName),
|
||||||
|
"GoDocDirectory": prefix + "{/dir}",
|
||||||
|
"GoDocFile": prefix + "{/dir}/{file}#L{line}",
|
||||||
|
"Insecure": insecure,
|
||||||
|
})))
|
||||||
|
}
|
|
@ -8,7 +8,6 @@ import (
|
||||||
"encoding/gob"
|
"encoding/gob"
|
||||||
"fmt"
|
"fmt"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/url"
|
|
||||||
"os"
|
"os"
|
||||||
"path"
|
"path"
|
||||||
"strings"
|
"strings"
|
||||||
|
@ -22,7 +21,6 @@ import (
|
||||||
"code.gitea.io/gitea/modules/setting"
|
"code.gitea.io/gitea/modules/setting"
|
||||||
"code.gitea.io/gitea/modules/storage"
|
"code.gitea.io/gitea/modules/storage"
|
||||||
"code.gitea.io/gitea/modules/templates"
|
"code.gitea.io/gitea/modules/templates"
|
||||||
"code.gitea.io/gitea/modules/util"
|
|
||||||
"code.gitea.io/gitea/modules/validation"
|
"code.gitea.io/gitea/modules/validation"
|
||||||
"code.gitea.io/gitea/modules/web"
|
"code.gitea.io/gitea/modules/web"
|
||||||
"code.gitea.io/gitea/routers"
|
"code.gitea.io/gitea/routers"
|
||||||
|
@ -51,7 +49,6 @@ import (
|
||||||
"github.com/go-chi/cors"
|
"github.com/go-chi/cors"
|
||||||
"github.com/prometheus/client_golang/prometheus"
|
"github.com/prometheus/client_golang/prometheus"
|
||||||
"github.com/tstranex/u2f"
|
"github.com/tstranex/u2f"
|
||||||
"github.com/unknwon/com"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
|
@ -228,6 +225,7 @@ func WebRoutes() *web.Route {
|
||||||
// TODO: These really seem like things that could be folded into Contexter or as helper functions
|
// TODO: These really seem like things that could be folded into Contexter or as helper functions
|
||||||
common = append(common, user.GetNotificationCount)
|
common = append(common, user.GetNotificationCount)
|
||||||
common = append(common, repo.GetActiveStopwatch)
|
common = append(common, repo.GetActiveStopwatch)
|
||||||
|
common = append(common, goGet)
|
||||||
|
|
||||||
others := web.NewRoute()
|
others := web.NewRoute()
|
||||||
for _, middle := range common {
|
for _, middle := range common {
|
||||||
|
@ -239,67 +237,6 @@ func WebRoutes() *web.Route {
|
||||||
return routes
|
return routes
|
||||||
}
|
}
|
||||||
|
|
||||||
func goGet(ctx *context.Context) {
|
|
||||||
if ctx.Query("go-get") != "1" {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// Quick responses appropriate go-get meta with status 200
|
|
||||||
// regardless of if user have access to the repository,
|
|
||||||
// or the repository does not exist at all.
|
|
||||||
// This is particular a workaround for "go get" command which does not respect
|
|
||||||
// .netrc file.
|
|
||||||
|
|
||||||
ownerName := ctx.Params(":username")
|
|
||||||
repoName := ctx.Params(":reponame")
|
|
||||||
trimmedRepoName := strings.TrimSuffix(repoName, ".git")
|
|
||||||
|
|
||||||
if ownerName == "" || trimmedRepoName == "" {
|
|
||||||
_, _ = ctx.Write([]byte(`<!doctype html>
|
|
||||||
<html>
|
|
||||||
<body>
|
|
||||||
invalid import path
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
`))
|
|
||||||
ctx.Status(400)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
branchName := setting.Repository.DefaultBranch
|
|
||||||
|
|
||||||
repo, err := models.GetRepositoryByOwnerAndName(ownerName, repoName)
|
|
||||||
if err == nil && len(repo.DefaultBranch) > 0 {
|
|
||||||
branchName = repo.DefaultBranch
|
|
||||||
}
|
|
||||||
prefix := setting.AppURL + path.Join(url.PathEscape(ownerName), url.PathEscape(repoName), "src", "branch", util.PathEscapeSegments(branchName))
|
|
||||||
|
|
||||||
appURL, _ := url.Parse(setting.AppURL)
|
|
||||||
|
|
||||||
insecure := ""
|
|
||||||
if appURL.Scheme == string(setting.HTTP) {
|
|
||||||
insecure = "--insecure "
|
|
||||||
}
|
|
||||||
ctx.Header().Set("Content-Type", "text/html")
|
|
||||||
ctx.Status(http.StatusOK)
|
|
||||||
_, _ = ctx.Write([]byte(com.Expand(`<!doctype html>
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta name="go-import" content="{GoGetImport} git {CloneLink}">
|
|
||||||
<meta name="go-source" content="{GoGetImport} _ {GoDocDirectory} {GoDocFile}">
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
go get {Insecure}{GoGetImport}
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
`, map[string]string{
|
|
||||||
"GoGetImport": context.ComposeGoGetImport(ownerName, trimmedRepoName),
|
|
||||||
"CloneLink": models.ComposeHTTPSCloneURL(ownerName, repoName),
|
|
||||||
"GoDocDirectory": prefix + "{/dir}",
|
|
||||||
"GoDocFile": prefix + "{/dir}/{file}#L{line}",
|
|
||||||
"Insecure": insecure,
|
|
||||||
})))
|
|
||||||
}
|
|
||||||
|
|
||||||
// RegisterRoutes register routes
|
// RegisterRoutes register routes
|
||||||
func RegisterRoutes(m *web.Route) {
|
func RegisterRoutes(m *web.Route) {
|
||||||
reqSignIn := context.Toggle(&context.ToggleOptions{SignInRequired: true})
|
reqSignIn := context.Toggle(&context.ToggleOptions{SignInRequired: true})
|
||||||
|
@ -1104,7 +1041,7 @@ func RegisterRoutes(m *web.Route) {
|
||||||
m.Group("/{username}", func() {
|
m.Group("/{username}", func() {
|
||||||
m.Group("/{reponame}", func() {
|
m.Group("/{reponame}", func() {
|
||||||
m.Get("", repo.SetEditorconfigIfExists, repo.Home)
|
m.Get("", repo.SetEditorconfigIfExists, repo.Home)
|
||||||
}, goGet, ignSignIn, context.RepoAssignment, context.RepoRef(), context.UnitTypes())
|
}, ignSignIn, context.RepoAssignment, context.RepoRef(), context.UnitTypes())
|
||||||
|
|
||||||
m.Group("/{reponame}", func() {
|
m.Group("/{reponame}", func() {
|
||||||
m.Group("/info/lfs", func() {
|
m.Group("/info/lfs", func() {
|
||||||
|
|
Loading…
Reference in a new issue