forked from VividCortex/siesta
-
Notifications
You must be signed in to change notification settings - Fork 0
/
params.go
466 lines (416 loc) · 14.9 KB
/
params.go
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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
package siesta
import (
"flag"
"fmt"
"net/url"
"strconv"
"strings"
"time"
)
// Params represents a set of URL parameters from a request's query string.
// The interface is similar to a flag.FlagSet, but a) there is no usage string,
// b) there are no custom Var()s, and c) there are SliceXXX types. Sliced types
// support two ways of generating a multi-valued parameter: setting the parameter
// multiple times, and using a comma-delimited string. This adds the limitation
// that you can't have a value with a comma if in a Sliced type.
// Under the covers, Params uses flag.FlagSet.
type Params struct {
fset *flag.FlagSet
WantUsage bool
}
// Parse parses URL parameters from a http.Request.URL.Query(), which is a
// url.Values, which is just a map[string][string].
func (rp *Params) Parse(args url.Values) error {
if rp.fset == nil {
rp.fset = flag.NewFlagSet("anonymous", flag.ExitOnError) // both args are unused.
}
usage := rp.fset.Lookup("showdocs")
if usage == nil {
// We magically add a "showdocs" param so you can do GET /resource?showdocs=true and get docs
rp.fset.Bool("showdocs", false, "Shows this usage information")
usage = rp.fset.Lookup("showdocs")
}
// Parse items from URL query string
FLAG_LOOP:
for name, vals := range args {
for _, v := range vals {
f := rp.fset.Lookup(name)
if f == nil {
// Flag wasn't found.
continue FLAG_LOOP
}
// Check if the value is empty
if v == "" {
if bv, ok := f.Value.(boolFlag); ok && bv.IsBoolFlag() {
bv.Set("true")
continue FLAG_LOOP
}
}
err := rp.fset.Set(name, v)
if err != nil {
// Remove the "flag" error message and make a "params" one.
// TODO: optionally allow undefined params to be given, but ignored?
if !strings.Contains(err.Error(), "no such flag -") {
// Give a helpful message about which param caused the error
err = fmt.Errorf("bad param '%s': %s", name, err.Error())
return err
}
}
}
}
if usage.Value.String() == "true" {
rp.WantUsage = true
}
return nil
}
// Usage returns a map keyed on parameter names. The map values are an array of
// name, type, and usage information for each parameter.
func (rp *Params) Usage() map[string][3]string {
docs := make(map[string][3]string)
var translations map[string]string = map[string]string{
"*flag.stringValue": "string",
"*flag.durationValue": "duration",
"*flag.intValue": "int",
"*flag.boolValue": "bool",
"*flag.float64Value": "float64",
"*flag.int64Value": "int64",
"*flag.uintValue": "uint",
"*flag.uint64Value": "uint64",
"*siesta.SString": "[]string",
"*siesta.SDuration": "[]duration",
"*siesta.SInt": "[]int",
"*siesta.SBool": "[]bool",
"*siesta.SFloat64": "[]float64",
"*siesta.SInt64": "[]int64",
"*siesta.SUint": "[]uint",
"*siesta.SUint64": "[]uint64",
}
rp.fset.VisitAll(func(flag *flag.Flag) {
niceName := translations[fmt.Sprintf("%T", flag.Value)]
if niceName == "" {
niceName = fmt.Sprintf("%T", flag.Value)
}
docs[flag.Name] = [...]string{flag.Name, niceName, flag.Usage}
})
return docs
}
type boolFlag interface {
flag.Value
IsBoolFlag() bool
}
// Bool defines a bool param with specified name and default value.
// The return value is the address of a bool variable that stores the value of the param.
func (rp *Params) Bool(name string, value bool, usage string) *bool {
if rp.fset == nil {
rp.fset = flag.NewFlagSet("anonymous", flag.ExitOnError) // both args are unused.
}
p := new(bool)
rp.fset.BoolVar(p, name, value, usage)
return p
}
// SBool is a slice of bool.
type SBool []bool
// String is the method to format the param's value, part of the flag.Value interface.
// The String method's output will be used in diagnostics.
func (s *SBool) String() string {
return fmt.Sprint(*s)
}
// Set is the method to set the param value, part of the flag.Value interface.
// Set's argument is a string to be parsed to set the param.
// It's a comma-separated list, so we split it.
func (s *SBool) Set(value string) error {
for _, dt := range strings.Split(value, ",") {
parsed, err := strconv.ParseBool(dt)
if err != nil {
return err
}
*s = append(*s, parsed)
}
return nil
}
// SliceBool defines a multi-value bool param with specified name and default value.
// The return value is the address of a SBool variable that stores the values of the param.
func (rp *Params) SliceBool(name string, value bool, usage string) *SBool {
if rp.fset == nil {
rp.fset = flag.NewFlagSet("anonymous", flag.ExitOnError) // both args are unused.
}
p := new(SBool)
rp.fset.Var(p, name, usage)
return p
}
// Int defines an int param with specified name and default value.
// The return value is the address of an int variable that stores the value of the param.
func (rp *Params) Int(name string, value int, usage string) *int {
if rp.fset == nil {
rp.fset = flag.NewFlagSet("anonymous", flag.ExitOnError) // both args are unused.
}
p := new(int)
rp.fset.IntVar(p, name, value, usage)
return p
}
// SInt is a slice of int.
type SInt []int
// String is the method to format the param's value, part of the flag.Value interface.
// The String method's output will be used in diagnostics.
func (s *SInt) String() string {
return fmt.Sprint(*s)
}
// Set is the method to set the param value, part of the flag.Value interface.
// Set's argument is a string to be parsed to set the param.
// It's a comma-separated list, so we split it.
func (s *SInt) Set(value string) error {
for _, dt := range strings.Split(value, ",") {
parsed, err := strconv.ParseInt(dt, 0, 64)
if err != nil {
return err
}
*s = append(*s, int(parsed))
}
return nil
}
// SliceInt defines a multi-value int param with specified name and default value.
// The return value is the address of a SInt variable that stores the values of the param.
func (rp *Params) SliceInt(name string, value int, usage string) *SInt {
if rp.fset == nil {
rp.fset = flag.NewFlagSet("anonymous", flag.ExitOnError) // both args are unused.
}
p := new(SInt)
rp.fset.Var(p, name, usage)
return p
}
// Int64 defines an int64 param with specified name and default value.
// The return value is the address of an int64 variable that stores the value of the param.
func (rp *Params) Int64(name string, value int64, usage string) *int64 {
if rp.fset == nil {
rp.fset = flag.NewFlagSet("anonymous", flag.ExitOnError) // both args are unused.
}
p := new(int64)
rp.fset.Int64Var(p, name, value, usage)
return p
}
// SInt64 is a slice of int64.
type SInt64 []int64
// String is the method to format the param's value, part of the flag.Value interface.
// The String method's output will be used in diagnostics.
func (s *SInt64) String() string {
return fmt.Sprint(*s)
}
// Set is the method to set the param value, part of the flag.Value interface.
// Set's argument is a string to be parsed to set the param.
// It's a comma-separated list, so we split it.
func (s *SInt64) Set(value string) error {
for _, dt := range strings.Split(value, ",") {
parsed, err := strconv.ParseInt(dt, 0, 64)
if err != nil {
return err
}
*s = append(*s, int64(parsed))
}
return nil
}
// SliceInt64 defines a multi-value int64 param with specified name and default value.
// The return value is the address of a SInt64 variable that stores the values of the param.
func (rp *Params) SliceInt64(name string, value int64, usage string) *SInt64 {
if rp.fset == nil {
rp.fset = flag.NewFlagSet("anonymous", flag.ExitOnError) // both args are unused.
}
p := new(SInt64)
rp.fset.Var(p, name, usage)
return p
}
// Uint defines a uint param with specified name and default value.
// The return value is the address of a uint variable that stores the value of the param.
func (rp *Params) Uint(name string, value uint, usage string) *uint {
if rp.fset == nil {
rp.fset = flag.NewFlagSet("anonymous", flag.ExitOnError) // both args are unused.
}
p := new(uint)
rp.fset.UintVar(p, name, value, usage)
return p
}
// SUint is a slice of uint.
type SUint []uint
// String is the method to format the param's value, part of the flag.Value interface.
// The String method's output will be used in diagnostics.
func (s *SUint) String() string {
return fmt.Sprint(*s)
}
// Set is the method to set the param value, part of the flag.Value interface.
// Set's argument is a string to be parsed to set the param.
// It's a comma-separated list, so we split it.
func (s *SUint) Set(value string) error {
for _, dt := range strings.Split(value, ",") {
parsed, err := strconv.ParseFloat(dt, 64)
if err != nil {
return err
}
*s = append(*s, uint(parsed))
}
return nil
}
// SliceUint defines a multi-value uint param with specified name and default value.
// The return value is the address of a SUint variable that stores the values of the param.
func (rp *Params) SliceUint(name string, value uint, usage string) *SUint {
if rp.fset == nil {
rp.fset = flag.NewFlagSet("anonymous", flag.ExitOnError) // both args are unused.
}
p := new(SUint)
rp.fset.Var(p, name, usage)
return p
}
// Uint64 defines a uint64 param with specified name and default value.
// The return value is the address of a uint64 variable that stores the value of the param.
func (rp *Params) Uint64(name string, value uint64, usage string) *uint64 {
if rp.fset == nil {
rp.fset = flag.NewFlagSet("anonymous", flag.ExitOnError) // both args are unused.
}
p := new(uint64)
rp.fset.Uint64Var(p, name, value, usage)
return p
}
// SUint64 is a slice of uint64.
type SUint64 []uint64
// String is the method to format the param's value, part of the flag.Value interface.
// The String method's output will be used in diagnostics.
func (s *SUint64) String() string {
return fmt.Sprint(*s)
}
// Set is the method to set the param value, part of the flag.Value interface.
// Set's argument is a string to be parsed to set the param.
// It's a comma-separated list, so we split it.
func (s *SUint64) Set(value string) error {
for _, dt := range strings.Split(value, ",") {
parsed, err := strconv.ParseFloat(dt, 64)
if err != nil {
return err
}
*s = append(*s, uint64(parsed))
}
return nil
}
// SliceUint64 defines a multi-value uint64 param with specified name and default value.
// The return value is the address of a SUint64 variable that stores the values of the param.
func (rp *Params) SliceUint64(name string, value uint64, usage string) *SUint64 {
if rp.fset == nil {
rp.fset = flag.NewFlagSet("anonymous", flag.ExitOnError) // both args are unused.
}
p := new(SUint64)
rp.fset.Var(p, name, usage)
return p
}
// String defines a string param with specified name and default value.
// The return value is the address of a string variable that stores the value of the param.
func (rp *Params) String(name string, value string, usage string) *string {
if rp.fset == nil {
rp.fset = flag.NewFlagSet("anonymous", flag.ExitOnError) // both args are unused.
}
p := new(string)
rp.fset.StringVar(p, name, value, usage)
return p
}
// SString is a slice of string.
type SString []string
// String is the method to format the param's value, part of the flag.Value interface.
// The String method's output will be used in diagnostics.
func (s *SString) String() string {
return strings.Join(*s, ",")
}
// Set is the method to set the param value, part of the flag.Value interface.
// Set's argument is a string to be parsed to set the param.
// It's a comma-separated list, so we split it.
func (s *SString) Set(value string) error {
for _, dt := range strings.Split(value, ",") {
*s = append(*s, dt)
}
return nil
}
// SliceString defines a multi-value string param with specified name and default value.
// The return value is the address of a SString variable that stores the values of the param.
func (rp *Params) SliceString(name string, value string, usage string) *SString {
if rp.fset == nil {
rp.fset = flag.NewFlagSet("anonymous", flag.ExitOnError) // both args are unused.
}
p := new(SString)
rp.fset.Var(p, name, usage)
return p
}
// Float64 defines a float64 param with specified name and default value.
// The return value is the address of a float64 variable that stores the value of the param.
func (rp *Params) Float64(name string, value float64, usage string) *float64 {
if rp.fset == nil {
rp.fset = flag.NewFlagSet("anonymous", flag.ExitOnError) // both args are unused.
}
p := new(float64)
rp.fset.Float64Var(p, name, value, usage)
return p
}
// SFloat64 is a slice of float64.
type SFloat64 []float64
// String is the method to format the param's value, part of the flag.Value interface.
// The String method's output will be used in diagnostics.
func (s *SFloat64) String() string {
return fmt.Sprintf("%f", *s)
}
// Set is the method to set the param value, part of the flag.Value interface.
// Set's argument is a string to be parsed to set the param.
// It's a comma-separated list, so we split it.
func (s *SFloat64) Set(value string) error {
for _, dt := range strings.Split(value, ",") {
parsed, err := strconv.ParseFloat(dt, 64)
if err != nil {
return err
}
*s = append(*s, parsed)
}
return nil
}
// SliceFloat64 defines a multi-value float64 param with specified name and default value.
// The return value is the address of a SFloat64 variable that stores the values of the param.
func (rp *Params) SliceFloat64(name string, value float64, usage string) *SFloat64 {
if rp.fset == nil {
rp.fset = flag.NewFlagSet("anonymous", flag.ExitOnError) // both args are unused.
}
p := new(SFloat64)
rp.fset.Var(p, name, usage)
return p
}
// Duration defines a time.Duration param with specified name and default value.
// The return value is the address of a time.Duration variable that stores the value of the param.
func (rp *Params) Duration(name string, value time.Duration, usage string) *time.Duration {
if rp.fset == nil {
rp.fset = flag.NewFlagSet("anonymous", flag.ExitOnError) // both args are unused.
}
p := new(time.Duration)
rp.fset.DurationVar(p, name, value, usage)
return p
}
// SDuration is a slice of time.Duration.
type SDuration []time.Duration
// String is the method to format the param's value, part of the flag.Value interface.
// The String method's output will be used in diagnostics.
func (s *SDuration) String() string {
return fmt.Sprint(*s)
}
// Set is the method to set the param value, part of the flag.Value interface.
// Set's argument is a string to be parsed to set the param.
// It's a comma-separated list, so we split it.
func (s *SDuration) Set(value string) error {
for _, dt := range strings.Split(value, ",") {
parsed, err := time.ParseDuration(dt)
if err != nil {
return err
}
*s = append(*s, parsed)
}
return nil
}
// SliceDuration defines a multi-value time.Duration param with specified name and default value.
// The return value is the address of a SDuration variable that stores the values of the param.
func (rp *Params) SliceDuration(name string, value time.Duration, usage string) *SDuration {
if rp.fset == nil {
rp.fset = flag.NewFlagSet("anonymous", flag.ExitOnError) // both args are unused.
}
p := new(SDuration)
rp.fset.Var(p, name, usage)
return p
}