bind.go 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273
  1. package echo
  2. import (
  3. "encoding/json"
  4. "encoding/xml"
  5. "errors"
  6. "fmt"
  7. "net/http"
  8. "reflect"
  9. "strconv"
  10. "strings"
  11. )
  12. type (
  13. // Binder is the interface that wraps the Bind method.
  14. Binder interface {
  15. Bind(i interface{}, c Context) error
  16. }
  17. // DefaultBinder is the default implementation of the Binder interface.
  18. DefaultBinder struct{}
  19. // BindUnmarshaler is the interface used to wrap the UnmarshalParam method.
  20. BindUnmarshaler interface {
  21. // UnmarshalParam decodes and assigns a value from an form or query param.
  22. UnmarshalParam(param string) error
  23. }
  24. )
  25. // Bind implements the `Binder#Bind` function.
  26. func (b *DefaultBinder) Bind(i interface{}, c Context) (err error) {
  27. req := c.Request()
  28. if req.ContentLength == 0 {
  29. if req.Method == GET || req.Method == DELETE {
  30. if err = b.bindData(i, c.QueryParams(), "query"); err != nil {
  31. return NewHTTPError(http.StatusBadRequest, err.Error())
  32. }
  33. return
  34. }
  35. return NewHTTPError(http.StatusBadRequest, "Request body can't be empty")
  36. }
  37. ctype := req.Header.Get(HeaderContentType)
  38. switch {
  39. case strings.HasPrefix(ctype, MIMEApplicationJSON):
  40. if err = json.NewDecoder(req.Body).Decode(i); err != nil {
  41. if ute, ok := err.(*json.UnmarshalTypeError); ok {
  42. return NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Unmarshal type error: expected=%v, got=%v, field=%v, offset=%v", ute.Type, ute.Value, ute.Field, ute.Offset))
  43. } else if se, ok := err.(*json.SyntaxError); ok {
  44. return NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Syntax error: offset=%v, error=%v", se.Offset, se.Error()))
  45. }
  46. return NewHTTPError(http.StatusBadRequest, err.Error())
  47. }
  48. case strings.HasPrefix(ctype, MIMEApplicationXML), strings.HasPrefix(ctype, MIMETextXML):
  49. if err = xml.NewDecoder(req.Body).Decode(i); err != nil {
  50. if ute, ok := err.(*xml.UnsupportedTypeError); ok {
  51. return NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Unsupported type error: type=%v, error=%v", ute.Type, ute.Error()))
  52. } else if se, ok := err.(*xml.SyntaxError); ok {
  53. return NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Syntax error: line=%v, error=%v", se.Line, se.Error()))
  54. }
  55. return NewHTTPError(http.StatusBadRequest, err.Error())
  56. }
  57. case strings.HasPrefix(ctype, MIMEApplicationForm), strings.HasPrefix(ctype, MIMEMultipartForm):
  58. params, err := c.FormParams()
  59. if err != nil {
  60. return NewHTTPError(http.StatusBadRequest, err.Error())
  61. }
  62. if err = b.bindData(i, params, "form"); err != nil {
  63. return NewHTTPError(http.StatusBadRequest, err.Error())
  64. }
  65. default:
  66. return ErrUnsupportedMediaType
  67. }
  68. return
  69. }
  70. func (b *DefaultBinder) bindData(ptr interface{}, data map[string][]string, tag string) error {
  71. typ := reflect.TypeOf(ptr).Elem()
  72. val := reflect.ValueOf(ptr).Elem()
  73. if typ.Kind() != reflect.Struct {
  74. return errors.New("binding element must be a struct")
  75. }
  76. for i := 0; i < typ.NumField(); i++ {
  77. typeField := typ.Field(i)
  78. structField := val.Field(i)
  79. if !structField.CanSet() {
  80. continue
  81. }
  82. structFieldKind := structField.Kind()
  83. inputFieldName := typeField.Tag.Get(tag)
  84. if inputFieldName == "" {
  85. inputFieldName = typeField.Name
  86. // If tag is nil, we inspect if the field is a struct.
  87. if _, ok := bindUnmarshaler(structField); !ok && structFieldKind == reflect.Struct {
  88. if err := b.bindData(structField.Addr().Interface(), data, tag); err != nil {
  89. return err
  90. }
  91. continue
  92. }
  93. }
  94. inputValue, exists := data[inputFieldName]
  95. if !exists {
  96. // Go json.Unmarshal supports case insensitive binding. However the
  97. // url params are bound case sensitive which is inconsistent. To
  98. // fix this we must check all of the map values in a
  99. // case-insensitive search.
  100. inputFieldName = strings.ToLower(inputFieldName)
  101. for k, v := range data {
  102. if strings.ToLower(k) == inputFieldName {
  103. inputValue = v
  104. exists = true
  105. break
  106. }
  107. }
  108. }
  109. if !exists {
  110. continue
  111. }
  112. // Call this first, in case we're dealing with an alias to an array type
  113. if ok, err := unmarshalField(typeField.Type.Kind(), inputValue[0], structField); ok {
  114. if err != nil {
  115. return err
  116. }
  117. continue
  118. }
  119. numElems := len(inputValue)
  120. if structFieldKind == reflect.Slice && numElems > 0 {
  121. sliceOf := structField.Type().Elem().Kind()
  122. slice := reflect.MakeSlice(structField.Type(), numElems, numElems)
  123. for j := 0; j < numElems; j++ {
  124. if err := setWithProperType(sliceOf, inputValue[j], slice.Index(j)); err != nil {
  125. return err
  126. }
  127. }
  128. val.Field(i).Set(slice)
  129. } else if err := setWithProperType(typeField.Type.Kind(), inputValue[0], structField); err != nil {
  130. return err
  131. }
  132. }
  133. return nil
  134. }
  135. func setWithProperType(valueKind reflect.Kind, val string, structField reflect.Value) error {
  136. // But also call it here, in case we're dealing with an array of BindUnmarshalers
  137. if ok, err := unmarshalField(valueKind, val, structField); ok {
  138. return err
  139. }
  140. switch valueKind {
  141. case reflect.Ptr:
  142. return setWithProperType(structField.Elem().Kind(), val, structField.Elem())
  143. case reflect.Int:
  144. return setIntField(val, 0, structField)
  145. case reflect.Int8:
  146. return setIntField(val, 8, structField)
  147. case reflect.Int16:
  148. return setIntField(val, 16, structField)
  149. case reflect.Int32:
  150. return setIntField(val, 32, structField)
  151. case reflect.Int64:
  152. return setIntField(val, 64, structField)
  153. case reflect.Uint:
  154. return setUintField(val, 0, structField)
  155. case reflect.Uint8:
  156. return setUintField(val, 8, structField)
  157. case reflect.Uint16:
  158. return setUintField(val, 16, structField)
  159. case reflect.Uint32:
  160. return setUintField(val, 32, structField)
  161. case reflect.Uint64:
  162. return setUintField(val, 64, structField)
  163. case reflect.Bool:
  164. return setBoolField(val, structField)
  165. case reflect.Float32:
  166. return setFloatField(val, 32, structField)
  167. case reflect.Float64:
  168. return setFloatField(val, 64, structField)
  169. case reflect.String:
  170. structField.SetString(val)
  171. default:
  172. return errors.New("unknown type")
  173. }
  174. return nil
  175. }
  176. func unmarshalField(valueKind reflect.Kind, val string, field reflect.Value) (bool, error) {
  177. switch valueKind {
  178. case reflect.Ptr:
  179. return unmarshalFieldPtr(val, field)
  180. default:
  181. return unmarshalFieldNonPtr(val, field)
  182. }
  183. }
  184. // bindUnmarshaler attempts to unmarshal a reflect.Value into a BindUnmarshaler
  185. func bindUnmarshaler(field reflect.Value) (BindUnmarshaler, bool) {
  186. ptr := reflect.New(field.Type())
  187. if ptr.CanInterface() {
  188. iface := ptr.Interface()
  189. if unmarshaler, ok := iface.(BindUnmarshaler); ok {
  190. return unmarshaler, ok
  191. }
  192. }
  193. return nil, false
  194. }
  195. func unmarshalFieldNonPtr(value string, field reflect.Value) (bool, error) {
  196. if unmarshaler, ok := bindUnmarshaler(field); ok {
  197. err := unmarshaler.UnmarshalParam(value)
  198. field.Set(reflect.ValueOf(unmarshaler).Elem())
  199. return true, err
  200. }
  201. return false, nil
  202. }
  203. func unmarshalFieldPtr(value string, field reflect.Value) (bool, error) {
  204. if field.IsNil() {
  205. // Initialize the pointer to a nil value
  206. field.Set(reflect.New(field.Type().Elem()))
  207. }
  208. return unmarshalFieldNonPtr(value, field.Elem())
  209. }
  210. func setIntField(value string, bitSize int, field reflect.Value) error {
  211. if value == "" {
  212. value = "0"
  213. }
  214. intVal, err := strconv.ParseInt(value, 10, bitSize)
  215. if err == nil {
  216. field.SetInt(intVal)
  217. }
  218. return err
  219. }
  220. func setUintField(value string, bitSize int, field reflect.Value) error {
  221. if value == "" {
  222. value = "0"
  223. }
  224. uintVal, err := strconv.ParseUint(value, 10, bitSize)
  225. if err == nil {
  226. field.SetUint(uintVal)
  227. }
  228. return err
  229. }
  230. func setBoolField(value string, field reflect.Value) error {
  231. if value == "" {
  232. value = "false"
  233. }
  234. boolVal, err := strconv.ParseBool(value)
  235. if err == nil {
  236. field.SetBool(boolVal)
  237. }
  238. return err
  239. }
  240. func setFloatField(value string, bitSize int, field reflect.Value) error {
  241. if value == "" {
  242. value = "0.0"
  243. }
  244. floatVal, err := strconv.ParseFloat(value, bitSize)
  245. if err == nil {
  246. field.SetFloat(floatVal)
  247. }
  248. return err
  249. }