1 // Copyright 2009 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.
5 // HTTP Response reading and parsing.
19 var respExcludeHeader = map[string]bool{
20 "Content-Length": true,
21 "Transfer-Encoding": true,
25 // Response represents the response from an HTTP request.
27 type Response struct {
28 Status string // e.g. "200 OK"
29 StatusCode int // e.g. 200
30 Proto string // e.g. "HTTP/1.0"
31 ProtoMajor int // e.g. 1
32 ProtoMinor int // e.g. 0
34 // Header maps header keys to values. If the response had multiple
35 // headers with the same key, they will be concatenated, with comma
36 // delimiters. (Section 4.2 of RFC 2616 requires that multiple headers
37 // be semantically equivalent to a comma-delimited sequence.) Values
38 // duplicated by other fields in this struct (e.g., ContentLength) are
39 // omitted from Header.
41 // Keys in the map are canonicalized (see CanonicalHeaderKey).
44 // Body represents the response body.
46 // The http Client and Transport guarantee that Body is always
47 // non-nil, even on responses without a body or responses with
48 // a zero-lengthed body.
51 // ContentLength records the length of the associated content. The
52 // value -1 indicates that the length is unknown. Unless Request.Method
53 // is "HEAD", values >= 0 indicate that the given number of bytes may
57 // Contains transfer encodings from outer-most to inner-most. Value is
58 // nil, means that "identity" encoding is used.
59 TransferEncoding []string
61 // Close records whether the header directed that the connection be
62 // closed after reading Body. The value is advice for clients: neither
63 // ReadResponse nor Response.Write ever closes a connection.
66 // Trailer maps trailer keys to values, in the same
67 // format as the header.
70 // The Request that was sent to obtain this Response.
71 // Request's Body is nil (having already been consumed).
72 // This is only populated for Client requests.
76 // Cookies parses and returns the cookies set in the Set-Cookie headers.
77 func (r *Response) Cookies() []*Cookie {
78 return readSetCookies(r.Header)
81 var ErrNoLocation = errors.New("http: no Location header in response")
83 // Location returns the URL of the response's "Location" header,
84 // if present. Relative redirects are resolved relative to
85 // the Response's Request. ErrNoLocation is returned if no
86 // Location header is present.
87 func (r *Response) Location() (*url.URL, error) {
88 lv := r.Header.Get("Location")
90 return nil, ErrNoLocation
92 if r.Request != nil && r.Request.URL != nil {
93 return r.Request.URL.Parse(lv)
98 // ReadResponse reads and returns an HTTP response from r. The
99 // req parameter specifies the Request that corresponds to
100 // this Response. Clients must call resp.Body.Close when finished
101 // reading resp.Body. After that call, clients can inspect
102 // resp.Trailer to find key/value pairs included in the response
104 func ReadResponse(r *bufio.Reader, req *Request) (resp *Response, err error) {
106 tp := textproto.NewReader(r)
111 // Parse the first line of the response.
112 line, err := tp.ReadLine()
115 err = io.ErrUnexpectedEOF
119 f := strings.SplitN(line, " ", 3)
121 return nil, &badStringError{"malformed HTTP response", line}
127 resp.Status = f[1] + " " + reasonPhrase
128 resp.StatusCode, err = strconv.Atoi(f[1])
130 return nil, &badStringError{"malformed HTTP status code", f[1]}
135 if resp.ProtoMajor, resp.ProtoMinor, ok = ParseHTTPVersion(resp.Proto); !ok {
136 return nil, &badStringError{"malformed HTTP version", resp.Proto}
139 // Parse the response headers.
140 mimeHeader, err := tp.ReadMIMEHeader()
144 resp.Header = Header(mimeHeader)
146 fixPragmaCacheControl(resp.Header)
148 err = readTransfer(resp, r)
156 // RFC2616: Should treat
159 // Cache-Control: no-cache
160 func fixPragmaCacheControl(header Header) {
161 if hp, ok := header["Pragma"]; ok && len(hp) > 0 && hp[0] == "no-cache" {
162 if _, presentcc := header["Cache-Control"]; !presentcc {
163 header["Cache-Control"] = []string{"no-cache"}
168 // ProtoAtLeast returns whether the HTTP protocol used
169 // in the response is at least major.minor.
170 func (r *Response) ProtoAtLeast(major, minor int) bool {
171 return r.ProtoMajor > major ||
172 r.ProtoMajor == major && r.ProtoMinor >= minor
175 // Writes the response (header, body and trailer) in wire format. This method
176 // consults the following fields of the response:
186 // Header, values for non-canonical keys will have unpredictable behavior
188 func (r *Response) Write(w io.Writer) error {
194 text, ok = statusText[r.StatusCode]
196 text = "status code " + strconv.Itoa(r.StatusCode)
199 protoMajor, protoMinor := strconv.Itoa(r.ProtoMajor), strconv.Itoa(r.ProtoMinor)
200 statusCode := strconv.Itoa(r.StatusCode) + " "
201 if strings.HasPrefix(text, statusCode) {
202 text = text[len(statusCode):]
204 io.WriteString(w, "HTTP/"+protoMajor+"."+protoMinor+" "+statusCode+text+"\r\n")
206 // Process Body,ContentLength,Close,Trailer
207 tw, err := newTransferWriter(r)
211 err = tw.WriteHeader(w)
217 err = r.Header.WriteSubset(w, respExcludeHeader)
223 io.WriteString(w, "\r\n")
225 // Write body and trailer
226 err = tw.WriteBody(w)