transport.go 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. // Copyright 2014 The Go Authors. All rights reserved.
  2. // Use of this source code is governed by a BSD-style
  3. // license that can be found in the LICENSE file.
  4. // Package internal contains support packages for oauth2 package.
  5. package internal
  6. import (
  7. "net/http"
  8. "golang.org/x/net/context"
  9. )
  10. // HTTPClient is the context key to use with golang.org/x/net/context's
  11. // WithValue function to associate an *http.Client value with a context.
  12. var HTTPClient ContextKey
  13. // ContextKey is just an empty struct. It exists so HTTPClient can be
  14. // an immutable public variable with a unique type. It's immutable
  15. // because nobody else can create a ContextKey, being unexported.
  16. type ContextKey struct{}
  17. // ContextClientFunc is a func which tries to return an *http.Client
  18. // given a Context value. If it returns an error, the search stops
  19. // with that error. If it returns (nil, nil), the search continues
  20. // down the list of registered funcs.
  21. type ContextClientFunc func(context.Context) (*http.Client, error)
  22. var contextClientFuncs []ContextClientFunc
  23. func RegisterContextClientFunc(fn ContextClientFunc) {
  24. contextClientFuncs = append(contextClientFuncs, fn)
  25. }
  26. func ContextClient(ctx context.Context) (*http.Client, error) {
  27. if ctx != nil {
  28. if hc, ok := ctx.Value(HTTPClient).(*http.Client); ok {
  29. return hc, nil
  30. }
  31. }
  32. for _, fn := range contextClientFuncs {
  33. c, err := fn(ctx)
  34. if err != nil {
  35. return nil, err
  36. }
  37. if c != nil {
  38. return c, nil
  39. }
  40. }
  41. return http.DefaultClient, nil
  42. }
  43. func ContextTransport(ctx context.Context) http.RoundTripper {
  44. hc, err := ContextClient(ctx)
  45. // This is a rare error case (somebody using nil on App Engine).
  46. if err != nil {
  47. return ErrorTransport{err}
  48. }
  49. return hc.Transport
  50. }
  51. // ErrorTransport returns the specified error on RoundTrip.
  52. // This RoundTripper should be used in rare error cases where
  53. // error handling can be postponed to response handling time.
  54. type ErrorTransport struct{ Err error }
  55. func (t ErrorTransport) RoundTrip(*http.Request) (*http.Response, error) {
  56. return nil, t.Err
  57. }