build.go 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256
  1. // Package rest provides RESTful serialization of AWS requests and responses.
  2. package rest
  3. import (
  4. "bytes"
  5. "encoding/base64"
  6. "fmt"
  7. "io"
  8. "net/http"
  9. "net/url"
  10. "path"
  11. "reflect"
  12. "strconv"
  13. "strings"
  14. "time"
  15. "github.com/aws/aws-sdk-go/aws/awserr"
  16. "github.com/aws/aws-sdk-go/aws/request"
  17. )
  18. // RFC822 returns an RFC822 formatted timestamp for AWS protocols
  19. const RFC822 = "Mon, 2 Jan 2006 15:04:05 GMT"
  20. // Whether the byte value can be sent without escaping in AWS URLs
  21. var noEscape [256]bool
  22. var errValueNotSet = fmt.Errorf("value not set")
  23. func init() {
  24. for i := 0; i < len(noEscape); i++ {
  25. // AWS expects every character except these to be escaped
  26. noEscape[i] = (i >= 'A' && i <= 'Z') ||
  27. (i >= 'a' && i <= 'z') ||
  28. (i >= '0' && i <= '9') ||
  29. i == '-' ||
  30. i == '.' ||
  31. i == '_' ||
  32. i == '~'
  33. }
  34. }
  35. // BuildHandler is a named request handler for building rest protocol requests
  36. var BuildHandler = request.NamedHandler{Name: "awssdk.rest.Build", Fn: Build}
  37. // Build builds the REST component of a service request.
  38. func Build(r *request.Request) {
  39. if r.ParamsFilled() {
  40. v := reflect.ValueOf(r.Params).Elem()
  41. buildLocationElements(r, v)
  42. buildBody(r, v)
  43. }
  44. }
  45. func buildLocationElements(r *request.Request, v reflect.Value) {
  46. query := r.HTTPRequest.URL.Query()
  47. for i := 0; i < v.NumField(); i++ {
  48. m := v.Field(i)
  49. if n := v.Type().Field(i).Name; n[0:1] == strings.ToLower(n[0:1]) {
  50. continue
  51. }
  52. if m.IsValid() {
  53. field := v.Type().Field(i)
  54. name := field.Tag.Get("locationName")
  55. if name == "" {
  56. name = field.Name
  57. }
  58. if m.Kind() == reflect.Ptr {
  59. m = m.Elem()
  60. }
  61. if !m.IsValid() {
  62. continue
  63. }
  64. var err error
  65. switch field.Tag.Get("location") {
  66. case "headers": // header maps
  67. err = buildHeaderMap(&r.HTTPRequest.Header, m, field.Tag.Get("locationName"))
  68. case "header":
  69. err = buildHeader(&r.HTTPRequest.Header, m, name)
  70. case "uri":
  71. err = buildURI(r.HTTPRequest.URL, m, name)
  72. case "querystring":
  73. err = buildQueryString(query, m, name)
  74. }
  75. r.Error = err
  76. }
  77. if r.Error != nil {
  78. return
  79. }
  80. }
  81. r.HTTPRequest.URL.RawQuery = query.Encode()
  82. updatePath(r.HTTPRequest.URL, r.HTTPRequest.URL.Path)
  83. }
  84. func buildBody(r *request.Request, v reflect.Value) {
  85. if field, ok := v.Type().FieldByName("_"); ok {
  86. if payloadName := field.Tag.Get("payload"); payloadName != "" {
  87. pfield, _ := v.Type().FieldByName(payloadName)
  88. if ptag := pfield.Tag.Get("type"); ptag != "" && ptag != "structure" {
  89. payload := reflect.Indirect(v.FieldByName(payloadName))
  90. if payload.IsValid() && payload.Interface() != nil {
  91. switch reader := payload.Interface().(type) {
  92. case io.ReadSeeker:
  93. r.SetReaderBody(reader)
  94. case []byte:
  95. r.SetBufferBody(reader)
  96. case string:
  97. r.SetStringBody(reader)
  98. default:
  99. r.Error = awserr.New("SerializationError",
  100. "failed to encode REST request",
  101. fmt.Errorf("unknown payload type %s", payload.Type()))
  102. }
  103. }
  104. }
  105. }
  106. }
  107. }
  108. func buildHeader(header *http.Header, v reflect.Value, name string) error {
  109. str, err := convertType(v)
  110. if err == errValueNotSet {
  111. return nil
  112. } else if err != nil {
  113. return awserr.New("SerializationError", "failed to encode REST request", err)
  114. }
  115. header.Add(name, str)
  116. return nil
  117. }
  118. func buildHeaderMap(header *http.Header, v reflect.Value, prefix string) error {
  119. for _, key := range v.MapKeys() {
  120. str, err := convertType(v.MapIndex(key))
  121. if err == errValueNotSet {
  122. continue
  123. } else if err != nil {
  124. return awserr.New("SerializationError", "failed to encode REST request", err)
  125. }
  126. header.Add(prefix+key.String(), str)
  127. }
  128. return nil
  129. }
  130. func buildURI(u *url.URL, v reflect.Value, name string) error {
  131. value, err := convertType(v)
  132. if err == errValueNotSet {
  133. return nil
  134. } else if err != nil {
  135. return awserr.New("SerializationError", "failed to encode REST request", err)
  136. }
  137. uri := u.Path
  138. uri = strings.Replace(uri, "{"+name+"}", EscapePath(value, true), -1)
  139. uri = strings.Replace(uri, "{"+name+"+}", EscapePath(value, false), -1)
  140. u.Path = uri
  141. return nil
  142. }
  143. func buildQueryString(query url.Values, v reflect.Value, name string) error {
  144. switch value := v.Interface().(type) {
  145. case []*string:
  146. for _, item := range value {
  147. query.Add(name, *item)
  148. }
  149. case map[string]*string:
  150. for key, item := range value {
  151. query.Add(key, *item)
  152. }
  153. case map[string][]*string:
  154. for key, items := range value {
  155. for _, item := range items {
  156. query.Add(key, *item)
  157. }
  158. }
  159. default:
  160. str, err := convertType(v)
  161. if err == errValueNotSet {
  162. return nil
  163. } else if err != nil {
  164. return awserr.New("SerializationError", "failed to encode REST request", err)
  165. }
  166. query.Set(name, str)
  167. }
  168. return nil
  169. }
  170. func updatePath(url *url.URL, urlPath string) {
  171. scheme, query := url.Scheme, url.RawQuery
  172. hasSlash := strings.HasSuffix(urlPath, "/")
  173. // clean up path
  174. urlPath = path.Clean(urlPath)
  175. if hasSlash && !strings.HasSuffix(urlPath, "/") {
  176. urlPath += "/"
  177. }
  178. // get formatted URL minus scheme so we can build this into Opaque
  179. url.Scheme, url.Path, url.RawQuery = "", "", ""
  180. s := url.String()
  181. url.Scheme = scheme
  182. url.RawQuery = query
  183. // build opaque URI
  184. url.Opaque = s + urlPath
  185. }
  186. // EscapePath escapes part of a URL path in Amazon style
  187. func EscapePath(path string, encodeSep bool) string {
  188. var buf bytes.Buffer
  189. for i := 0; i < len(path); i++ {
  190. c := path[i]
  191. if noEscape[c] || (c == '/' && !encodeSep) {
  192. buf.WriteByte(c)
  193. } else {
  194. fmt.Fprintf(&buf, "%%%02X", c)
  195. }
  196. }
  197. return buf.String()
  198. }
  199. func convertType(v reflect.Value) (string, error) {
  200. v = reflect.Indirect(v)
  201. if !v.IsValid() {
  202. return "", errValueNotSet
  203. }
  204. var str string
  205. switch value := v.Interface().(type) {
  206. case string:
  207. str = value
  208. case []byte:
  209. str = base64.StdEncoding.EncodeToString(value)
  210. case bool:
  211. str = strconv.FormatBool(value)
  212. case int64:
  213. str = strconv.FormatInt(value, 10)
  214. case float64:
  215. str = strconv.FormatFloat(value, 'f', -1, 64)
  216. case time.Time:
  217. str = value.UTC().Format(RFC822)
  218. default:
  219. err := fmt.Errorf("Unsupported value for param %v (%s)", v.Interface(), v.Type())
  220. return "", err
  221. }
  222. return str, nil
  223. }