unmarshal.go 6.2 KB

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