      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222

    use std::mem;

    use bytes::{Bytes, BytesMut};
    use futures::{Async, Poll};
    use http::header::{self, HeaderName, HeaderValue};
    use http::{HeaderMap, StatusCode, Version};
    use httparse;

    use error::{ParseError, PayloadError};

    use server::h1decoder::{EncodingDecoder, HeaderIndex};
    use server::IoStream;

    use super::response::ClientMessage;
    use super::ClientResponse;

    const MAX_BUFFER_SIZE: usize = 131_072;
    const MAX_HEADERS: usize = 96;

    #[derive(Default)]
    pub struct HttpResponseParser {
        decoder: Option<EncodingDecoder>,
    }

    #[derive(Debug, Fail)]
    pub enum HttpResponseParserError {
        /// Server disconnected
        #[fail(display = "Server disconnected")]
        Disconnect,
        #[fail(display = "{}", _0)]
        Error(#[cause] ParseError),
    }

    impl HttpResponseParser {
        pub fn parse<T>(
            &mut self, io: &mut T, buf: &mut BytesMut,
        ) -> Poll<ClientResponse, HttpResponseParserError>
        where
            T: IoStream,
        {
            // if buf is empty parse_message will always return NotReady, let's avoid that
            if buf.is_empty() {
                match io.read_available(buf) {
                    Ok(Async::Ready(true)) => {
                        return Err(HttpResponseParserError::Disconnect)
                    }
                    Ok(Async::Ready(false)) => (),
                    Ok(Async::NotReady) => return Ok(Async::NotReady),
                    Err(err) => return Err(HttpResponseParserError::Error(err.into())),
                }
            }

            loop {
                match HttpResponseParser::parse_message(buf)
                    .map_err(HttpResponseParserError::Error)?
                {
                    Async::Ready((msg, decoder)) => {
                        self.decoder = decoder;
                        return Ok(Async::Ready(msg));
                    }
                    Async::NotReady => {
                        if buf.capacity() >= MAX_BUFFER_SIZE {
                            return Err(HttpResponseParserError::Error(ParseError::TooLarge));
                        }
                        match io.read_available(buf) {
                            Ok(Async::Ready(true)) => {
                                return Err(HttpResponseParserError::Disconnect)
                            }
                            Ok(Async::Ready(false)) => (),
                            Ok(Async::NotReady) => return Ok(Async::NotReady),
                            Err(err) => {
                                return Err(HttpResponseParserError::Error(err.into()))
                            }
                        }
                    }
                }
            }
        }

        pub fn parse_payload<T>(
            &mut self, io: &mut T, buf: &mut BytesMut,
        ) -> Poll<Option<Bytes>, PayloadError>
        where
            T: IoStream,
        {
            if self.decoder.is_some() {
                loop {
                    // read payload
                    let (not_ready, stream_finished) = match io.read_available(buf) {
                        Ok(Async::Ready(true)) => (false, true),
                        Ok(Async::Ready(false)) => (false, false),
                        Ok(Async::NotReady) => (true, false),
                        Err(err) => return Err(err.into()),
                    };

                    match self.decoder.as_mut().unwrap().decode(buf) {
                        Ok(Async::Ready(Some(b))) => return Ok(Async::Ready(Some(b))),
                        Ok(Async::Ready(None)) => {
                            self.decoder.take();
                            return Ok(Async::Ready(None));
                        }
                        Ok(Async::NotReady) => {
                            if not_ready {
                                return Ok(Async::NotReady);
                            }
                            if stream_finished {
                                return Err(PayloadError::Incomplete);
                            }
                        }
                        Err(err) => return Err(err.into()),
                    }
                }
            } else {
                Ok(Async::Ready(None))
            }
        }

        fn parse_message(
            buf: &mut BytesMut,
        ) -> Poll<(ClientResponse, Option<EncodingDecoder>), ParseError> {
            // Unsafe: we read only this data only after httparse parses headers into.
            // performance bump for pipeline benchmarks.
            let mut headers: [HeaderIndex; MAX_HEADERS] = unsafe { mem::uninitialized() };

            let (len, version, status, headers_len) = {
                let mut parsed: [httparse::Header; MAX_HEADERS] =
                    unsafe { mem::uninitialized() };

                let mut resp = httparse::Response::new(&mut parsed);
                match resp.parse(buf)? {
                    httparse::Status::Complete(len) => {
                        let version = if resp.version.unwrap_or(1) == 1 {
                            Version::HTTP_11
                        } else {
                            Version::HTTP_10
                        };
                        HeaderIndex::record(buf, resp.headers, &mut headers);
                        let status = StatusCode::from_u16(resp.code.unwrap())
                            .map_err(|_| ParseError::Status)?;

                        (len, version, status, resp.headers.len())
                    }
                    httparse::Status::Partial => return Ok(Async::NotReady),
                }
            };

            let slice = buf.split_to(len).freeze();

            // convert headers
            let mut hdrs = HeaderMap::new();
            for idx in headers[..headers_len].iter() {
                if let Ok(name) = HeaderName::from_bytes(&slice[idx.name.0..idx.name.1]) {
                    // Unsafe: httparse check header value for valid utf-8
                    let value = unsafe {
                        HeaderValue::from_shared_unchecked(
                            slice.slice(idx.value.0, idx.value.1),
                        )
                    };
                    hdrs.append(name, value);
                } else {
                    return Err(ParseError::Header);
                }
            }

            let decoder = if status == StatusCode::SWITCHING_PROTOCOLS {
                Some(EncodingDecoder::eof())
            } else if let Some(len) = hdrs.get(header::CONTENT_LENGTH) {
                // Content-Length
                if let Ok(s) = len.to_str() {
                    if let Ok(len) = s.parse::<u64>() {
                        Some(EncodingDecoder::length(len))
                    } else {
                        debug!("illegal Content-Length: {:?}", len);
                        return Err(ParseError::Header);
                    }
                } else {
                    debug!("illegal Content-Length: {:?}", len);
                    return Err(ParseError::Header);
                }
            } else if chunked(&hdrs)? {
                // Chunked encoding
                Some(EncodingDecoder::chunked())
            } else {
                None
            };

            if let Some(decoder) = decoder {
                Ok(Async::Ready((
                    ClientResponse::new(ClientMessage {
                        status,
                        version,
                        headers: hdrs,
                        cookies: None,
                    }),
                    Some(decoder),
                )))
            } else {
                Ok(Async::Ready((
                    ClientResponse::new(ClientMessage {
                        status,
                        version,
                        headers: hdrs,
                        cookies: None,
                    }),
                    None,
                )))
            }
        }
    }

    /// Check if request has chunked transfer encoding
    pub fn chunked(headers: &HeaderMap) -> Result<bool, ParseError> {
        if let Some(encodings) = headers.get(header::TRANSFER_ENCODING) {
            if let Ok(s) = encodings.to_str() {
                Ok(s.to_lowercase().contains("chunked"))
            } else {
                Err(ParseError::Header)
            }
        } else {
            Ok(false)
        }
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)