unmarshal.go 6.0 KB

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