-
Notifications
You must be signed in to change notification settings - Fork 108
/
xml.go
454 lines (401 loc) · 10.4 KB
/
xml.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
// SPDX-License-Identifier: MIT
package mock
import (
"bytes"
"encoding/xml"
"errors"
"fmt"
"io"
"strconv"
"strings"
"github.com/issue9/validation/is"
"github.com/caixw/apidoc/v7/core"
"github.com/caixw/apidoc/v7/internal/ast"
"github.com/caixw/apidoc/v7/internal/locale"
)
type xmlValidator struct {
namespaces []*ast.XMLNamespace
decoder *xml.Decoder
}
func validXML(ns []*ast.XMLNamespace, p *ast.Request, content []byte) error {
if len(content) == 0 {
if p == nil || p.Type.V() == ast.TypeNone {
return nil
}
return core.NewError(locale.ErrInvalidFormat)
}
validator := &xmlValidator{
namespaces: ns,
decoder: xml.NewDecoder(bytes.NewReader(content)),
}
for {
token, err := validator.decoder.Token()
if errors.Is(err, io.EOF) && token == nil { // 正常结束
return nil
}
if err != nil {
return err
}
switch elem := token.(type) {
case xml.StartElement:
if err := validator.validXMLNamespaces(elem); err != nil {
return err
}
return validator.validXMLElement(elem, p.Param(), true, elem.Name.Local)
case xml.EndElement:
return core.NewError(locale.ErrInvalidFormat)
}
}
}
func (v *xmlValidator) validXMLNamespaces(start xml.StartElement) error {
ATTR:
for _, attr := range start.Attr {
if attr.Name.Local == "xmlns" && attr.Name.Space == "" { // 默认
for _, item := range v.namespaces {
if item.URN.V() == attr.Value {
continue ATTR
}
}
return core.NewError(locale.ErrNotFound).WithField("xmlns")
} else if attr.Name.Space == "xmlns" && attr.Name.Local != "" {
for _, item := range v.namespaces {
if item.Prefix.V() == attr.Name.Local && item.URN.V() == attr.Value {
continue ATTR
}
}
return core.NewError(locale.ErrNotFound).WithField("xmlns:" + attr.Name.Local)
}
}
return nil
}
func (v *xmlValidator) validXMLName(name xml.Name, p *ast.Param, chkArray bool) bool {
if !p.Array.V() {
if name.Local != p.Name.V() {
return false
} // else goto SPACE
} else {
n := parseXMLWrappedName(p, chkArray)
if chkArray {
if n == name.Local {
goto SPACE
}
return n == ""
}
if name.Local != n {
return false
}
}
SPACE:
if name.Space == "" {
return true
}
for _, item := range v.namespaces {
if item.URN.V() == name.Space {
return item.Prefix.V() == p.XMLNSPrefix.V()
}
}
return false
}
// parent 如果是数组,则是否拿 wrapped 中指示的父元素名称。
func parseXMLWrappedName(p *ast.Param, parent bool) (name string) {
if !p.Array.V() {
return p.Name.V()
}
choose := func(v1, v2 string) string {
if parent {
return v1
}
return v2
}
v := p.XMLWrapped.V()
if v == "" {
return choose("", p.Name.V())
}
index := strings.IndexByte(v, '>')
switch {
case index == 0:
return choose("", v[1:])
case index < 0:
return choose(v, p.Name.V())
default: // index > 0
return choose(v[:index], v[index+1:])
}
}
func (v *xmlValidator) validXMLElement(start xml.StartElement, p *ast.Param, chkArray bool, field string) error {
if err := v.validStartElement(start, p, chkArray, field); err != nil {
return err
}
var chardata []byte
var started bool
LOOP:
for {
token, err := v.decoder.Token()
if errors.Is(err, io.EOF) && token == nil { // 正常结束
return nil
}
if err != nil {
return err
}
switch elem := token.(type) {
case xml.StartElement:
if chkArray && p.Array.V() && v.validXMLName(elem.Name, p, false) {
if err := v.validXMLElement(elem, p, false, buildXMLField(field, p)); err != nil {
return err
}
chardata = nil
started = true
continue LOOP
}
for _, pp := range p.Items {
if v.validXMLName(elem.Name, pp, true) {
if pp.XMLExtract.V() {
pp = p
}
if err = v.validXMLElement(elem, pp, true, buildXMLField(field, pp)); err != nil {
return err
}
chardata = nil
started = true
continue LOOP
}
}
case xml.EndElement:
if !v.validXMLName(elem.Name, p, chkArray) {
return core.NewError(locale.ErrNotFoundEndTag).WithField(elem.Name.Local)
}
if chardata != nil && !started {
return validXMLValue(p, p.Name.V(), string(chardata))
}
return nil
case xml.CharData:
if !started {
chardata = elem.Copy()
}
}
}
}
func (v *xmlValidator) validStartElement(start xml.StartElement, p *ast.Param, chkArray bool, field string) error {
for _, attr := range start.Attr {
for _, pp := range p.Items {
if !v.validXMLName(attr.Name, pp, false) {
continue
}
if err := validXMLValue(pp, buildXMLField(field, pp), attr.Value); err != nil {
return err
}
break
}
}
if !v.validXMLName(start.Name, p, chkArray) {
return core.NewError(locale.ErrNotFound).WithField(start.Name.Local)
}
return nil
}
func buildXMLField(field string, p *ast.Param) string {
if p.XMLAttr.V() {
return field + "@" + p.Name.V()
}
return field + ">" + p.Name.V()
}
// 验证 p 描述的类型与 v 是否匹配,如果不匹配返回错误信息。
// field 表示 p 在整个对象中的位置信息。
func validXMLValue(p *ast.Param, field, v string) error {
switch p.Type.V() {
case ast.TypeNone:
if v != "" {
return core.NewError(locale.ErrInvalidValue).WithField(field)
}
case ast.TypeNumber:
if !is.Number(v) {
return core.NewError(locale.ErrInvalidFormat).WithField(field)
}
case ast.TypeInt:
if _, err := strconv.ParseInt(v, 10, 64); err != nil {
return core.NewError(locale.ErrInvalidFormat).WithField(field)
}
case ast.TypeFloat:
if _, err := strconv.ParseFloat(v, 64); err != nil {
return core.NewError(locale.ErrInvalidFormat).WithField(field)
}
case ast.TypeBool:
if _, err := strconv.ParseBool(v); err != nil {
return core.NewError(locale.ErrInvalidFormat).WithField(field)
}
case ast.TypeEmail:
if !is.Email(v) {
return core.NewError(locale.ErrInvalidFormat).WithField(field)
}
case ast.TypeURL:
if !is.URL(v) {
return core.NewError(locale.ErrInvalidFormat).WithField(field)
}
case ast.TypeDate:
if !isValidRFC3339Date(v) {
return core.NewError(locale.ErrInvalidFormat).WithField(field)
}
case ast.TypeTime:
if !isValidRFC3339Time(v) {
return core.NewError(locale.ErrInvalidFormat).WithField(field)
}
case ast.TypeDateTime:
if !isValidRFC3339DateTime(v) {
return core.NewError(locale.ErrInvalidFormat).WithField(field)
}
case ast.TypeString, ast.TypeObject, ast.TypeImage:
return nil
default:
panic(fmt.Sprintf("文档中类型定义错误 %s", p.Type.V()))
}
if isEnum(p) {
for _, enum := range p.Enums {
if enum.Value.V() == v {
return nil
}
}
return core.NewError(locale.ErrInvalidValue).WithField(field)
}
return nil
}
type xmlBuilder struct {
start xml.StartElement
items []*xmlBuilder
chardata interface{}
cdata bool // 表示 chardata 是一个 cdata 数据
}
func buildXML(ns []*ast.XMLNamespace, p *ast.Request, indent string, g *GenOptions) ([]byte, error) {
if p == nil || p.Type.V() == ast.TypeNone {
return nil, nil
}
builder, err := parseXML(ns, p.Param(), true, true, g)
if err != nil {
return nil, err
}
buf := new(bytes.Buffer)
e := xml.NewEncoder(buf)
e.Indent("", indent)
if err = builder.encode(e); err != nil {
return nil, err
}
if err := e.Flush(); err != nil {
return nil, err
}
return buf.Bytes(), nil
}
func parseXML(ns []*ast.XMLNamespace, p *ast.Param, chkArray, root bool, g *GenOptions) (*xmlBuilder, error) {
builder := &xmlBuilder{
start: xml.StartElement{
Name: buildXMLName(p, chkArray),
Attr: make([]xml.Attr, 0, len(p.Items)+len(ns)),
},
items: []*xmlBuilder{},
cdata: p.XMLCData.V(),
}
if p.Array.V() && chkArray {
if err := parseXMLArray(ns, p, builder, g); err != nil {
return nil, err
}
if root {
builder = builder.items[0]
}
goto RET
}
if p.Type.V() != ast.TypeObject {
builder.chardata = genXMLValue(g, p)
goto RET
}
for _, item := range p.Items {
switch {
case item.XMLAttr.V():
attr := xml.Attr{
Name: buildXMLName(item, false),
Value: fmt.Sprint(genXMLValue(g, item)),
}
builder.start.Attr = append(builder.start.Attr, attr)
case item.XMLExtract.V():
builder.chardata = genXMLValue(g, item)
builder.cdata = item.XMLCData.V()
case item.Array.V():
if err := parseXMLArray(ns, item, builder, g); err != nil {
return nil, err
}
default:
b, err := parseXML(ns, item, true, false, g)
if err != nil {
return nil, err
}
builder.items = append(builder.items, b)
}
} // end for
RET:
if root { // namespace
for _, item := range ns {
name := "xmlns"
if item.Prefix.V() != "" {
name += ":" + item.Prefix.V()
}
builder.start.Attr = append(builder.start.Attr, xml.Attr{
Name: xml.Name{Local: name},
Value: item.URN.V(),
})
}
}
return builder, nil
}
func buildXMLName(p *ast.Param, chkArray bool) xml.Name {
name := parseXMLWrappedName(p, chkArray)
if p.XMLNSPrefix.V() != "" {
return xml.Name{Local: p.XMLNSPrefix.V() + ":" + name}
}
return xml.Name{Local: name}
}
func parseXMLArray(ns []*ast.XMLNamespace, p *ast.Param, parent *xmlBuilder, g *GenOptions) error {
b := parent
if p.XMLWrapped.V() != "" && p.XMLWrapped.V()[0] != '>' {
b = &xmlBuilder{items: []*xmlBuilder{}}
b.start.Name = buildXMLName(p, true)
parent.items = append(parent.items, b)
}
for i := 0; i < g.generateSliceSize(); i++ {
bb, err := parseXML(ns, p, false, false, g)
if err != nil {
return err
}
b.items = append(b.items, bb)
}
return nil
}
func (builder *xmlBuilder) encode(e *xml.Encoder) error {
if builder == nil {
return nil
}
if builder.cdata && builder.chardata != nil {
return e.EncodeElement(struct {
string `xml:",cdata"`
}{string: fmt.Sprint(builder.chardata)}, builder.start)
} else if builder.chardata != nil {
return e.EncodeElement(builder.chardata, builder.start)
}
if err := e.EncodeToken(builder.start); err != nil {
return err
}
for _, item := range builder.items {
if err := item.encode(e); err != nil {
return err
}
}
return e.EncodeToken(builder.start.End())
}
func genXMLValue(g *GenOptions, p *ast.Param) interface{} {
switch primitive, _ := ast.ParseType(p.Type.V()); primitive {
case ast.TypeNone:
return ""
case ast.TypeBool:
return g.generateBool()
case ast.TypeNumber:
return g.generateNumber(p)
case ast.TypeString:
return g.generateString(p)
default: // ast.TypeObject:
panic(fmt.Sprintf("无效的类型 %s", p.Type.V())) // 加载的时候已经作语法验证,此处还出错则直接 panic
}
}