unmarshal.go 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272
  1. package xmlutil
  2. import (
  3. "encoding/base64"
  4. "encoding/xml"
  5. "fmt"
  6. "io"
  7. "reflect"
  8. "strconv"
  9. "strings"
  10. "time"
  11. "github.com/aws/aws-sdk-go/private/protocol"
  12. )
  13. // UnmarshalXML deserializes an xml.Decoder into the container v. V
  14. // needs to match the shape of the XML expected to be decoded.
  15. // If the shape doesn't match unmarshaling will fail.
  16. func UnmarshalXML(v interface{}, d *xml.Decoder, wrapper string) error {
  17. n, err := XMLToStruct(d, nil)
  18. if err != nil {
  19. return err
  20. }
  21. if n.Children != nil {
  22. for _, root := range n.Children {
  23. for _, c := range root {
  24. if wrappedChild, ok := c.Children[wrapper]; ok {
  25. c = wrappedChild[0] // pull out wrapped element
  26. }
  27. err = parse(reflect.ValueOf(v), c, "")
  28. if err != nil {
  29. if err == io.EOF {
  30. return nil
  31. }
  32. return err
  33. }
  34. }
  35. }
  36. return nil
  37. }
  38. return nil
  39. }
  40. // parse deserializes any value from the XMLNode. The type tag is used to infer the type, or reflect
  41. // will be used to determine the type from r.
  42. func parse(r reflect.Value, node *XMLNode, tag reflect.StructTag) error {
  43. rtype := r.Type()
  44. if rtype.Kind() == reflect.Ptr {
  45. rtype = rtype.Elem() // check kind of actual element type
  46. }
  47. t := tag.Get("type")
  48. if t == "" {
  49. switch rtype.Kind() {
  50. case reflect.Struct:
  51. // also it can't be a time object
  52. if _, ok := r.Interface().(*time.Time); !ok {
  53. t = "structure"
  54. }
  55. case reflect.Slice:
  56. // also it can't be a byte slice
  57. if _, ok := r.Interface().([]byte); !ok {
  58. t = "list"
  59. }
  60. case reflect.Map:
  61. t = "map"
  62. }
  63. }
  64. switch t {
  65. case "structure":
  66. if field, ok := rtype.FieldByName("_"); ok {
  67. tag = field.Tag
  68. }
  69. return parseStruct(r, node, tag)
  70. case "list":
  71. return parseList(r, node, tag)
  72. case "map":
  73. return parseMap(r, node, tag)
  74. default:
  75. return parseScalar(r, node, tag)
  76. }
  77. }
  78. // parseStruct deserializes a structure and its fields from an XMLNode. Any nested
  79. // types in the structure will also be deserialized.
  80. func parseStruct(r reflect.Value, node *XMLNode, tag reflect.StructTag) error {
  81. t := r.Type()
  82. if r.Kind() == reflect.Ptr {
  83. if r.IsNil() { // create the structure if it's nil
  84. s := reflect.New(r.Type().Elem())
  85. r.Set(s)
  86. r = s
  87. }
  88. r = r.Elem()
  89. t = t.Elem()
  90. }
  91. // unwrap any payloads
  92. if payload := tag.Get("payload"); payload != "" {
  93. field, _ := t.FieldByName(payload)
  94. return parseStruct(r.FieldByName(payload), node, field.Tag)
  95. }
  96. for i := 0; i < t.NumField(); i++ {
  97. field := t.Field(i)
  98. if c := field.Name[0:1]; strings.ToLower(c) == c {
  99. continue // ignore unexported fields
  100. }
  101. // figure out what this field is called
  102. name := field.Name
  103. if field.Tag.Get("flattened") != "" && field.Tag.Get("locationNameList") != "" {
  104. name = field.Tag.Get("locationNameList")
  105. } else if locName := field.Tag.Get("locationName"); locName != "" {
  106. name = locName
  107. }
  108. // try to find the field by name in elements
  109. elems := node.Children[name]
  110. if elems == nil { // try to find the field in attributes
  111. if val, ok := node.findElem(name); ok {
  112. elems = []*XMLNode{{Text: val}}
  113. }
  114. }
  115. member := r.FieldByName(field.Name)
  116. for _, elem := range elems {
  117. err := parse(member, elem, field.Tag)
  118. if err != nil {
  119. return err
  120. }
  121. }
  122. }
  123. return nil
  124. }
  125. // parseList deserializes a list of values from an XML node. Each list entry
  126. // will also be deserialized.
  127. func parseList(r reflect.Value, node *XMLNode, tag reflect.StructTag) error {
  128. t := r.Type()
  129. if tag.Get("flattened") == "" { // look at all item entries
  130. mname := "member"
  131. if name := tag.Get("locationNameList"); name != "" {
  132. mname = name
  133. }
  134. if Children, ok := node.Children[mname]; ok {
  135. if r.IsNil() {
  136. r.Set(reflect.MakeSlice(t, len(Children), len(Children)))
  137. }
  138. for i, c := range Children {
  139. err := parse(r.Index(i), c, "")
  140. if err != nil {
  141. return err
  142. }
  143. }
  144. }
  145. } else { // flattened list means this is a single element
  146. if r.IsNil() {
  147. r.Set(reflect.MakeSlice(t, 0, 0))
  148. }
  149. childR := reflect.Zero(t.Elem())
  150. r.Set(reflect.Append(r, childR))
  151. err := parse(r.Index(r.Len()-1), node, "")
  152. if err != nil {
  153. return err
  154. }
  155. }
  156. return nil
  157. }
  158. // parseMap deserializes a map from an XMLNode. The direct children of the XMLNode
  159. // will also be deserialized as map entries.
  160. func parseMap(r reflect.Value, node *XMLNode, tag reflect.StructTag) error {
  161. if r.IsNil() {
  162. r.Set(reflect.MakeMap(r.Type()))
  163. }
  164. if tag.Get("flattened") == "" { // look at all child entries
  165. for _, entry := range node.Children["entry"] {
  166. parseMapEntry(r, entry, tag)
  167. }
  168. } else { // this element is itself an entry
  169. parseMapEntry(r, node, tag)
  170. }
  171. return nil
  172. }
  173. // parseMapEntry deserializes a map entry from a XML node.
  174. func parseMapEntry(r reflect.Value, node *XMLNode, tag reflect.StructTag) error {
  175. kname, vname := "key", "value"
  176. if n := tag.Get("locationNameKey"); n != "" {
  177. kname = n
  178. }
  179. if n := tag.Get("locationNameValue"); n != "" {
  180. vname = n
  181. }
  182. keys, ok := node.Children[kname]
  183. values := node.Children[vname]
  184. if ok {
  185. for i, key := range keys {
  186. keyR := reflect.ValueOf(key.Text)
  187. value := values[i]
  188. valueR := reflect.New(r.Type().Elem()).Elem()
  189. parse(valueR, value, "")
  190. r.SetMapIndex(keyR, valueR)
  191. }
  192. }
  193. return nil
  194. }
  195. // parseScaller deserializes an XMLNode value into a concrete type based on the
  196. // interface type of r.
  197. //
  198. // Error is returned if the deserialization fails due to invalid type conversion,
  199. // or unsupported interface type.
  200. func parseScalar(r reflect.Value, node *XMLNode, tag reflect.StructTag) error {
  201. switch r.Interface().(type) {
  202. case *string:
  203. r.Set(reflect.ValueOf(&node.Text))
  204. return nil
  205. case []byte:
  206. b, err := base64.StdEncoding.DecodeString(node.Text)
  207. if err != nil {
  208. return err
  209. }
  210. r.Set(reflect.ValueOf(b))
  211. case *bool:
  212. v, err := strconv.ParseBool(node.Text)
  213. if err != nil {
  214. return err
  215. }
  216. r.Set(reflect.ValueOf(&v))
  217. case *int64:
  218. v, err := strconv.ParseInt(node.Text, 10, 64)
  219. if err != nil {
  220. return err
  221. }
  222. r.Set(reflect.ValueOf(&v))
  223. case *float64:
  224. v, err := strconv.ParseFloat(node.Text, 64)
  225. if err != nil {
  226. return err
  227. }
  228. r.Set(reflect.ValueOf(&v))
  229. case *time.Time:
  230. format := tag.Get("timestampFormat")
  231. if len(format) == 0 {
  232. format = protocol.ISO8601TimeFormatName
  233. }
  234. t, err := protocol.ParseTime(format, node.Text)
  235. if err != nil {
  236. return err
  237. }
  238. r.Set(reflect.ValueOf(&t))
  239. default:
  240. return fmt.Errorf("unsupported value: %v (%s)", r.Interface(), r.Type())
  241. }
  242. return nil
  243. }