-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathquery.go
More file actions
199 lines (182 loc) · 5.07 KB
/
query.go
File metadata and controls
199 lines (182 loc) · 5.07 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
package shiftapi
import (
"fmt"
"net/url"
"reflect"
"strconv"
"strings"
)
// hasQueryTag returns true if the struct field has a `query` tag.
func hasQueryTag(f reflect.StructField) bool {
return f.Tag.Get("query") != ""
}
// partitionFields inspects a struct type and reports whether it contains
// path-tagged, query-tagged, header-tagged, body (json-tagged or untagged
// non-path/query/header) fields, and/or form-tagged fields. It panics if both
// body and form fields are present.
func partitionFields(t reflect.Type) (hasPath, hasQuery, hasHeader, hasBody, hasForm bool) {
for t.Kind() == reflect.Pointer {
t = t.Elem()
}
if t.Kind() != reflect.Struct {
return false, false, false, false, false
}
for f := range t.Fields() {
if !f.IsExported() {
continue
}
if hasPathTag(f) {
hasPath = true
} else if hasQueryTag(f) {
hasQuery = true
} else if hasHeaderTag(f) {
hasHeader = true
} else if hasFormTag(f) {
hasForm = true
} else {
// Any exported field without a path, query, header, or form tag is a body field
jsonTag := f.Tag.Get("json")
if jsonTag == "-" {
continue
}
hasBody = true
}
}
if hasBody && hasForm {
panic("shiftapi: struct has both json and form tags — this is not allowed")
}
return
}
// resetQueryFields zeros out any query-tagged fields on a struct value.
// This is called after body decode so that query-tagged fields are only
// populated by parseQueryInto, not by JSON keys that happen to match.
func resetQueryFields(rv reflect.Value) {
for rv.Kind() == reflect.Pointer {
rv = rv.Elem()
}
if rv.Kind() != reflect.Struct {
return
}
rt := rv.Type()
for i := range rt.NumField() {
f := rt.Field(i)
if f.IsExported() && hasQueryTag(f) {
rv.Field(i).SetZero()
}
}
}
// parseQueryInto populates query-tagged fields on an existing struct value
// from URL query parameters. Non-query fields are left untouched.
func parseQueryInto(rv reflect.Value, values url.Values) error {
for rv.Kind() == reflect.Pointer {
if rv.IsNil() {
rv.Set(reflect.New(rv.Type().Elem()))
}
rv = rv.Elem()
}
rt := rv.Type()
if rt.Kind() != reflect.Struct {
return fmt.Errorf("query type must be a struct, got %s", rt.Kind())
}
for i := range rt.NumField() {
field := rt.Field(i)
if !field.IsExported() || !hasQueryTag(field) {
continue
}
name := queryFieldName(field)
fv := rv.Field(i)
ft := field.Type
// Handle pointer fields (optional params)
if ft.Kind() == reflect.Pointer {
rawValues, exists := values[name]
if !exists || len(rawValues) == 0 {
continue
}
ptr := reflect.New(ft.Elem())
if err := setScalarValue(ptr.Elem(), rawValues[0]); err != nil {
return &queryParseError{Field: name, Err: err}
}
fv.Set(ptr)
continue
}
// Handle slice fields
if ft.Kind() == reflect.Slice {
rawValues, exists := values[name]
if !exists || len(rawValues) == 0 {
continue
}
elemType := ft.Elem()
slice := reflect.MakeSlice(ft, len(rawValues), len(rawValues))
for j, raw := range rawValues {
elem := reflect.New(elemType).Elem()
if err := setScalarValue(elem, raw); err != nil {
return &queryParseError{Field: name, Err: err}
}
slice.Index(j).Set(elem)
}
fv.Set(slice)
continue
}
// Handle scalar fields
raw := values.Get(name)
if raw == "" {
continue
}
if err := setScalarValue(fv, raw); err != nil {
return &queryParseError{Field: name, Err: err}
}
}
return nil
}
// queryFieldName returns the query parameter name for a struct field.
// The field must have a non-empty `query` tag (guaranteed by hasQueryTag).
func queryFieldName(f reflect.StructField) string {
name, _, _ := strings.Cut(f.Tag.Get("query"), ",")
if name == "" {
return f.Name
}
return name
}
// setScalarValue parses a string and sets the value on a reflect.Value.
func setScalarValue(v reflect.Value, raw string) error {
switch v.Kind() {
case reflect.String:
v.SetString(raw)
case reflect.Bool:
b, err := strconv.ParseBool(raw)
if err != nil {
return fmt.Errorf("invalid boolean value %q", raw)
}
v.SetBool(b)
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
n, err := strconv.ParseInt(raw, 10, v.Type().Bits())
if err != nil {
return fmt.Errorf("invalid integer value %q", raw)
}
v.SetInt(n)
case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
n, err := strconv.ParseUint(raw, 10, v.Type().Bits())
if err != nil {
return fmt.Errorf("invalid unsigned integer value %q", raw)
}
v.SetUint(n)
case reflect.Float32, reflect.Float64:
n, err := strconv.ParseFloat(raw, v.Type().Bits())
if err != nil {
return fmt.Errorf("invalid float value %q", raw)
}
v.SetFloat(n)
default:
return fmt.Errorf("unsupported parameter type %s", v.Kind())
}
return nil
}
// queryParseError is returned when a query parameter cannot be parsed.
type queryParseError struct {
Field string
Err error
}
func (e *queryParseError) Error() string {
return fmt.Sprintf("invalid query parameter %q: %v", e.Field, e.Err)
}
func (e *queryParseError) Unwrap() error { return e.Err }