github.com/endophage/docker@v1.4.2-0.20161027011718-242853499895/client/request.go (about)

     1  package client
     2  
     3  import (
     4  	"bytes"
     5  	"encoding/json"
     6  	"fmt"
     7  	"io"
     8  	"io/ioutil"
     9  	"net"
    10  	"net/http"
    11  	"net/url"
    12  	"os"
    13  	"strings"
    14  
    15  	"github.com/docker/docker/api/types"
    16  	"github.com/docker/docker/api/types/versions"
    17  	"github.com/pkg/errors"
    18  	"golang.org/x/net/context"
    19  	"golang.org/x/net/context/ctxhttp"
    20  )
    21  
    22  // serverResponse is a wrapper for http API responses.
    23  type serverResponse struct {
    24  	body       io.ReadCloser
    25  	header     http.Header
    26  	statusCode int
    27  }
    28  
    29  // head sends an http request to the docker API using the method HEAD.
    30  func (cli *Client) head(ctx context.Context, path string, query url.Values, headers map[string][]string) (serverResponse, error) {
    31  	return cli.sendRequest(ctx, "HEAD", path, query, nil, headers)
    32  }
    33  
    34  // getWithContext sends an http request to the docker API using the method GET with a specific go context.
    35  func (cli *Client) get(ctx context.Context, path string, query url.Values, headers map[string][]string) (serverResponse, error) {
    36  	return cli.sendRequest(ctx, "GET", path, query, nil, headers)
    37  }
    38  
    39  // postWithContext sends an http request to the docker API using the method POST with a specific go context.
    40  func (cli *Client) post(ctx context.Context, path string, query url.Values, obj interface{}, headers map[string][]string) (serverResponse, error) {
    41  	return cli.sendRequest(ctx, "POST", path, query, obj, headers)
    42  }
    43  
    44  func (cli *Client) postRaw(ctx context.Context, path string, query url.Values, body io.Reader, headers map[string][]string) (serverResponse, error) {
    45  	return cli.sendClientRequest(ctx, "POST", path, query, body, headers)
    46  }
    47  
    48  // put sends an http request to the docker API using the method PUT.
    49  func (cli *Client) put(ctx context.Context, path string, query url.Values, obj interface{}, headers map[string][]string) (serverResponse, error) {
    50  	return cli.sendRequest(ctx, "PUT", path, query, obj, headers)
    51  }
    52  
    53  // put sends an http request to the docker API using the method PUT.
    54  func (cli *Client) putRaw(ctx context.Context, path string, query url.Values, body io.Reader, headers map[string][]string) (serverResponse, error) {
    55  	return cli.sendClientRequest(ctx, "PUT", path, query, body, headers)
    56  }
    57  
    58  // delete sends an http request to the docker API using the method DELETE.
    59  func (cli *Client) delete(ctx context.Context, path string, query url.Values, headers map[string][]string) (serverResponse, error) {
    60  	return cli.sendRequest(ctx, "DELETE", path, query, nil, headers)
    61  }
    62  
    63  func (cli *Client) sendRequest(ctx context.Context, method, path string, query url.Values, obj interface{}, headers map[string][]string) (serverResponse, error) {
    64  	var body io.Reader
    65  
    66  	if obj != nil {
    67  		var err error
    68  		body, err = encodeData(obj)
    69  		if err != nil {
    70  			return serverResponse{}, err
    71  		}
    72  		if headers == nil {
    73  			headers = make(map[string][]string)
    74  		}
    75  		headers["Content-Type"] = []string{"application/json"}
    76  	}
    77  
    78  	return cli.sendClientRequest(ctx, method, path, query, body, headers)
    79  }
    80  
    81  func (cli *Client) sendClientRequest(ctx context.Context, method, path string, query url.Values, body io.Reader, headers map[string][]string) (serverResponse, error) {
    82  	serverResp := serverResponse{
    83  		body:       nil,
    84  		statusCode: -1,
    85  	}
    86  
    87  	expectedPayload := (method == "POST" || method == "PUT")
    88  	if expectedPayload && body == nil {
    89  		body = bytes.NewReader([]byte{})
    90  	}
    91  
    92  	req, err := cli.newRequest(method, path, query, body, headers)
    93  	if err != nil {
    94  		return serverResp, err
    95  	}
    96  
    97  	if cli.proto == "unix" || cli.proto == "npipe" {
    98  		// For local communications, it doesn't matter what the host is. We just
    99  		// need a valid and meaningful host name. (See #189)
   100  		req.Host = "docker"
   101  	}
   102  
   103  	req.URL.Host = cli.addr
   104  	req.URL.Scheme = cli.scheme
   105  
   106  	if expectedPayload && req.Header.Get("Content-Type") == "" {
   107  		req.Header.Set("Content-Type", "text/plain")
   108  	}
   109  
   110  	resp, err := ctxhttp.Do(ctx, cli.client, req)
   111  	if err != nil {
   112  		if cli.scheme != "https" && strings.Contains(err.Error(), "malformed HTTP response") {
   113  			return serverResp, fmt.Errorf("%v.\n* Are you trying to connect to a TLS-enabled daemon without TLS?", err)
   114  		}
   115  
   116  		if cli.scheme == "https" && strings.Contains(err.Error(), "bad certificate") {
   117  			return serverResp, fmt.Errorf("The server probably has client authentication (--tlsverify) enabled. Please check your TLS client certification settings: %v", err)
   118  		}
   119  
   120  		// Don't decorate context sentinel errors; users may be comparing to
   121  		// them directly.
   122  		switch err {
   123  		case context.Canceled, context.DeadlineExceeded:
   124  			return serverResp, err
   125  		}
   126  
   127  		if nErr, ok := err.(*url.Error); ok {
   128  			if nErr, ok := nErr.Err.(*net.OpError); ok {
   129  				if os.IsPermission(nErr.Err) {
   130  					return serverResp, errors.Wrapf(err, "Got permission denied while trying to connect to the Docker daemon socket at %v", cli.host)
   131  				}
   132  			}
   133  		}
   134  
   135  		if err, ok := err.(net.Error); ok {
   136  			if err.Timeout() {
   137  				return serverResp, ErrorConnectionFailed(cli.host)
   138  			}
   139  			if !err.Temporary() {
   140  				if strings.Contains(err.Error(), "connection refused") || strings.Contains(err.Error(), "dial unix") {
   141  					return serverResp, ErrorConnectionFailed(cli.host)
   142  				}
   143  			}
   144  		}
   145  
   146  		return serverResp, errors.Wrap(err, "error during connect")
   147  	}
   148  
   149  	if resp != nil {
   150  		serverResp.statusCode = resp.StatusCode
   151  	}
   152  
   153  	if serverResp.statusCode < 200 || serverResp.statusCode >= 400 {
   154  		body, err := ioutil.ReadAll(resp.Body)
   155  		if err != nil {
   156  			return serverResp, err
   157  		}
   158  		if len(body) == 0 {
   159  			return serverResp, fmt.Errorf("Error: request returned %s for API route and version %s, check if the server supports the requested API version", http.StatusText(serverResp.statusCode), req.URL)
   160  		}
   161  
   162  		var errorMessage string
   163  		if (cli.version == "" || versions.GreaterThan(cli.version, "1.23")) &&
   164  			resp.Header.Get("Content-Type") == "application/json" {
   165  			var errorResponse types.ErrorResponse
   166  			if err := json.Unmarshal(body, &errorResponse); err != nil {
   167  				return serverResp, fmt.Errorf("Error reading JSON: %v", err)
   168  			}
   169  			errorMessage = errorResponse.Message
   170  		} else {
   171  			errorMessage = string(body)
   172  		}
   173  
   174  		return serverResp, fmt.Errorf("Error response from daemon: %s", strings.TrimSpace(errorMessage))
   175  	}
   176  
   177  	serverResp.body = resp.Body
   178  	serverResp.header = resp.Header
   179  	return serverResp, nil
   180  }
   181  
   182  func (cli *Client) newRequest(method, path string, query url.Values, body io.Reader, headers map[string][]string) (*http.Request, error) {
   183  	apiPath := cli.getAPIPath(path, query)
   184  	req, err := http.NewRequest(method, apiPath, body)
   185  	if err != nil {
   186  		return nil, err
   187  	}
   188  
   189  	// Add CLI Config's HTTP Headers BEFORE we set the Docker headers
   190  	// then the user can't change OUR headers
   191  	for k, v := range cli.customHTTPHeaders {
   192  		req.Header.Set(k, v)
   193  	}
   194  
   195  	if headers != nil {
   196  		for k, v := range headers {
   197  			req.Header[k] = v
   198  		}
   199  	}
   200  
   201  	return req, nil
   202  }
   203  
   204  func encodeData(data interface{}) (*bytes.Buffer, error) {
   205  	params := bytes.NewBuffer(nil)
   206  	if data != nil {
   207  		if err := json.NewEncoder(params).Encode(data); err != nil {
   208  			return nil, err
   209  		}
   210  	}
   211  	return params, nil
   212  }
   213  
   214  func ensureReaderClosed(response serverResponse) {
   215  	if body := response.body; body != nil {
   216  		// Drain up to 512 bytes and close the body to let the Transport reuse the connection
   217  		io.CopyN(ioutil.Discard, body, 512)
   218  		response.body.Close()
   219  	}
   220  }