mirror of
https://github.com/fafhrd91/actix-web
synced 2024-11-28 01:52:57 +01:00
625 lines
19 KiB
Rust
625 lines
19 KiB
Rust
//! HTTP Request message related code.
|
|
use std::{io, cmp, str, fmt, mem};
|
|
use std::rc::Rc;
|
|
use std::net::SocketAddr;
|
|
use bytes::Bytes;
|
|
use cookie::Cookie;
|
|
use futures::{Async, Stream, Poll};
|
|
use failure;
|
|
use url::{Url, form_urlencoded};
|
|
use http::{header, Uri, Method, Version, HeaderMap, Extensions};
|
|
use tokio_io::AsyncRead;
|
|
|
|
use info::ConnectionInfo;
|
|
use param::Params;
|
|
use router::Router;
|
|
use payload::Payload;
|
|
use httpmessage::HttpMessage;
|
|
use helpers::SharedHttpInnerMessage;
|
|
use error::{UrlGenerationError, CookieParseError, PayloadError};
|
|
|
|
|
|
pub struct HttpInnerMessage {
|
|
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>>>,
|
|
pub query: Params<'static>,
|
|
pub query_loaded: bool,
|
|
pub addr: Option<SocketAddr>,
|
|
pub payload: Option<Payload>,
|
|
pub info: Option<ConnectionInfo<'static>>,
|
|
}
|
|
|
|
impl Default for HttpInnerMessage {
|
|
|
|
fn default() -> HttpInnerMessage {
|
|
HttpInnerMessage {
|
|
method: Method::GET,
|
|
uri: Uri::default(),
|
|
version: Version::HTTP_11,
|
|
headers: HeaderMap::with_capacity(16),
|
|
params: Params::new(),
|
|
query: Params::new(),
|
|
query_loaded: false,
|
|
cookies: None,
|
|
addr: None,
|
|
payload: None,
|
|
extensions: Extensions::new(),
|
|
info: None,
|
|
}
|
|
}
|
|
}
|
|
|
|
impl HttpInnerMessage {
|
|
|
|
/// Checks if a connection should be kept alive.
|
|
#[inline]
|
|
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
|
|
}
|
|
}
|
|
|
|
#[inline]
|
|
pub(crate) fn reset(&mut self) {
|
|
self.headers.clear();
|
|
self.extensions.clear();
|
|
self.params.clear();
|
|
self.query.clear();
|
|
self.query_loaded = false;
|
|
self.cookies = None;
|
|
self.addr = None;
|
|
self.info = None;
|
|
self.payload = None;
|
|
}
|
|
}
|
|
|
|
/// An HTTP Request
|
|
pub struct HttpRequest<S=()>(SharedHttpInnerMessage, Option<Rc<S>>, Option<Router>);
|
|
|
|
impl HttpRequest<()> {
|
|
/// Construct a new Request.
|
|
#[inline]
|
|
pub fn new(method: Method, uri: Uri,
|
|
version: Version, headers: HeaderMap, payload: Option<Payload>) -> HttpRequest
|
|
{
|
|
HttpRequest(
|
|
SharedHttpInnerMessage::from_message(HttpInnerMessage {
|
|
method,
|
|
uri,
|
|
version,
|
|
headers,
|
|
payload,
|
|
params: Params::new(),
|
|
query: Params::new(),
|
|
query_loaded: false,
|
|
cookies: None,
|
|
addr: None,
|
|
extensions: Extensions::new(),
|
|
info: None,
|
|
}),
|
|
None,
|
|
None,
|
|
)
|
|
}
|
|
|
|
#[inline(always)]
|
|
#[cfg_attr(feature = "cargo-clippy", allow(inline_always))]
|
|
pub(crate) fn from_message(msg: SharedHttpInnerMessage) -> HttpRequest {
|
|
HttpRequest(msg, None, None)
|
|
}
|
|
|
|
#[inline]
|
|
/// Construct new http request with state.
|
|
pub fn with_state<S>(self, state: Rc<S>, router: Router) -> HttpRequest<S> {
|
|
HttpRequest(self.0, Some(state), Some(router))
|
|
}
|
|
|
|
#[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)
|
|
}
|
|
}
|
|
|
|
|
|
impl<S> HttpMessage for HttpRequest<S> {
|
|
#[inline]
|
|
fn headers(&self) -> &HeaderMap {
|
|
&self.as_ref().headers
|
|
}
|
|
}
|
|
|
|
impl<S> HttpRequest<S> {
|
|
|
|
#[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())
|
|
}
|
|
|
|
#[inline]
|
|
/// Construct new http request without state.
|
|
pub(crate) fn without_state(&self) -> HttpRequest {
|
|
HttpRequest(self.0.clone(), None, None)
|
|
}
|
|
|
|
/// get mutable reference for inner message
|
|
/// mutable reference should not be returned as result for request's method
|
|
#[inline(always)]
|
|
#[cfg_attr(feature = "cargo-clippy", allow(mut_from_ref, inline_always))]
|
|
pub(crate) fn as_mut(&self) -> &mut HttpInnerMessage {
|
|
self.0.get_mut()
|
|
}
|
|
|
|
#[inline(always)]
|
|
#[cfg_attr(feature = "cargo-clippy", allow(mut_from_ref, inline_always))]
|
|
fn as_ref(&self) -> &HttpInnerMessage {
|
|
self.0.get_ref()
|
|
}
|
|
|
|
#[inline]
|
|
pub(crate) fn get_inner(&mut self) -> &mut HttpInnerMessage {
|
|
self.as_mut()
|
|
}
|
|
|
|
/// Shared application state
|
|
#[inline]
|
|
pub fn state(&self) -> &S {
|
|
self.1.as_ref().unwrap()
|
|
}
|
|
|
|
/// Protocol extensions.
|
|
#[inline]
|
|
pub fn extensions(&mut self) -> &mut Extensions {
|
|
&mut self.as_mut().extensions
|
|
}
|
|
|
|
#[doc(hidden)]
|
|
pub fn prefix_len(&self) -> usize {
|
|
if let Some(router) = self.router() { router.prefix().len() } else { 0 }
|
|
}
|
|
|
|
/// Read the Request Uri.
|
|
#[inline]
|
|
pub fn uri(&self) -> &Uri { &self.as_ref().uri }
|
|
|
|
#[doc(hidden)]
|
|
#[inline]
|
|
/// Modify the Request Uri.
|
|
///
|
|
/// This might be useful for middlewares, i.e. path normalization
|
|
pub fn uri_mut(&mut self) -> &mut Uri {
|
|
&mut self.as_mut().uri
|
|
}
|
|
|
|
/// Read the Request method.
|
|
#[inline]
|
|
pub fn method(&self) -> &Method { &self.as_ref().method }
|
|
|
|
/// Read the Request Version.
|
|
#[inline]
|
|
pub fn version(&self) -> Version {
|
|
self.as_ref().version
|
|
}
|
|
|
|
#[doc(hidden)]
|
|
#[inline]
|
|
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 {
|
|
self.uri().path()
|
|
}
|
|
|
|
/// Get *ConnectionInfo* for correct request.
|
|
pub fn connection_info(&self) -> &ConnectionInfo {
|
|
if self.as_ref().info.is_none() {
|
|
let info: ConnectionInfo<'static> = unsafe{
|
|
mem::transmute(ConnectionInfo::new(self))};
|
|
self.as_mut().info = Some(info);
|
|
}
|
|
self.as_ref().info.as_ref().unwrap()
|
|
}
|
|
|
|
/// 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();
|
|
/// }
|
|
/// ```
|
|
pub fn url_for<U, I>(&self, name: &str, elements: U) -> Result<Url, UrlGenerationError>
|
|
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('/') {
|
|
let conn = self.connection_info();
|
|
Ok(Url::parse(&format!("{}://{}{}", conn.scheme(), conn.host(), path))?)
|
|
} else {
|
|
Ok(Url::parse(&path)?)
|
|
}
|
|
}
|
|
}
|
|
|
|
/// This method returns reference to current `Router` object.
|
|
#[inline]
|
|
pub fn router(&self) -> Option<&Router> {
|
|
self.2.as_ref()
|
|
}
|
|
|
|
/// Peer socket address
|
|
///
|
|
/// 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.
|
|
#[inline]
|
|
pub fn peer_addr(&self) -> Option<&SocketAddr> {
|
|
self.as_ref().addr.as_ref()
|
|
}
|
|
|
|
#[inline]
|
|
pub(crate) fn set_peer_addr(&mut self, addr: Option<SocketAddr>) {
|
|
self.as_mut().addr = addr
|
|
}
|
|
|
|
/// 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);
|
|
}
|
|
}
|
|
unsafe{ mem::transmute(&self.as_ref().query) }
|
|
}
|
|
|
|
/// The query string in the URL.
|
|
///
|
|
/// E.g., id=10
|
|
#[inline]
|
|
pub fn query_string(&self) -> &str {
|
|
if let Some(query) = self.uri().query().as_ref() {
|
|
query
|
|
} else {
|
|
""
|
|
}
|
|
}
|
|
|
|
/// Load request cookies.
|
|
pub fn cookies(&self) -> Result<&Vec<Cookie<'static>>, CookieParseError> {
|
|
if self.as_ref().cookies.is_none() {
|
|
let msg = self.as_mut();
|
|
let mut cookies = Vec::new();
|
|
if let Some(val) = msg.headers.get(header::COOKIE) {
|
|
let s = str::from_utf8(val.as_bytes())
|
|
.map_err(CookieParseError::from)?;
|
|
for cookie in s.split("; ") {
|
|
cookies.push(Cookie::parse_encoded(cookie)?.into_owned());
|
|
}
|
|
}
|
|
msg.cookies = Some(cookies)
|
|
}
|
|
Ok(self.as_ref().cookies.as_ref().unwrap())
|
|
}
|
|
|
|
/// 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)
|
|
}
|
|
}
|
|
}
|
|
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 {
|
|
unsafe{ mem::transmute(&self.as_ref().params) }
|
|
}
|
|
|
|
/// Get mutable reference to request's Params.
|
|
#[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 {
|
|
self.as_ref().keep_alive()
|
|
}
|
|
|
|
/// Check if request requires connection upgrade
|
|
pub(crate) fn upgrade(&self) -> bool {
|
|
if let Some(conn) = self.as_ref().headers.get(header::CONNECTION) {
|
|
if let Ok(s) = conn.to_str() {
|
|
return s.to_lowercase().contains("upgrade")
|
|
}
|
|
}
|
|
self.as_ref().method == Method::CONNECT
|
|
}
|
|
|
|
#[cfg(test)]
|
|
pub(crate) fn payload(&self) -> &Payload {
|
|
let msg = self.as_mut();
|
|
if msg.payload.is_none() {
|
|
msg.payload = Some(Payload::empty());
|
|
}
|
|
msg.payload.as_ref().unwrap()
|
|
}
|
|
|
|
#[cfg(test)]
|
|
pub(crate) 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()
|
|
}
|
|
}
|
|
|
|
impl Default for HttpRequest<()> {
|
|
|
|
/// Construct default request
|
|
fn default() -> HttpRequest {
|
|
HttpRequest(SharedHttpInnerMessage::default(), None, None)
|
|
}
|
|
}
|
|
|
|
impl<S> Clone for HttpRequest<S> {
|
|
fn clone(&self) -> HttpRequest<S> {
|
|
HttpRequest(self.0.clone(), self.1.clone(), self.2.clone())
|
|
}
|
|
}
|
|
|
|
impl<S> Stream for HttpRequest<S> {
|
|
type Item = Bytes;
|
|
type Error = PayloadError;
|
|
|
|
fn poll(&mut self) -> Poll<Option<Bytes>, PayloadError> {
|
|
let msg = self.as_mut();
|
|
if msg.payload.is_none() {
|
|
Ok(Async::Ready(None))
|
|
} else {
|
|
msg.payload.as_mut().unwrap().poll()
|
|
}
|
|
}
|
|
}
|
|
|
|
impl<S> io::Read for HttpRequest<S> {
|
|
fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
|
|
if self.as_mut().payload.is_some() {
|
|
match self.as_mut().payload.as_mut().unwrap().poll() {
|
|
Ok(Async::Ready(Some(mut b))) => {
|
|
let i = cmp::min(b.len(), buf.len());
|
|
buf.copy_from_slice(&b.split_to(i)[..i]);
|
|
|
|
if !b.is_empty() {
|
|
self.as_mut().payload.as_mut().unwrap().unread_data(b);
|
|
}
|
|
|
|
if i < buf.len() {
|
|
match self.read(&mut buf[i..]) {
|
|
Ok(n) => Ok(i + n),
|
|
Err(ref e) if e.kind() == io::ErrorKind::WouldBlock => Ok(i),
|
|
Err(e) => Err(e),
|
|
}
|
|
} else {
|
|
Ok(i)
|
|
}
|
|
}
|
|
Ok(Async::Ready(None)) => Ok(0),
|
|
Ok(Async::NotReady) =>
|
|
Err(io::Error::new(io::ErrorKind::WouldBlock, "Not ready")),
|
|
Err(e) =>
|
|
Err(io::Error::new(io::ErrorKind::Other, failure::Error::from(e).compat())),
|
|
}
|
|
} else {
|
|
Ok(0)
|
|
}
|
|
}
|
|
}
|
|
|
|
impl<S> AsyncRead for HttpRequest<S> {}
|
|
|
|
impl<S> fmt::Debug for HttpRequest<S> {
|
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
|
let res = write!(f, "\nHttpRequest {:?} {}:{}\n",
|
|
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() {
|
|
let _ = write!(f, " params: {:?}\n", self.as_ref().params);
|
|
}
|
|
let _ = write!(f, " headers:\n");
|
|
for key in self.as_ref().headers.keys() {
|
|
let vals: Vec<_> = self.as_ref().headers.get_all(key).iter().collect();
|
|
if vals.len() > 1 {
|
|
let _ = write!(f, " {:?}: {:?}\n", key, vals);
|
|
} else {
|
|
let _ = write!(f, " {:?}: {:?}\n", key, vals[0]);
|
|
}
|
|
}
|
|
res
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
use http::{Uri, HttpTryFrom};
|
|
use router::Pattern;
|
|
use resource::Resource;
|
|
use test::TestRequest;
|
|
use server::ServerSettings;
|
|
|
|
#[test]
|
|
fn test_debug() {
|
|
let req = TestRequest::with_header("content-type", "text/plain").finish();
|
|
let dbg = format!("{:?}", req);
|
|
assert!(dbg.contains("HttpRequest"));
|
|
}
|
|
|
|
#[test]
|
|
fn test_uri_mut() {
|
|
let mut req = HttpRequest::default();
|
|
assert_eq!(req.path(), "/");
|
|
*req.uri_mut() = Uri::try_from("/test").unwrap();
|
|
assert_eq!(req.path(), "/test");
|
|
}
|
|
|
|
#[test]
|
|
fn test_no_request_cookies() {
|
|
let req = HttpRequest::default();
|
|
assert!(req.cookies().unwrap().is_empty());
|
|
}
|
|
|
|
#[test]
|
|
fn test_request_cookies() {
|
|
let req = TestRequest::with_header(
|
|
header::COOKIE, "cookie1=value1; cookie2=value2").finish();
|
|
{
|
|
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_request_query() {
|
|
let req = TestRequest::with_uri("/?id=test").finish();
|
|
assert_eq!(req.query_string(), "id=test");
|
|
let query = req.query();
|
|
assert_eq!(&query["id"], "test");
|
|
}
|
|
|
|
#[test]
|
|
fn test_request_match_info() {
|
|
let mut req = TestRequest::with_uri("/value/?id=test").finish();
|
|
|
|
let mut resource = Resource::<()>::default();
|
|
resource.name("index");
|
|
let mut routes = Vec::new();
|
|
routes.push((Pattern::new("index", "/{key}/"), Some(resource)));
|
|
let (router, _) = Router::new("", ServerSettings::default(), routes);
|
|
assert!(router.recognize(&mut req).is_some());
|
|
|
|
assert_eq!(req.match_info().get("key"), Some("value"));
|
|
}
|
|
|
|
#[test]
|
|
fn test_url_for() {
|
|
let req = TestRequest::with_header(header::HOST, "www.rust-lang.org")
|
|
.finish_no_router();
|
|
|
|
let mut resource = Resource::<()>::default();
|
|
resource.name("index");
|
|
let routes = vec!((Pattern::new("index", "/user/{name}.{ext}"), Some(resource)));
|
|
let (router, _) = Router::new("/", ServerSettings::default(), routes);
|
|
assert!(router.has_route("/user/test.html"));
|
|
assert!(!router.has_route("/test/unknown"));
|
|
|
|
assert_eq!(req.url_for("unknown", &["test"]),
|
|
Err(UrlGenerationError::RouterNotAvailable));
|
|
|
|
let req = req.with_state(Rc::new(()), router);
|
|
|
|
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() {
|
|
let req = TestRequest::with_header(header::HOST, "www.rust-lang.org").finish();
|
|
|
|
let mut resource = Resource::<()>::default();
|
|
resource.name("index");
|
|
let routes = vec![(Pattern::new("index", "/user/{name}.{ext}"), Some(resource))];
|
|
let (router, _) = Router::new("/prefix/", ServerSettings::default(), routes);
|
|
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() {
|
|
let req = HttpRequest::default();
|
|
|
|
let mut resource = Resource::<()>::default();
|
|
resource.name("index");
|
|
let routes = vec![
|
|
(Pattern::new("youtube", "https://youtube.com/watch/{video_id}"), None)];
|
|
let (router, _) = Router::new::<()>("", ServerSettings::default(), routes);
|
|
assert!(!router.has_route("https://youtube.com/watch/unknown"));
|
|
|
|
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");
|
|
}
|
|
}
|