lint

Author: wxiaoguang

models/repo/avatar.go

@@ -84,7 +84,7 @@ func (repo *Repository) relAvatarLink(ctx context.Context) string {
 	return setting.AppSubURL + "/repo-avatars/" + url.PathEscape(repo.Avatar)
 }
 
-// AvatarLink returns a link to the repository's avatar.
+// AvatarLink returns the full avatar url with http host. TODO: refactor it to a relative URL, but it is still used in API response at the moment
 func (repo *Repository) AvatarLink(ctx context.Context) string {
 	return httplib.MakeAbsoluteURL(ctx, repo.relAvatarLink(ctx))
 }

models/user/avatar.go

@@ -89,7 +89,7 @@ func (u *User) AvatarLinkWithSize(ctx context.Context, size int) string {
 	return avatars.GenerateEmailAvatarFastLink(ctx, u.AvatarEmail, size)
 }
 
-// AvatarLink returns the full avatar link with http host
+// AvatarLink returns the full avatar url with http host. TODO: refactor it to a relative URL, but it is still used in API response at the moment
 func (u *User) AvatarLink(ctx context.Context) string {
 	return httplib.MakeAbsoluteURL(ctx, u.AvatarLinkWithSize(ctx, 0))
 }

modules/httplib/url.go

@@ -13,9 +13,9 @@ import (
 	"code.gitea.io/gitea/modules/util"
 )
 
-type httpRequestContextKeyStruct struct{}
+type RequestContextKeyStruct struct{}
 
-var HttpRequestContextKey = httpRequestContextKeyStruct{}
+var RequestContextKey = RequestContextKeyStruct{}
 
 func urlIsRelative(s string, u *url.URL) bool {
 	// Unfortunately browsers consider a redirect Location with preceding "//", "\\", "/\" and "\/" as meaning redirect to "http(s)://REST_OF_PATH"
@@ -32,7 +32,7 @@ func IsRelativeURL(s string) bool {
 	return err == nil && urlIsRelative(s, u)
 }
 
-func guessHttpRequestScheme(req *http.Request) string {
+func guessRequestScheme(req *http.Request) string {
 	// https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Proto
 	if s := req.Header.Get("X-Forwarded-Proto"); s != "" {
 		return s
@@ -55,7 +55,7 @@ func guessHttpRequestScheme(req *http.Request) string {
 	return "http"
 }
 
-func guessHttpRequestHost(req *http.Request) string {
+func guessRequestHost(req *http.Request) string {
 	// https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host
 	if s := req.Header.Get("X-Forwarded-Host"); s != "" {
 		return s
@@ -68,12 +68,12 @@ func guessHttpRequestHost(req *http.Request) string {
 
 // GuessCurrentAppURL tries to guess the current full URL by http headers. It always has a '/' suffix, exactly the same as setting.AppURL
 func GuessCurrentAppURL(ctx context.Context) string {
-	req, ok := ctx.Value(HttpRequestContextKey).(*http.Request)
+	req, ok := ctx.Value(RequestContextKey).(*http.Request)
 	if !ok {
 		return setting.AppURL
 	}
-	if host := guessHttpRequestHost(req); host != "" {
-		return guessHttpRequestScheme(req) + "://" + host + setting.AppSubURL + "/"
+	if host := guessRequestHost(req); host != "" {
+		return guessRequestScheme(req) + "://" + host + setting.AppSubURL + "/"
 	}
 	return setting.AppURL
 }

modules/httplib/url_test.go

@@ -49,20 +49,20 @@ func TestMakeAbsoluteURL(t *testing.T) {
 	assert.Equal(t, "http://the-host/sub/foo", MakeAbsoluteURL(ctx, "/foo"))
 	assert.Equal(t, "http://other/foo", MakeAbsoluteURL(ctx, "http://other/foo"))
 
-	ctx = context.WithValue(ctx, HttpRequestContextKey, &http.Request{
+	ctx = context.WithValue(ctx, RequestContextKey, &http.Request{
 		Host: "user-host",
 	})
 	assert.Equal(t, "http://user-host/sub/foo", MakeAbsoluteURL(ctx, "/foo"))
 
-	ctx = context.WithValue(ctx, HttpRequestContextKey, &http.Request{
+	ctx = context.WithValue(ctx, RequestContextKey, &http.Request{
 		Host: "user-host",
 		Header: map[string][]string{
 			"X-Forwarded-Host": {"forwarded-host"},
 		},
 	})
 	assert.Equal(t, "http://forwarded-host/sub/foo", MakeAbsoluteURL(ctx, "/foo"))
 
-	ctx = context.WithValue(ctx, HttpRequestContextKey, &http.Request{
+	ctx = context.WithValue(ctx, RequestContextKey, &http.Request{
 		Host: "user-host",
 		Header: map[string][]string{
 			"X-Forwarded-Host":  {"forwarded-host"},
@@ -110,7 +110,7 @@ func TestIsCurrentGiteaSiteURL(t *testing.T) {
 	assert.False(t, IsCurrentGiteaSiteURL(ctx, "http://localhost"))
 	assert.True(t, IsCurrentGiteaSiteURL(ctx, "http://localhost:3000?key=val"))
 
-	ctx = context.WithValue(ctx, HttpRequestContextKey, &http.Request{
+	ctx = context.WithValue(ctx, RequestContextKey, &http.Request{
 		Host: "user-host",
 		Header: map[string][]string{
 			"X-Forwarded-Host":  {"forwarded-host"},

routers/common/middleware.go

@@ -36,7 +36,7 @@ func ProtocolMiddlewares() (handlers []any) {
 				}
 			}()
 			req = req.WithContext(middleware.WithContextData(req.Context()))
-			req = req.WithContext(go_context.WithValue(req.Context(), httplib.HttpRequestContextKey, req))
+			req = req.WithContext(go_context.WithValue(req.Context(), httplib.RequestContextKey, req))
 			next.ServeHTTP(resp, req)
 		})
 	})