aboutsummaryrefslogtreecommitdiffstats
path: root/modules/templates
diff options
context:
space:
mode:
authorChai-Shi <changchaishi@gmail.com>2024-12-31 12:22:09 +0800
committerGitHub <noreply@github.com>2024-12-31 04:22:09 +0000
commit0387195abb82080b4c488966960f25a3e8c6fe66 (patch)
tree794cf1e7705002236a33af563729284b48a303c5 /modules/templates
parentc09656e0e0384b15405f909a0e7d7e94a373448e (diff)
downloadgitea-0387195abb82080b4c488966960f25a3e8c6fe66.tar.gz
gitea-0387195abb82080b4c488966960f25a3e8c6fe66.zip
[Feature] Private README.md for organization (#32872)
Implemented #29503 --------- Co-authored-by: Ben Chang <ben_chang@htc.com> Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Diffstat (limited to 'modules/templates')
-rw-r--r--modules/templates/helper.go62
-rw-r--r--modules/templates/helper_test.go55
2 files changed, 101 insertions, 16 deletions
diff --git a/modules/templates/helper.go b/modules/templates/helper.go
index b673450f5a..7529cadca4 100644
--- a/modules/templates/helper.go
+++ b/modules/templates/helper.go
@@ -264,22 +264,42 @@ func userThemeName(user *user_model.User) string {
return setting.UI.DefaultTheme
}
+func isQueryParamEmpty(v any) bool {
+ return v == nil || v == false || v == 0 || v == int64(0) || v == ""
+}
+
// QueryBuild builds a query string from a list of key-value pairs.
-// It omits the nil and empty strings, but it doesn't omit other zero values,
-// because the zero value of number types may have a meaning.
+// It omits the nil, false, zero int/int64 and empty string values,
+// because they are default empty values for "ctx.FormXxx" calls.
+// If 0 or false need to be included, use string values: "0" and "false".
+// Build rules:
+// * Even parameters: always build as query string: a=b&c=d
+// * Odd parameters:
+// * * {"/anything", param-pairs...} => "/?param-paris"
+// * * {"anything?old-params", new-param-pairs...} => "anything?old-params&new-param-paris"
+// * * Otherwise: {"old&params", new-param-pairs...} => "old&params&new-param-paris"
+// * * Other behaviors are undefined yet.
func QueryBuild(a ...any) template.URL {
- var s string
+ var reqPath, s string
+ hasTrailingSep := false
if len(a)%2 == 1 {
if v, ok := a[0].(string); ok {
- if v == "" || (v[0] != '?' && v[0] != '&') {
- panic("QueryBuild: invalid argument")
- }
s = v
} else if v, ok := a[0].(template.URL); ok {
s = string(v)
} else {
panic("QueryBuild: invalid argument")
}
+ hasTrailingSep = s != "&" && strings.HasSuffix(s, "&")
+ if strings.HasPrefix(s, "/") || strings.Contains(s, "?") {
+ if s1, s2, ok := strings.Cut(s, "?"); ok {
+ reqPath = s1 + "?"
+ s = s2
+ } else {
+ reqPath += s + "?"
+ s = ""
+ }
+ }
}
for i := len(a) % 2; i < len(a); i += 2 {
k, ok := a[i].(string)
@@ -290,19 +310,16 @@ func QueryBuild(a ...any) template.URL {
if va, ok := a[i+1].(string); ok {
v = va
} else if a[i+1] != nil {
- v = fmt.Sprint(a[i+1])
+ if !isQueryParamEmpty(a[i+1]) {
+ v = fmt.Sprint(a[i+1])
+ }
}
// pos1 to pos2 is the "k=v&" part, "&" is optional
pos1 := strings.Index(s, "&"+k+"=")
if pos1 != -1 {
pos1++
- } else {
- pos1 = strings.Index(s, "?"+k+"=")
- if pos1 != -1 {
- pos1++
- } else if strings.HasPrefix(s, k+"=") {
- pos1 = 0
- }
+ } else if strings.HasPrefix(s, k+"=") {
+ pos1 = 0
}
pos2 := len(s)
if pos1 == -1 {
@@ -315,7 +332,7 @@ func QueryBuild(a ...any) template.URL {
}
if v != "" {
sep := ""
- hasPrefixSep := pos1 == 0 || (pos1 <= len(s) && (s[pos1-1] == '?' || s[pos1-1] == '&'))
+ hasPrefixSep := pos1 == 0 || (pos1 <= len(s) && s[pos1-1] == '&')
if !hasPrefixSep {
sep = "&"
}
@@ -324,9 +341,22 @@ func QueryBuild(a ...any) template.URL {
s = s[:pos1] + s[pos2:]
}
}
- if s != "" && s != "&" && s[len(s)-1] == '&' {
+ if s != "" && s[len(s)-1] == '&' && !hasTrailingSep {
s = s[:len(s)-1]
}
+ if reqPath != "" {
+ if s == "" {
+ s = reqPath
+ if s != "?" {
+ s = s[:len(s)-1]
+ }
+ } else {
+ if s[0] == '&' {
+ s = s[1:]
+ }
+ s = reqPath + s
+ }
+ }
return template.URL(s)
}
diff --git a/modules/templates/helper_test.go b/modules/templates/helper_test.go
index a530d484bc..e35e8a28f8 100644
--- a/modules/templates/helper_test.go
+++ b/modules/templates/helper_test.go
@@ -118,3 +118,58 @@ func TestTemplateEscape(t *testing.T) {
assert.Equal(t, `<a k="&#34;">&lt;&gt;</a>`, actual)
})
}
+
+func TestQueryBuild(t *testing.T) {
+ t.Run("construct", func(t *testing.T) {
+ assert.Equal(t, "", string(QueryBuild()))
+ assert.Equal(t, "", string(QueryBuild("a", nil, "b", false, "c", 0, "d", "")))
+ assert.Equal(t, "a=1&b=true", string(QueryBuild("a", 1, "b", "true")))
+
+ // path with query parameters
+ assert.Equal(t, "/?k=1", string(QueryBuild("/", "k", 1)))
+ assert.Equal(t, "/", string(QueryBuild("/?k=a", "k", 0)))
+
+ // no path but question mark with query parameters
+ assert.Equal(t, "?k=1", string(QueryBuild("?", "k", 1)))
+ assert.Equal(t, "?", string(QueryBuild("?", "k", 0)))
+ assert.Equal(t, "path?k=1", string(QueryBuild("path?", "k", 1)))
+ assert.Equal(t, "path", string(QueryBuild("path?", "k", 0)))
+
+ // only query parameters
+ assert.Equal(t, "&k=1", string(QueryBuild("&", "k", 1)))
+ assert.Equal(t, "", string(QueryBuild("&", "k", 0)))
+ assert.Equal(t, "", string(QueryBuild("&k=a", "k", 0)))
+ assert.Equal(t, "", string(QueryBuild("k=a&", "k", 0)))
+ assert.Equal(t, "a=1&b=2", string(QueryBuild("a=1", "b", 2)))
+ assert.Equal(t, "&a=1&b=2", string(QueryBuild("&a=1", "b", 2)))
+ assert.Equal(t, "a=1&b=2&", string(QueryBuild("a=1&", "b", 2)))
+ })
+
+ t.Run("replace", func(t *testing.T) {
+ assert.Equal(t, "a=1&c=d&e=f", string(QueryBuild("a=b&c=d&e=f", "a", 1)))
+ assert.Equal(t, "a=b&c=1&e=f", string(QueryBuild("a=b&c=d&e=f", "c", 1)))
+ assert.Equal(t, "a=b&c=d&e=1", string(QueryBuild("a=b&c=d&e=f", "e", 1)))
+ assert.Equal(t, "a=b&c=d&e=f&k=1", string(QueryBuild("a=b&c=d&e=f", "k", 1)))
+ })
+
+ t.Run("replace-&", func(t *testing.T) {
+ assert.Equal(t, "&a=1&c=d&e=f", string(QueryBuild("&a=b&c=d&e=f", "a", 1)))
+ assert.Equal(t, "&a=b&c=1&e=f", string(QueryBuild("&a=b&c=d&e=f", "c", 1)))
+ assert.Equal(t, "&a=b&c=d&e=1", string(QueryBuild("&a=b&c=d&e=f", "e", 1)))
+ assert.Equal(t, "&a=b&c=d&e=f&k=1", string(QueryBuild("&a=b&c=d&e=f", "k", 1)))
+ })
+
+ t.Run("delete", func(t *testing.T) {
+ assert.Equal(t, "c=d&e=f", string(QueryBuild("a=b&c=d&e=f", "a", "")))
+ assert.Equal(t, "a=b&e=f", string(QueryBuild("a=b&c=d&e=f", "c", "")))
+ assert.Equal(t, "a=b&c=d", string(QueryBuild("a=b&c=d&e=f", "e", "")))
+ assert.Equal(t, "a=b&c=d&e=f", string(QueryBuild("a=b&c=d&e=f", "k", "")))
+ })
+
+ t.Run("delete-&", func(t *testing.T) {
+ assert.Equal(t, "&c=d&e=f", string(QueryBuild("&a=b&c=d&e=f", "a", "")))
+ assert.Equal(t, "&a=b&e=f", string(QueryBuild("&a=b&c=d&e=f", "c", "")))
+ assert.Equal(t, "&a=b&c=d", string(QueryBuild("&a=b&c=d&e=f", "e", "")))
+ assert.Equal(t, "&a=b&c=d&e=f", string(QueryBuild("&a=b&c=d&e=f", "k", "")))
+ })
+}