request.go 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425
  1. package tos
  2. import (
  3. "bytes"
  4. "context"
  5. "crypto/md5"
  6. "encoding/base64"
  7. "encoding/json"
  8. "errors"
  9. "fmt"
  10. "io"
  11. "io/ioutil"
  12. "net"
  13. "net/http"
  14. "net/url"
  15. "os"
  16. "reflect"
  17. "strconv"
  18. "strings"
  19. "time"
  20. )
  21. type urlMode int
  22. const (
  23. // urlModePath url pattern is http(s)://{bucket}.domain/{object}
  24. urlModeDefault = 0
  25. // urlModePath url pattern is http(s)://domain/{bucket}/{object}
  26. urlModePath = 1
  27. )
  28. type Request struct {
  29. Scheme string
  30. Method string
  31. Host string
  32. Path string
  33. ContentLength *int64
  34. Content io.Reader
  35. Query url.Values
  36. Header http.Header
  37. }
  38. func (req *Request) URL() string {
  39. u := url.URL{
  40. Scheme: req.Scheme,
  41. Host: req.Host,
  42. Path: req.Path,
  43. RawQuery: req.Query.Encode(),
  44. }
  45. return u.String()
  46. }
  47. func OnRetryFromStart(req *Request) error {
  48. if seek, ok := req.Content.(io.Seeker); ok {
  49. _, err := seek.Seek(0, io.SeekStart)
  50. return err
  51. }
  52. return nil
  53. }
  54. // Range represents a range of an object
  55. type Range struct {
  56. Start int64
  57. End int64
  58. }
  59. // HTTP Range header
  60. func (hr *Range) String() string {
  61. return fmt.Sprintf("bytes=%d-%d", hr.Start, hr.End)
  62. }
  63. type CopySource struct {
  64. srcBucket string
  65. srcObjectKey string
  66. }
  67. type requestBuilder struct {
  68. Signer Signer
  69. Scheme string
  70. Host string
  71. Bucket string
  72. Object string
  73. URLMode urlMode
  74. ContentLength *int64
  75. Range *Range
  76. Query url.Values
  77. Header http.Header
  78. Retry *retryer
  79. OnRetry func(req *Request) error
  80. Classifier classifier
  81. CopySource *CopySource
  82. IsCustomDomain bool
  83. // CheckETag bool
  84. // CheckCRC32 bool
  85. }
  86. func (rb *requestBuilder) WithRetry(onRetry func(req *Request) error, classifier classifier) *requestBuilder {
  87. if onRetry == nil {
  88. rb.OnRetry = func(req *Request) error { return nil }
  89. } else {
  90. rb.OnRetry = onRetry
  91. }
  92. if classifier == nil {
  93. rb.Classifier = NoRetryClassifier{}
  94. } else {
  95. rb.Classifier = classifier
  96. }
  97. return rb
  98. }
  99. func (rb *requestBuilder) WithCopySource(srcBucket, srcObjectKey string) *requestBuilder {
  100. rb.CopySource = &CopySource{
  101. srcBucket: srcBucket,
  102. srcObjectKey: srcObjectKey,
  103. }
  104. return rb
  105. }
  106. func (rb *requestBuilder) WithQuery(key, value string) *requestBuilder {
  107. rb.Query.Add(key, value)
  108. return rb
  109. }
  110. func (rb *requestBuilder) WithHeader(key, value string) *requestBuilder {
  111. if len(value) > 0 {
  112. rb.Header.Set(key, value)
  113. }
  114. return rb
  115. }
  116. func convertToString(iface interface{}, tag *reflect.StructTag) string {
  117. // return empty string if value is zero except filed with "default" tag
  118. var result string
  119. switch v := iface.(type) {
  120. case string:
  121. result = v
  122. case int:
  123. if v != 0 {
  124. result = strconv.Itoa(v)
  125. } else {
  126. result = tag.Get("default")
  127. }
  128. case int64:
  129. if v != 0 {
  130. result = strconv.Itoa(int(v))
  131. } else {
  132. result = tag.Get("default")
  133. }
  134. case time.Time:
  135. if !v.IsZero() {
  136. result = v.Format(http.TimeFormat)
  137. }
  138. case bool:
  139. result = strconv.FormatBool(v)
  140. default:
  141. if reflect.TypeOf(iface).Kind() == reflect.String {
  142. result = reflect.ValueOf(iface).String()
  143. }
  144. }
  145. return result
  146. }
  147. // WithParams will set filed with tag "header" in input to rb.Header.
  148. func (rb *requestBuilder) WithParams(input interface{}) *requestBuilder {
  149. t := reflect.TypeOf(input)
  150. v := reflect.ValueOf(input)
  151. for i := 0; i < v.NumField(); i++ {
  152. filed := t.Field(i)
  153. if filed.Type.Kind() == reflect.Struct {
  154. rb.WithParams(v.Field(i).Interface())
  155. }
  156. location := filed.Tag.Get("location")
  157. switch location {
  158. case "header":
  159. value := convertToString(v.Field(i).Interface(), &filed.Tag)
  160. if filed.Tag.Get("encodeChinese") == "true" {
  161. value = headerEncode(value)
  162. }
  163. rb.WithHeader(filed.Tag.Get("locationName"), value)
  164. case "headers":
  165. if headers, ok := v.Field(i).Interface().(map[string]string); ok {
  166. for k, v := range headers {
  167. rb.Header.Set(HeaderMetaPrefix+headerEncode(k), headerEncode(v))
  168. }
  169. return rb
  170. }
  171. case "query":
  172. v := convertToString(v.Field(i).Interface(), &filed.Tag)
  173. if len(v) > 0 {
  174. rb.WithQuery(filed.Tag.Get("locationName"), v)
  175. }
  176. }
  177. }
  178. return rb
  179. }
  180. func (rb *requestBuilder) WithContentLength(length int64) *requestBuilder {
  181. rb.ContentLength = &length
  182. return rb
  183. }
  184. func (rb *requestBuilder) hostPath() (string, string) {
  185. if rb.IsCustomDomain {
  186. if len(rb.Object) > 0 {
  187. return rb.Host, "/" + rb.Object
  188. }
  189. return rb.Host, "/"
  190. }
  191. if rb.URLMode == urlModePath {
  192. if len(rb.Object) > 0 {
  193. return rb.Host, "/" + rb.Bucket + "/" + rb.Object
  194. }
  195. return rb.Host, "/" + rb.Bucket // rb.Bucket may be empty ""
  196. }
  197. // URLModeDefault
  198. if len(rb.Bucket) == 0 {
  199. return rb.Host, "/"
  200. }
  201. return rb.Bucket + "." + rb.Host, "/" + rb.Object
  202. }
  203. func (rb *requestBuilder) build(method string, content io.Reader) *Request {
  204. host, path := rb.hostPath()
  205. req := &Request{
  206. Scheme: rb.Scheme,
  207. Method: method,
  208. Host: host,
  209. Path: path,
  210. Content: content,
  211. Query: rb.Query,
  212. Header: rb.Header,
  213. }
  214. if content != nil {
  215. if rb.ContentLength != nil {
  216. req.ContentLength = rb.ContentLength
  217. } else if length := tryResolveLength(content); length >= 0 {
  218. req.ContentLength = &length
  219. }
  220. }
  221. return req
  222. }
  223. func (rb *requestBuilder) Build(method string, content io.Reader) *Request {
  224. req := rb.build(method, content)
  225. if rb.CopySource != nil {
  226. versionID := req.Query.Get("versionId")
  227. req.Query.Del("versionId")
  228. req.Header.Add(HeaderCopySource, copySource(rb.CopySource.srcBucket, rb.CopySource.srcObjectKey, versionID))
  229. }
  230. if rb.Signer != nil {
  231. signed := rb.Signer.SignHeader(req)
  232. for key, values := range signed {
  233. req.Header[key] = values
  234. }
  235. }
  236. return req
  237. }
  238. type roundTripper func(ctx context.Context, req *Request) (*Response, error)
  239. func (rb *requestBuilder) Request(ctx context.Context, method string,
  240. content io.Reader, roundTripper roundTripper) (*Response, error) {
  241. var (
  242. req *Request
  243. res *Response
  244. err error
  245. )
  246. req = rb.Build(method, content)
  247. if rb.Retry != nil {
  248. work := func() (err error) {
  249. err = rb.OnRetry(req)
  250. if err != nil {
  251. return err
  252. }
  253. res, err = roundTripper(ctx, req)
  254. return err
  255. }
  256. err = rb.Retry.Run(ctx, work, rb.Classifier)
  257. if err != nil {
  258. return nil, err
  259. }
  260. return res, err
  261. }
  262. res, err = roundTripper(ctx, req)
  263. return res, err
  264. }
  265. func (rb *requestBuilder) PreSignedURL(method string, ttl time.Duration) (string, error) {
  266. req := rb.build(method, nil)
  267. if rb.Signer == nil {
  268. return "", errors.New("tos: credentials is not set when the tos.Client was created")
  269. }
  270. query := rb.Signer.SignQuery(req, ttl)
  271. for k, v := range query {
  272. req.Query[k] = v
  273. }
  274. return req.URL(), nil
  275. }
  276. type RequestInfo struct {
  277. RequestID string
  278. ID2 string
  279. StatusCode int
  280. Header http.Header
  281. }
  282. type Response struct {
  283. StatusCode int
  284. ContentLength int64
  285. Header http.Header
  286. Body io.ReadCloser
  287. }
  288. func (r *Response) RequestInfo() RequestInfo {
  289. return RequestInfo{
  290. RequestID: r.Header.Get(HeaderRequestID),
  291. ID2: r.Header.Get(HeaderID2),
  292. StatusCode: r.StatusCode,
  293. Header: r.Header,
  294. }
  295. }
  296. func (r *Response) Close() error {
  297. if r.Body != nil {
  298. return r.Body.Close()
  299. }
  300. return nil
  301. }
  302. func marshalOutput(requestID string, reader io.Reader, output interface{}) error {
  303. // Although status code is ok, we need to check if response body is valid.
  304. // If response body is invalid, TosServerError should be raised. But we can't
  305. // unmarshal error from response body now.
  306. data, err := ioutil.ReadAll(reader)
  307. if err != nil {
  308. return &TosServerError{
  309. TosError: TosError{Message: "tos: unmarshal response body failed."},
  310. RequestInfo: RequestInfo{RequestID: requestID},
  311. }
  312. }
  313. data = bytes.TrimSpace(data)
  314. if len(data) == 0 {
  315. return &TosServerError{
  316. TosError: TosError{Message: "server returns empty result"},
  317. RequestInfo: RequestInfo{RequestID: requestID},
  318. }
  319. }
  320. if err = json.Unmarshal(data, output); err != nil {
  321. return &TosServerError{
  322. TosError: TosError{Message: err.Error()},
  323. RequestInfo: RequestInfo{RequestID: requestID},
  324. }
  325. }
  326. return nil
  327. }
  328. func marshalInput(name string, input interface{}) ([]byte, string, error) {
  329. data, err := json.Marshal(input)
  330. if err != nil {
  331. return nil, "", InvalidMarshal
  332. }
  333. sum := md5.Sum(data)
  334. return data, base64.StdEncoding.EncodeToString(sum[:]), nil
  335. }
  336. func fileUnreadLength(file *os.File) (int64, error) {
  337. offset, err := file.Seek(0, io.SeekCurrent)
  338. if err != nil {
  339. return 0, err
  340. }
  341. stat, err := file.Stat()
  342. if err != nil {
  343. return 0, err
  344. }
  345. size := stat.Size()
  346. if offset > size || offset < 0 {
  347. return 0, newTosClientError("tos: unexpected file size and(or) offset", nil)
  348. }
  349. return size - offset, nil
  350. }
  351. func tryResolveLength(reader io.Reader) int64 {
  352. switch v := reader.(type) {
  353. case *bytes.Buffer:
  354. return int64(v.Len())
  355. case *bytes.Reader:
  356. return int64(v.Len())
  357. case *strings.Reader:
  358. return int64(v.Len())
  359. case *os.File:
  360. length, err := fileUnreadLength(v)
  361. if err != nil {
  362. return -1
  363. }
  364. return length
  365. case *io.LimitedReader:
  366. return v.N
  367. case *net.Buffers:
  368. if v != nil {
  369. length := int64(0)
  370. for _, p := range *v {
  371. length += int64(len(p))
  372. }
  373. return length
  374. }
  375. return 0
  376. default:
  377. return -1
  378. }
  379. }
  380. func Int64(value int64) *int64 { return &value }