1
0
Fork 0
mirror of https://github.com/actix/actix-web.git synced 2024-12-04 23:36:34 +00:00
actix-web/src/httprequest.rs

1033 lines
33 KiB
Rust
Raw Normal View History

//! HTTP Request message related code.
2017-11-27 03:00:57 +00:00
use std::{str, fmt, mem};
2017-11-27 04:32:12 +00:00
use std::rc::Rc;
use std::net::SocketAddr;
use std::collections::HashMap;
use bytes::{Bytes, BytesMut};
2017-12-08 00:40:29 +00:00
use cookie::Cookie;
2017-12-21 04:30:54 +00:00
use futures::{Async, Future, Stream, Poll};
2017-12-08 00:40:29 +00:00
use http_range::HttpRange;
2017-12-21 04:30:54 +00:00
use serde::de::DeserializeOwned;
use mime::Mime;
2017-12-09 21:25:06 +00:00
use url::{Url, form_urlencoded};
2017-12-01 03:01:25 +00:00
use http::{header, Uri, Method, Version, HeaderMap, Extensions};
2017-12-06 01:09:15 +00:00
use info::ConnectionInfo;
use param::Params;
2017-12-07 00:26:27 +00:00
use router::Router;
use payload::{Payload, ReadAny};
2017-12-21 04:30:54 +00:00
use json::JsonBody;
2017-11-16 06:06:28 +00:00
use multipart::Multipart;
2017-12-15 03:34:31 +00:00
use helpers::SharedHttpMessage;
use error::{ParseError, UrlGenerationError,
CookieParseError, HttpRangeError, PayloadError, UrlencodedError};
2017-12-06 01:09:15 +00:00
2017-12-09 12:33:40 +00:00
pub struct HttpMessage {
pub version: Version,
pub method: Method,
pub uri: Uri,
pub headers: HeaderMap,
pub extensions: Extensions,
pub params: Params<'static>,
pub cookies: Option<Vec<Cookie<'static>>>,
2017-12-28 03:02:29 +00:00
pub query: Params<'static>,
pub query_loaded: bool,
2017-12-09 12:33:40 +00:00
pub addr: Option<SocketAddr>,
2017-12-13 05:32:58 +00:00
pub payload: Option<Payload>,
2017-12-09 12:33:40 +00:00
pub info: Option<ConnectionInfo<'static>>,
}
2017-11-27 04:32:12 +00:00
impl Default for HttpMessage {
2017-11-27 04:32:12 +00:00
fn default() -> HttpMessage {
HttpMessage {
method: Method::GET,
2017-12-01 03:01:25 +00:00
uri: Uri::default(),
version: Version::HTTP_11,
2017-12-16 06:49:48 +00:00
headers: HeaderMap::with_capacity(16),
2017-12-28 03:19:28 +00:00
params: Params::new(),
query: Params::new(),
2017-12-28 03:02:29 +00:00
query_loaded: false,
2017-12-08 02:00:20 +00:00
cookies: None,
addr: None,
2017-12-13 05:32:58 +00:00
payload: None,
2017-11-27 04:32:12 +00:00
extensions: Extensions::new(),
2017-12-06 01:09:15 +00:00
info: None,
}
}
2017-11-27 04:32:12 +00:00
}
2017-12-09 12:33:40 +00:00
impl HttpMessage {
/// Checks if a connection should be kept alive.
2017-12-16 06:49:48 +00:00
#[inline]
2017-12-09 12:33:40 +00:00
pub fn keep_alive(&self) -> bool {
if let Some(conn) = self.headers.get(header::CONNECTION) {
if let Ok(conn) = conn.to_str() {
if self.version == Version::HTTP_10 && conn.contains("keep-alive") {
true
} else {
self.version == Version::HTTP_11 &&
!(conn.contains("close") || conn.contains("upgrade"))
}
} else {
false
}
} else {
self.version != Version::HTTP_10
}
}
2017-12-15 03:34:31 +00:00
2017-12-16 06:49:48 +00:00
#[inline]
2017-12-15 03:34:31 +00:00
pub(crate) fn reset(&mut self) {
self.headers.clear();
self.extensions.clear();
self.params.clear();
2017-12-28 03:02:29 +00:00
self.query.clear();
self.query_loaded = false;
2017-12-16 06:49:48 +00:00
self.cookies = None;
self.addr = None;
self.info = None;
2017-12-19 08:18:57 +00:00
self.payload = None;
2017-12-15 03:34:31 +00:00
}
2017-12-09 12:33:40 +00:00
}
2017-11-27 04:32:12 +00:00
/// An HTTP Request
2017-12-26 17:00:45 +00:00
pub struct HttpRequest<S=()>(SharedHttpMessage, Option<Rc<S>>, Option<Router>);
2017-11-27 04:32:12 +00:00
2017-11-27 05:18:38 +00:00
impl HttpRequest<()> {
2017-11-27 04:32:12 +00:00
/// Construct a new Request.
#[inline]
2017-12-01 03:01:25 +00:00
pub fn new(method: Method, uri: Uri,
2017-12-13 05:32:58 +00:00
version: Version, headers: HeaderMap, payload: Option<Payload>) -> HttpRequest
2017-11-27 04:32:12 +00:00
{
HttpRequest(
2017-12-15 03:34:31 +00:00
SharedHttpMessage::from_message(HttpMessage {
2017-11-27 04:32:12 +00:00
method: method,
2017-12-01 03:01:25 +00:00
uri: uri,
2017-11-27 04:32:12 +00:00
version: version,
headers: headers,
2017-12-28 03:19:28 +00:00
params: Params::new(),
query: Params::new(),
2017-12-28 03:02:29 +00:00
query_loaded: false,
2017-12-08 02:00:20 +00:00
cookies: None,
2017-11-27 04:32:12 +00:00
addr: None,
payload: payload,
extensions: Extensions::new(),
2017-12-06 01:09:15 +00:00
info: None,
2017-12-09 21:25:06 +00:00
}),
2017-12-13 05:32:58 +00:00
None,
2017-12-09 21:25:06 +00:00
None,
)
}
2017-12-16 06:49:48 +00:00
#[inline(always)]
#[cfg_attr(feature = "cargo-clippy", allow(inline_always))]
2017-12-15 03:34:31 +00:00
pub(crate) fn from_message(msg: SharedHttpMessage) -> HttpRequest {
HttpRequest(msg, None, None)
}
2017-12-16 06:49:48 +00:00
#[inline]
2017-11-27 05:18:38 +00:00
/// Construct new http request with state.
2017-12-26 17:00:45 +00:00
pub fn with_state<S>(self, state: Rc<S>, router: Router) -> HttpRequest<S> {
2017-12-13 05:32:58 +00:00
HttpRequest(self.0, Some(state), Some(router))
2017-11-27 05:18:38 +00:00
}
2018-01-03 18:57:57 +00:00
#[cfg(test)]
/// Construct new http request with state.
pub(crate) fn with_state_no_router<S>(self, state: Rc<S>) -> HttpRequest<S> {
HttpRequest(self.0, Some(state), None)
}
2017-11-27 05:18:38 +00:00
}
impl<S> HttpRequest<S> {
2018-01-01 01:26:32 +00:00
#[inline]
/// Construct new http request with state.
pub fn change_state<NS>(&self, state: Rc<NS>) -> HttpRequest<NS> {
HttpRequest(self.0.clone(), Some(state), self.2.clone())
2018-01-01 01:26:32 +00:00
}
2017-12-16 06:49:48 +00:00
#[inline]
/// Construct new http request without state.
2017-12-19 21:11:19 +00:00
pub(crate) fn clone_without_state(&self) -> HttpRequest {
2017-12-15 03:34:31 +00:00
HttpRequest(self.0.clone(), None, None)
}
2017-12-08 01:38:18 +00:00
// get mutable reference for inner message
// mutable reference should not be returned as result for request's method
2017-12-16 06:49:48 +00:00
#[inline(always)]
#[cfg_attr(feature = "cargo-clippy", allow(mut_from_ref, inline_always))]
2017-12-27 03:48:02 +00:00
pub(crate) fn as_mut(&self) -> &mut HttpMessage {
2017-12-15 03:34:31 +00:00
self.0.get_mut()
2017-11-27 04:32:12 +00:00
}
2017-12-16 06:49:48 +00:00
#[inline(always)]
#[cfg_attr(feature = "cargo-clippy", allow(mut_from_ref, inline_always))]
2017-12-15 03:34:31 +00:00
fn as_ref(&self) -> &HttpMessage {
self.0.get_ref()
}
#[inline]
2017-12-09 12:33:40 +00:00
pub(crate) fn get_inner(&mut self) -> &mut HttpMessage {
self.as_mut()
}
2017-11-27 05:18:38 +00:00
/// Shared application state
2017-12-07 00:26:27 +00:00
#[inline]
2017-11-27 05:18:38 +00:00
pub fn state(&self) -> &S {
2017-12-13 05:32:58 +00:00
self.1.as_ref().unwrap()
2017-11-27 05:18:38 +00:00
}
/// Protocol extensions.
#[inline]
pub fn extensions(&mut self) -> &mut Extensions {
2017-11-27 04:32:12 +00:00
&mut self.as_mut().extensions
}
2017-12-06 01:09:15 +00:00
#[doc(hidden)]
pub fn prefix_len(&self) -> usize {
2017-12-16 06:49:48 +00:00
if let Some(router) = self.router() { router.prefix().len() } else { 0 }
2017-12-06 01:09:15 +00:00
}
2017-12-01 03:01:25 +00:00
/// Read the Request Uri.
#[inline]
2017-12-15 03:34:31 +00:00
pub fn uri(&self) -> &Uri { &self.as_ref().uri }
2017-12-01 03:01:25 +00:00
/// Read the Request method.
#[inline]
2017-12-15 03:34:31 +00:00
pub fn method(&self) -> &Method { &self.as_ref().method }
/// Read the Request Version.
2017-11-10 21:26:12 +00:00
#[inline]
pub fn version(&self) -> Version {
2017-12-15 03:34:31 +00:00
self.as_ref().version
}
/// Read the Request Headers.
2017-11-10 21:26:12 +00:00
#[inline]
pub fn headers(&self) -> &HeaderMap {
2017-12-15 03:34:31 +00:00
&self.as_ref().headers
}
2017-12-08 17:24:05 +00:00
#[doc(hidden)]
#[inline]
2017-12-06 05:38:52 +00:00
pub fn headers_mut(&mut self) -> &mut HeaderMap {
&mut self.as_mut().headers
}
/// The target path of this Request.
#[inline]
pub fn path(&self) -> &str {
2017-12-19 19:46:11 +00:00
self.uri().path()
}
2018-01-15 21:47:25 +00:00
/// Get *ConnectionInfo* for correct request.
2017-12-08 01:38:18 +00:00
pub fn connection_info(&self) -> &ConnectionInfo {
2017-12-15 03:34:31 +00:00
if self.as_ref().info.is_none() {
2017-12-06 01:09:15 +00:00
let info: ConnectionInfo<'static> = unsafe{
mem::transmute(ConnectionInfo::new(self))};
self.as_mut().info = Some(info);
}
2017-12-15 03:34:31 +00:00
self.as_ref().info.as_ref().unwrap()
2017-11-29 23:07:49 +00:00
}
/// Generate url for named resource
///
/// ```rust
/// # extern crate actix_web;
/// # use actix_web::*;
/// # use actix_web::httpcodes::*;
/// #
/// fn index(req: HttpRequest) -> HttpResponse {
/// let url = req.url_for("foo", &["1", "2", "3"]); // <- generate url for "foo" resource
/// HTTPOk.into()
/// }
///
/// fn main() {
/// let app = Application::new()
/// .resource("/test/{one}/{two}/{three}", |r| {
/// r.name("foo"); // <- set resource name, then it could be used in `url_for`
/// r.method(Method::GET).f(|_| httpcodes::HTTPOk);
/// })
/// .finish();
/// }
/// ```
2017-12-08 01:38:18 +00:00
pub fn url_for<U, I>(&self, name: &str, elements: U) -> Result<Url, UrlGenerationError>
2017-12-07 00:26:27 +00:00
where U: IntoIterator<Item=I>,
I: AsRef<str>,
{
if self.router().is_none() {
Err(UrlGenerationError::RouterNotAvailable)
} else {
let path = self.router().unwrap().resource_path(name, elements)?;
if path.starts_with('/') {
2017-12-08 01:38:18 +00:00
let conn = self.connection_info();
Ok(Url::parse(&format!("{}://{}{}", conn.scheme(), conn.host(), path))?)
} else {
Ok(Url::parse(&path)?)
}
2017-12-07 00:26:27 +00:00
}
}
/// This method returns reference to current `Router` object.
2017-12-07 00:26:27 +00:00
#[inline]
2017-12-26 17:00:45 +00:00
pub fn router(&self) -> Option<&Router> {
2017-12-07 00:26:27 +00:00
self.2.as_ref()
}
/// Peer socket address
///
2018-01-15 21:47:25 +00:00
/// Peer address is actual socket address, if proxy is used in front of
/// actix http server, then peer address would be address of this proxy.
///
/// To get client connection information `connection_info()` method should be used.
2017-11-10 21:26:12 +00:00
#[inline]
2017-12-06 05:38:52 +00:00
pub fn peer_addr(&self) -> Option<&SocketAddr> {
2017-12-15 03:34:31 +00:00
self.as_ref().addr.as_ref()
}
2017-12-07 00:26:27 +00:00
#[inline]
2017-12-06 05:38:52 +00:00
pub(crate) fn set_peer_addr(&mut self, addr: Option<SocketAddr>) {
2017-11-27 04:32:12 +00:00
self.as_mut().addr = addr
}
2017-12-28 03:02:29 +00:00
/// Get a reference to the Params object.
/// Params is a container for url query parameters.
pub fn query(&self) -> &Params {
if !self.as_ref().query_loaded {
let params: &mut Params = unsafe{ mem::transmute(&mut self.as_mut().query) };
self.as_mut().query_loaded = true;
for (key, val) in form_urlencoded::parse(self.query_string().as_ref()) {
params.add(key, val);
}
}
2017-12-28 03:02:29 +00:00
unsafe{ mem::transmute(&self.as_ref().query) }
2017-10-16 16:43:10 +00:00
}
/// The query string in the URL.
///
/// E.g., id=10
#[inline]
pub fn query_string(&self) -> &str {
2017-12-19 19:46:11 +00:00
if let Some(query) = self.uri().query().as_ref() {
2017-12-01 03:01:25 +00:00
query
} else {
""
}
}
2017-12-08 02:00:20 +00:00
/// Load request cookies.
pub fn cookies(&self) -> Result<&Vec<Cookie<'static>>, CookieParseError> {
2017-12-15 03:34:31 +00:00
if self.as_ref().cookies.is_none() {
2017-11-27 04:32:12 +00:00
let msg = self.as_mut();
2017-12-08 02:00:20 +00:00
let mut cookies = Vec::new();
2017-11-27 04:32:12 +00:00
if let Some(val) = msg.headers.get(header::COOKIE) {
2017-11-09 05:01:56 +00:00
let s = str::from_utf8(val.as_bytes())
.map_err(CookieParseError::from)?;
for cookie in s.split("; ") {
2017-12-08 02:00:20 +00:00
cookies.push(Cookie::parse_encoded(cookie)?.into_owned());
}
}
msg.cookies = Some(cookies)
}
2017-12-15 03:34:31 +00:00
Ok(self.as_ref().cookies.as_ref().unwrap())
2017-12-08 02:00:20 +00:00
}
/// Return request cookie.
pub fn cookie(&self, name: &str) -> Option<&Cookie> {
if let Ok(cookies) = self.cookies() {
for cookie in cookies {
if cookie.name() == name {
return Some(cookie)
2017-11-09 05:01:56 +00:00
}
}
}
2017-12-08 02:00:20 +00:00
None
}
/// Get a reference to the Params object.
/// Params is a container for url parameters.
/// Route supports glob patterns: * for a single wildcard segment and :param
/// for matching storing that segment of the request url in the Params object.
#[inline]
pub fn match_info(&self) -> &Params {
2017-12-15 03:34:31 +00:00
unsafe{ mem::transmute(&self.as_ref().params) }
}
2017-12-19 19:46:11 +00:00
/// Get mutable reference to request's Params.
2017-12-07 00:26:27 +00:00
#[inline]
pub(crate) fn match_info_mut(&mut self) -> &mut Params {
unsafe{ mem::transmute(&mut self.as_mut().params) }
}
/// Checks if a connection should be kept alive.
pub fn keep_alive(&self) -> bool {
2017-12-16 06:49:48 +00:00
self.as_ref().keep_alive()
}
2017-12-19 19:46:11 +00:00
/// Read the request content type. If request does not contain
/// *Content-Type* header, empty str get returned.
pub fn content_type(&self) -> &str {
2017-12-15 03:34:31 +00:00
if let Some(content_type) = self.headers().get(header::CONTENT_TYPE) {
if let Ok(content_type) = content_type.to_str() {
return content_type.split(';').next().unwrap().trim()
}
}
""
}
/// Convert the request content type to a known mime type.
pub fn mime_type(&self) -> Option<Mime> {
if let Some(content_type) = self.headers().get(header::CONTENT_TYPE) {
if let Ok(content_type) = content_type.to_str() {
return match content_type.parse() {
Ok(mt) => Some(mt),
Err(_) => None
};
}
}
None
}
/// Check if request requires connection upgrade
pub(crate) fn upgrade(&self) -> bool {
2017-12-15 03:34:31 +00:00
if let Some(conn) = self.as_ref().headers.get(header::CONNECTION) {
if let Ok(s) = conn.to_str() {
return s.to_lowercase().contains("upgrade")
}
}
2017-12-15 03:34:31 +00:00
self.as_ref().method == Method::CONNECT
}
/// Check if request has chunked transfer encoding
pub fn chunked(&self) -> Result<bool, ParseError> {
2017-12-15 03:34:31 +00:00
if let Some(encodings) = self.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)
}
}
/// Parses Range HTTP header string as per RFC 2616.
/// `size` is full size of response (file).
2017-11-16 06:06:28 +00:00
pub fn range(&self, size: u64) -> Result<Vec<HttpRange>, HttpRangeError> {
2017-12-15 03:34:31 +00:00
if let Some(range) = self.headers().get(header::RANGE) {
HttpRange::parse(unsafe{str::from_utf8_unchecked(range.as_bytes())}, size)
2017-11-16 06:06:28 +00:00
.map_err(|e| e.into())
} else {
Ok(Vec::new())
}
}
2017-11-27 03:00:57 +00:00
/// Returns reference to the associated http payload.
#[inline]
2017-12-19 08:18:57 +00:00
pub fn payload(&self) -> &Payload {
let msg = self.as_mut();
if msg.payload.is_none() {
msg.payload = Some(Payload::empty());
}
msg.payload.as_ref().unwrap()
2017-11-27 03:00:57 +00:00
}
/// Returns mutable reference to the associated http payload.
#[inline]
2017-12-19 08:18:57 +00:00
pub fn payload_mut(&mut self) -> &mut Payload {
let msg = self.as_mut();
if msg.payload.is_none() {
msg.payload = Some(Payload::empty());
}
msg.payload.as_mut().unwrap()
2017-11-27 03:00:57 +00:00
}
/// Load request body.
///
/// By default only 256Kb payload reads to a memory, then `BAD REQUEST`
/// http response get returns to a peer. Use `RequestBody::limit()`
/// method to change upper limit.
///
/// ```rust
/// # extern crate bytes;
/// # extern crate actix_web;
/// # extern crate futures;
/// # #[macro_use] extern crate serde_derive;
/// use actix_web::*;
/// use bytes::Bytes;
/// use futures::future::Future;
///
/// fn index(mut req: HttpRequest) -> Box<Future<Item=HttpResponse, Error=Error>> {
/// req.body() // <- get Body future
/// .limit(1024) // <- change max size of the body to a 1kb
/// .from_err()
/// .and_then(|bytes: Bytes| { // <- complete body
/// println!("==== BODY ==== {:?}", bytes);
/// Ok(httpcodes::HTTPOk.into())
/// }).responder()
/// }
/// # fn main() {}
/// ```
2018-01-03 18:57:57 +00:00
pub fn body(&self) -> RequestBody {
RequestBody::from_request(self)
}
2017-12-21 07:19:21 +00:00
/// Return stream to http payload processes as multipart.
///
/// Content-type: multipart/form-data;
2017-12-21 07:19:21 +00:00
///
/// ```rust
/// # extern crate actix;
/// # extern crate actix_web;
/// # extern crate env_logger;
/// # extern crate futures;
/// # use std::str;
/// # use actix::*;
/// # use actix_web::*;
/// # use futures::{Future, Stream};
/// # use futures::future::{ok, result, Either};
/// fn index(mut req: HttpRequest) -> Box<Future<Item=HttpResponse, Error=Error>> {
/// req.multipart().from_err() // <- get multipart stream for current request
/// .and_then(|item| match item { // <- iterate over multipart items
/// multipart::MultipartItem::Field(field) => {
/// // Field in turn is stream of *Bytes* object
/// Either::A(field.from_err()
/// .map(|c| println!("-- CHUNK: \n{:?}", str::from_utf8(&c)))
/// .finish())
/// },
/// multipart::MultipartItem::Nested(mp) => {
/// // Or item could be nested Multipart stream
/// Either::B(ok(()))
/// }
/// })
/// .finish() // <- Stream::finish() combinator from actix
2018-01-01 01:26:32 +00:00
/// .map(|_| httpcodes::HTTPOk.into())
2017-12-21 07:19:21 +00:00
/// .responder()
/// }
/// # fn main() {}
/// ```
2017-12-19 17:51:28 +00:00
pub fn multipart(&mut self) -> Multipart {
Multipart::from_request(self)
}
/// Parse `application/x-www-form-urlencoded` encoded body.
2017-10-19 06:43:50 +00:00
/// Return `UrlEncoded` future. It resolves to a `HashMap<String, String>` which
/// contains decoded parameters.
///
/// Returns error:
///
/// * content type is not `application/x-www-form-urlencoded`
/// * transfer encoding is `chunked`.
/// * content-length is greater than 256k
2017-12-19 22:03:01 +00:00
///
/// ```rust
/// # extern crate actix_web;
/// # extern crate futures;
/// use actix_web::*;
/// use futures::future::{Future, ok};
///
/// fn index(mut req: HttpRequest) -> Box<Future<Item=HttpResponse, Error=Error>> {
2017-12-21 05:06:04 +00:00
/// req.urlencoded() // <- get UrlEncoded future
/// .from_err()
/// .and_then(|params| { // <- url encoded parameters
/// println!("==== BODY ==== {:?}", params);
2018-01-01 01:26:32 +00:00
/// ok(httpcodes::HTTPOk.into())
2017-12-21 05:06:04 +00:00
/// })
/// .responder()
2017-12-19 22:03:01 +00:00
/// }
/// # fn main() {}
/// ```
2018-01-03 18:57:57 +00:00
pub fn urlencoded(&self) -> UrlEncoded {
2017-12-19 22:03:01 +00:00
UrlEncoded::from_request(self)
}
2017-12-21 04:30:54 +00:00
/// Parse `application/json` encoded body.
/// Return `JsonBody<T>` future. It resolves to a `T` value.
///
/// Returns error:
///
/// * content type is not `application/json`
/// * content length is greater than 256k
///
/// ```rust
/// # extern crate actix_web;
/// # extern crate futures;
/// # #[macro_use] extern crate serde_derive;
/// use actix_web::*;
/// use futures::future::{Future, ok};
///
/// #[derive(Deserialize, Debug)]
/// struct MyObj {
/// name: String,
/// }
///
/// fn index(mut req: HttpRequest) -> Box<Future<Item=HttpResponse, Error=Error>> {
/// req.json() // <- get JsonBody future
/// .from_err()
/// .and_then(|val: MyObj| { // <- deserialized value
/// println!("==== BODY ==== {:?}", val);
2018-01-01 01:26:32 +00:00
/// Ok(httpcodes::HTTPOk.into())
2017-12-21 04:30:54 +00:00
/// }).responder()
/// }
/// # fn main() {}
/// ```
2018-01-03 18:57:57 +00:00
pub fn json<T: DeserializeOwned>(&self) -> JsonBody<S, T> {
2017-12-21 04:30:54 +00:00
JsonBody::from_request(self)
}
}
2017-11-27 06:20:28 +00:00
impl Default for HttpRequest<()> {
/// Construct default request
fn default() -> HttpRequest {
2017-12-15 03:34:31 +00:00
HttpRequest(SharedHttpMessage::default(), None, None)
2017-11-27 06:20:28 +00:00
}
}
2017-11-27 05:18:38 +00:00
impl<S> Clone for HttpRequest<S> {
fn clone(&self) -> HttpRequest<S> {
2017-12-15 03:34:31 +00:00
HttpRequest(self.0.clone(), self.1.clone(), None)
2017-11-27 04:32:12 +00:00
}
}
2017-11-27 05:18:38 +00:00
impl<S> fmt::Debug for HttpRequest<S> {
2017-10-19 06:43:50 +00:00
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let res = write!(f, "\nHttpRequest {:?} {}:{}\n",
2017-12-15 03:34:31 +00:00
self.as_ref().version, self.as_ref().method, self.as_ref().uri);
if !self.query_string().is_empty() {
let _ = write!(f, " query: ?{:?}\n", self.query_string());
}
if !self.match_info().is_empty() {
2017-12-15 03:34:31 +00:00
let _ = write!(f, " params: {:?}\n", self.as_ref().params);
2017-10-19 06:43:50 +00:00
}
let _ = write!(f, " headers:\n");
2017-12-15 03:34:31 +00:00
for key in self.as_ref().headers.keys() {
let vals: Vec<_> = self.as_ref().headers.get_all(key).iter().collect();
2017-10-19 06:43:50 +00:00
if vals.len() > 1 {
let _ = write!(f, " {:?}: {:?}\n", key, vals);
} else {
let _ = write!(f, " {:?}: {:?}\n", key, vals[0]);
}
}
2017-10-19 06:43:50 +00:00
res
}
}
/// Future that resolves to a parsed urlencoded values.
pub struct UrlEncoded {
pl: Payload,
body: BytesMut,
2017-12-19 22:03:01 +00:00
error: Option<UrlencodedError>,
}
impl UrlEncoded {
2018-01-03 18:57:57 +00:00
pub fn from_request<S>(req: &HttpRequest<S>) -> UrlEncoded {
2017-12-19 22:03:01 +00:00
let mut encoded = UrlEncoded {
2018-01-03 18:57:57 +00:00
pl: req.payload().clone(),
2017-12-19 22:03:01 +00:00
body: BytesMut::new(),
error: None
};
if let Ok(true) = req.chunked() {
encoded.error = Some(UrlencodedError::Chunked);
} else if let Some(len) = req.headers().get(header::CONTENT_LENGTH) {
if let Ok(s) = len.to_str() {
if let Ok(len) = s.parse::<u64>() {
if len > 262_144 {
encoded.error = Some(UrlencodedError::Overflow);
}
} else {
encoded.error = Some(UrlencodedError::UnknownLength);
}
} else {
encoded.error = Some(UrlencodedError::UnknownLength);
}
}
// check content type
if encoded.error.is_none() {
if let Some(content_type) = req.headers().get(header::CONTENT_TYPE) {
if let Ok(content_type) = content_type.to_str() {
if content_type.to_lowercase() == "application/x-www-form-urlencoded" {
return encoded
}
}
}
encoded.error = Some(UrlencodedError::ContentType);
return encoded
}
encoded
}
}
impl Future for UrlEncoded {
type Item = HashMap<String, String>;
2017-12-19 22:03:01 +00:00
type Error = UrlencodedError;
fn poll(&mut self) -> Poll<Self::Item, Self::Error> {
2017-12-19 22:03:01 +00:00
if let Some(err) = self.error.take() {
return Err(err)
}
loop {
return match self.pl.poll() {
Ok(Async::NotReady) => Ok(Async::NotReady),
Ok(Async::Ready(None)) => {
let mut m = HashMap::new();
for (k, v) in form_urlencoded::parse(&self.body) {
m.insert(k.into(), v.into());
}
Ok(Async::Ready(m))
},
2017-10-27 06:14:33 +00:00
Ok(Async::Ready(Some(item))) => {
2017-12-19 08:18:57 +00:00
self.body.extend_from_slice(&item);
2017-10-27 06:14:33 +00:00
continue
},
2017-12-19 22:03:01 +00:00
Err(err) => Err(err.into()),
}
}
}
}
2017-10-23 21:26:01 +00:00
/// Future that resolves to a complete request body.
pub struct RequestBody {
pl: ReadAny,
body: BytesMut,
limit: usize,
error: Option<PayloadError>,
}
impl RequestBody {
/// Create `RequestBody` for request.
2018-01-03 18:57:57 +00:00
pub fn from_request<S>(req: &HttpRequest<S>) -> RequestBody {
let mut body = RequestBody {
pl: req.payload().readany(),
body: BytesMut::new(),
limit: 262_144,
error: None
};
if let Some(len) = req.headers().get(header::CONTENT_LENGTH) {
if let Ok(s) = len.to_str() {
if let Ok(len) = s.parse::<u64>() {
if len > 262_144 {
body.error = Some(PayloadError::Overflow);
}
} else {
body.error = Some(PayloadError::UnknownLength);
}
} else {
body.error = Some(PayloadError::UnknownLength);
}
}
body
}
/// Change max size of payload. By default max size is 256Kb
pub fn limit(mut self, limit: usize) -> Self {
self.limit = limit;
self
}
}
impl Future for RequestBody {
type Item = Bytes;
type Error = PayloadError;
fn poll(&mut self) -> Poll<Self::Item, Self::Error> {
if let Some(err) = self.error.take() {
return Err(err)
}
loop {
return match self.pl.poll() {
Ok(Async::NotReady) => Ok(Async::NotReady),
Ok(Async::Ready(None)) => {
Ok(Async::Ready(self.body.take().freeze()))
},
Ok(Async::Ready(Some(chunk))) => {
if (self.body.len() + chunk.len()) > self.limit {
Err(PayloadError::Overflow)
} else {
self.body.extend_from_slice(&chunk);
continue
}
},
Err(err) => Err(err),
}
}
}
}
2017-10-23 21:26:01 +00:00
#[cfg(test)]
mod tests {
use super::*;
use mime;
2017-12-07 00:26:27 +00:00
use http::Uri;
2017-12-01 03:01:25 +00:00
use std::str::FromStr;
use router::Pattern;
2017-12-07 00:26:27 +00:00
use resource::Resource;
2017-12-27 03:48:02 +00:00
use test::TestRequest;
2017-12-29 19:49:36 +00:00
use server::ServerSettings;
2017-10-23 21:26:01 +00:00
2017-12-13 19:16:26 +00:00
#[test]
fn test_debug() {
2017-12-27 03:48:02 +00:00
let req = TestRequest::with_header("content-type", "text/plain").finish();
2017-12-13 19:16:26 +00:00
let dbg = format!("{:?}", req);
assert!(dbg.contains("HttpRequest"));
}
#[test]
fn test_content_type() {
let req = TestRequest::with_header("content-type", "text/plain").finish();
assert_eq!(req.content_type(), "text/plain");
let req = TestRequest::with_header(
"content-type", "application/json; charset=utf=8").finish();
assert_eq!(req.content_type(), "application/json");
let req = HttpRequest::default();
assert_eq!(req.content_type(), "");
}
#[test]
fn test_mime_type() {
let req = TestRequest::with_header("content-type", "application/json").finish();
assert_eq!(req.mime_type(), Some(mime::APPLICATION_JSON));
let req = HttpRequest::default();
assert_eq!(req.mime_type(), None);
let req = TestRequest::with_header(
"content-type", "application/json; charset=utf-8").finish();
let mt = req.mime_type().unwrap();
assert_eq!(mt.get_param(mime::CHARSET), Some(mime::UTF_8));
assert_eq!(mt.type_(), mime::APPLICATION);
assert_eq!(mt.subtype(), mime::JSON);
}
2017-12-13 19:16:26 +00:00
#[test]
fn test_no_request_cookies() {
2017-12-27 03:48:02 +00:00
let req = HttpRequest::default();
2017-12-13 19:16:26 +00:00
assert!(req.cookies().unwrap().is_empty());
}
#[test]
fn test_request_cookies() {
2017-12-27 03:48:02 +00:00
let req = TestRequest::with_header(
header::COOKIE, "cookie1=value1; cookie2=value2").finish();
2017-12-13 19:16:26 +00:00
{
let cookies = req.cookies().unwrap();
assert_eq!(cookies.len(), 2);
assert_eq!(cookies[0].name(), "cookie1");
assert_eq!(cookies[0].value(), "value1");
assert_eq!(cookies[1].name(), "cookie2");
assert_eq!(cookies[1].value(), "value2");
}
let cookie = req.cookie("cookie1");
assert!(cookie.is_some());
let cookie = cookie.unwrap();
assert_eq!(cookie.name(), "cookie1");
assert_eq!(cookie.value(), "value1");
let cookie = req.cookie("cookie-unknown");
assert!(cookie.is_none());
}
#[test]
fn test_no_request_range_header() {
2018-01-03 18:57:57 +00:00
let req = HttpRequest::default();
2017-12-13 19:16:26 +00:00
let ranges = req.range(100).unwrap();
assert!(ranges.is_empty());
}
#[test]
fn test_request_range_header() {
2018-01-03 18:57:57 +00:00
let req = TestRequest::with_header(header::RANGE, "bytes=0-4").finish();
2017-12-13 19:16:26 +00:00
let ranges = req.range(100).unwrap();
assert_eq!(ranges.len(), 1);
assert_eq!(ranges[0].start, 0);
assert_eq!(ranges[0].length, 5);
}
#[test]
fn test_request_query() {
2018-01-03 18:57:57 +00:00
let req = TestRequest::with_uri("/?id=test").finish();
2017-12-13 19:16:26 +00:00
assert_eq!(req.query_string(), "id=test");
let query = req.query();
assert_eq!(&query["id"], "test");
}
#[test]
fn test_request_match_info() {
2017-12-27 03:48:02 +00:00
let mut req = TestRequest::with_uri("/value/?id=test").finish();
2017-12-13 19:16:26 +00:00
2017-12-26 17:00:45 +00:00
let mut resource = Resource::<()>::default();
2017-12-13 19:16:26 +00:00
resource.name("index");
let mut map = HashMap::new();
map.insert(Pattern::new("index", "/{key}/", "^/"), Some(resource));
2017-12-29 19:49:36 +00:00
let (router, _) = Router::new("", ServerSettings::default(), map);
2017-12-13 19:16:26 +00:00
assert!(router.recognize(&mut req).is_some());
assert_eq!(req.match_info().get("key"), Some("value"));
}
#[test]
fn test_chunked() {
2017-12-27 03:48:02 +00:00
let req = HttpRequest::default();
2017-12-13 19:16:26 +00:00
assert!(!req.chunked().unwrap());
2017-12-27 03:48:02 +00:00
let req = TestRequest::with_header(header::TRANSFER_ENCODING, "chunked").finish();
2017-12-13 19:16:26 +00:00
assert!(req.chunked().unwrap());
let mut headers = HeaderMap::new();
let s = unsafe{str::from_utf8_unchecked(b"some va\xadscc\xacas0xsdasdlue".as_ref())};
headers.insert(header::TRANSFER_ENCODING,
header::HeaderValue::from_str(s).unwrap());
let req = HttpRequest::new(
Method::GET, Uri::from_str("/").unwrap(),
Version::HTTP_11, headers, None);
assert!(req.chunked().is_err());
}
2017-12-19 22:03:01 +00:00
impl PartialEq for UrlencodedError {
fn eq(&self, other: &UrlencodedError) -> bool {
match *self {
UrlencodedError::Chunked => match *other {
UrlencodedError::Chunked => true,
_ => false,
},
UrlencodedError::Overflow => match *other {
UrlencodedError::Overflow => true,
_ => false,
},
UrlencodedError::UnknownLength => match *other {
UrlencodedError::UnknownLength => true,
_ => false,
},
UrlencodedError::ContentType => match *other {
UrlencodedError::ContentType => true,
_ => false,
},
_ => false,
}
}
}
2017-10-23 21:26:01 +00:00
#[test]
fn test_urlencoded_error() {
2018-01-03 18:57:57 +00:00
let req = TestRequest::with_header(header::TRANSFER_ENCODING, "chunked").finish();
2017-12-19 22:03:01 +00:00
assert_eq!(req.urlencoded().poll().err().unwrap(), UrlencodedError::Chunked);
2017-10-23 21:26:01 +00:00
2018-01-03 18:57:57 +00:00
let req = TestRequest::with_header(
header::CONTENT_TYPE, "application/x-www-form-urlencoded")
.header(header::CONTENT_LENGTH, "xxxx")
.finish();
2017-12-19 22:03:01 +00:00
assert_eq!(req.urlencoded().poll().err().unwrap(), UrlencodedError::UnknownLength);
2017-10-23 21:26:01 +00:00
2018-01-03 18:57:57 +00:00
let req = TestRequest::with_header(
header::CONTENT_TYPE, "application/x-www-form-urlencoded")
.header(header::CONTENT_LENGTH, "1000000")
.finish();
2017-12-19 22:03:01 +00:00
assert_eq!(req.urlencoded().poll().err().unwrap(), UrlencodedError::Overflow);
2017-10-23 21:26:01 +00:00
2018-01-03 18:57:57 +00:00
let req = TestRequest::with_header(
header::CONTENT_TYPE, "text/plain")
.header(header::CONTENT_LENGTH, "10")
.finish();
2017-12-19 22:03:01 +00:00
assert_eq!(req.urlencoded().poll().err().unwrap(), UrlencodedError::ContentType);
2017-10-23 21:26:01 +00:00
}
2017-12-07 00:26:27 +00:00
2018-01-03 18:57:57 +00:00
#[test]
fn test_request_body() {
let req = TestRequest::with_header(header::CONTENT_LENGTH, "xxxx").finish();
match req.body().poll().err().unwrap() {
PayloadError::UnknownLength => (),
_ => panic!("error"),
}
let req = TestRequest::with_header(header::CONTENT_LENGTH, "1000000").finish();
match req.body().poll().err().unwrap() {
PayloadError::Overflow => (),
_ => panic!("error"),
}
let mut req = HttpRequest::default();
req.payload_mut().unread_data(Bytes::from_static(b"test"));
match req.body().poll().ok().unwrap() {
Async::Ready(bytes) => assert_eq!(bytes, Bytes::from_static(b"test")),
_ => panic!("error"),
}
let mut req = HttpRequest::default();
req.payload_mut().unread_data(Bytes::from_static(b"11111111111111"));
match req.body().limit(5).poll().err().unwrap() {
PayloadError::Overflow => (),
_ => panic!("error"),
}
}
2017-12-07 00:26:27 +00:00
#[test]
fn test_url_for() {
2018-01-03 18:57:57 +00:00
let req = TestRequest::with_header(header::HOST, "www.rust-lang.org")
.finish_no_router();
2017-12-07 00:26:27 +00:00
2017-12-26 17:00:45 +00:00
let mut resource = Resource::<()>::default();
2017-12-07 00:26:27 +00:00
resource.name("index");
let mut map = HashMap::new();
map.insert(Pattern::new("index", "/user/{name}.{ext}", "^/"), Some(resource));
let (router, _) = Router::new("/", ServerSettings::default(), map);
2017-12-07 00:58:49 +00:00
assert!(router.has_route("/user/test.html"));
assert!(!router.has_route("/test/unknown"));
2017-12-07 00:26:27 +00:00
assert_eq!(req.url_for("unknown", &["test"]),
Err(UrlGenerationError::RouterNotAvailable));
2017-12-08 02:00:20 +00:00
let req = req.with_state(Rc::new(()), router);
2017-12-07 00:26:27 +00:00
assert_eq!(req.url_for("unknown", &["test"]),
Err(UrlGenerationError::ResourceNotFound));
assert_eq!(req.url_for("index", &["test"]),
Err(UrlGenerationError::NotEnoughElements));
let url = req.url_for("index", &["test", "html"]);
assert_eq!(url.ok().unwrap().as_str(), "http://www.rust-lang.org/user/test.html");
}
#[test]
fn test_url_for_with_prefix() {
2018-01-03 18:57:57 +00:00
let req = TestRequest::with_header(header::HOST, "www.rust-lang.org").finish();
let mut resource = Resource::<()>::default();
resource.name("index");
let mut map = HashMap::new();
map.insert(Pattern::new("index", "/user/{name}.{ext}", "^/"), Some(resource));
let (router, _) = Router::new("/prefix/", ServerSettings::default(), map);
assert!(router.has_route("/user/test.html"));
assert!(!router.has_route("/prefix/user/test.html"));
let req = req.with_state(Rc::new(()), router);
let url = req.url_for("index", &["test", "html"]);
assert_eq!(url.ok().unwrap().as_str(), "http://www.rust-lang.org/prefix/user/test.html");
}
#[test]
fn test_url_for_external() {
2018-01-03 18:57:57 +00:00
let req = HttpRequest::default();
let mut resource = Resource::<()>::default();
resource.name("index");
let mut map = HashMap::new();
map.insert(Pattern::new("youtube", "https://youtube.com/watch/{video_id}", "^/"), None);
2017-12-29 19:49:36 +00:00
let (router, _) = Router::new::<()>("", ServerSettings::default(), map);
assert!(!router.has_route("https://youtube.com/watch/unknown"));
2017-12-08 02:00:20 +00:00
let req = req.with_state(Rc::new(()), router);
let url = req.url_for("youtube", &["oHg5SJYRHA0"]);
assert_eq!(url.ok().unwrap().as_str(), "https://youtube.com/watch/oHg5SJYRHA0");
}
2017-10-23 21:26:01 +00:00
}