use std::{cell::Ref, cell::RefMut, fmt, net, rc::Rc};
use crate::http::{
HeaderMap, HttpMessage, Message, Method, Payload, RequestHead, Uri, Version,
};
use crate::{io::IoRef, io::types, router::Path, util::Extensions};
use super::config::WebAppConfig;
use super::error::ErrorRenderer;
use super::extract::FromRequest;
use super::info::ConnectionInfo;
use super::rmap::ResourceMap;
use super::service::AppState;
#[derive(Clone)]
pub struct HttpRequest(pub(crate) Rc<HttpRequestInner>);
pub(crate) struct HttpRequestInner {
pub(crate) head: Message<RequestHead>,
pub(crate) path: Path<Uri>,
pub(crate) payload: Payload,
pub(crate) app_state: AppState,
rmap: Rc<ResourceMap>,
}
impl HttpRequest {
#[inline]
pub(crate) fn new(
path: Path<Uri>,
head: Message<RequestHead>,
payload: Payload,
rmap: Rc<ResourceMap>,
app_state: AppState,
) -> HttpRequest {
HttpRequest(Rc::new(HttpRequestInner {
head,
path,
payload,
app_state,
rmap,
}))
}
}
impl HttpRequest {
#[inline]
pub fn head(&self) -> &RequestHead {
&self.0.head
}
#[inline]
pub(crate) fn head_mut(&mut self) -> &mut RequestHead {
&mut Rc::get_mut(&mut self.0).unwrap().head
}
#[inline]
pub fn uri(&self) -> &Uri {
&self.head().uri
}
#[inline]
pub fn method(&self) -> &Method {
&self.head().method
}
#[inline]
pub fn version(&self) -> Version {
self.head().version
}
#[inline]
pub fn headers(&self) -> &HeaderMap {
&self.head().headers
}
#[inline]
pub fn path(&self) -> &str {
self.head().uri.path()
}
#[inline]
pub fn query_string(&self) -> &str {
self.uri().query().unwrap_or_default()
}
#[inline]
pub fn io(&self) -> Option<&IoRef> {
self.head().io.as_ref()
}
#[inline]
pub fn peer_addr(&self) -> Option<net::SocketAddr> {
self.io()
.and_then(|io| io.query::<types::PeerAddr>().get().map(|addr| addr.0))
}
#[inline]
pub fn match_info(&self) -> &Path<Uri> {
&self.0.path
}
#[inline]
pub(crate) fn match_info_mut(&mut self) -> &mut Path<Uri> {
&mut Rc::get_mut(&mut self.0).unwrap().path
}
#[inline]
pub fn extensions(&self) -> Ref<'_, Extensions> {
self.head().extensions()
}
#[inline]
pub fn extensions_mut(&self) -> RefMut<'_, Extensions> {
self.head().extensions_mut()
}
#[cfg(feature = "url")]
pub fn url_for<U, I>(
&self,
name: &str,
elements: U,
) -> Result<url_pkg::Url, super::error::UrlGenerationError>
where
U: IntoIterator<Item = I>,
I: AsRef<str>,
{
self.0.rmap.url_for(self, name, elements)
}
#[cfg(feature = "url")]
pub fn url_for_static(
&self,
name: &str,
) -> Result<url_pkg::Url, super::error::UrlGenerationError> {
const NO_PARAMS: [&str; 0] = [];
self.url_for(name, NO_PARAMS)
}
#[inline]
pub fn resource_map(&self) -> &ResourceMap {
&self.0.rmap
}
#[inline]
pub fn connection_info(&self) -> Ref<'_, ConnectionInfo> {
ConnectionInfo::get(self.head(), self.app_config())
}
#[inline]
pub fn app_config(&self) -> &WebAppConfig {
self.0.app_state.config()
}
pub fn app_state<T: 'static>(&self) -> Option<&T> {
self.0.app_state.get::<T>()
}
}
impl HttpMessage for HttpRequest {
#[inline]
fn message_headers(&self) -> &HeaderMap {
&self.head().headers
}
#[inline]
fn message_extensions(&self) -> Ref<'_, Extensions> {
self.0.head.extensions()
}
#[inline]
fn message_extensions_mut(&self) -> RefMut<'_, Extensions> {
self.0.head.extensions_mut()
}
}
impl Drop for HttpRequest {
fn drop(&mut self) {
let id = self.0.app_state.id();
let pool_size = self.0.app_state.config().pool_size;
super::config::put_request(id, pool_size, &mut self.0);
}
}
impl<Err: ErrorRenderer> FromRequest<Err> for HttpRequest {
type Error = Err::Container;
#[inline]
async fn from_request(req: &HttpRequest, _: &mut Payload) -> Result<Self, Self::Error> {
Ok(req.clone())
}
}
impl fmt::Debug for HttpRequest {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
writeln!(
f,
"\nHttpRequest {:?} {}:{}",
self.0.head.version,
self.0.head.method,
self.path()
)?;
if !self.query_string().is_empty() {
writeln!(f, " query: ?{:?}", self.query_string())?;
}
if !self.match_info().is_empty() {
writeln!(f, " params: {:?}", self.match_info())?;
}
writeln!(f, " headers:")?;
for (key, val) in self.headers() {
writeln!(f, " {key:?}: {val:?}")?;
}
Ok(())
}
}
#[cfg(test)]
mod tests {
use std::cell::RefCell;
use super::*;
use crate::http::{StatusCode, header};
use crate::router::ResourceDef;
use crate::web::test::{TestRequest, call_service, init_service};
use crate::web::{self, App, HttpResponse};
#[test]
fn test_debug() {
let req = TestRequest::with_header("content-type", "text/plain").to_http_request();
let dbg = format!("{req:?}");
assert!(dbg.contains("HttpRequest"));
let req = TestRequest::with_uri("/index.html?q=?").to_http_request();
let dbg = format!("{req:?}");
assert!(dbg.contains("HttpRequest"));
assert!(req.peer_addr().is_none());
assert_eq!(req.method(), &Method::GET);
}
#[cfg(feature = "cookie")]
#[test]
fn test_no_request_cookies() {
let req = TestRequest::default().to_http_request();
assert!(req.cookies().unwrap().is_empty());
}
#[cfg(feature = "cookie")]
#[test]
fn test_request_cookies() {
let req = TestRequest::default()
.header(header::COOKIE, "cookie1=value1")
.header(header::COOKIE, "cookie2=value2")
.to_http_request();
{
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").to_http_request();
assert_eq!(req.query_string(), "id=test");
}
#[cfg(feature = "url")]
#[test]
fn test_url_for() {
let mut res = ResourceDef::new("/user/{name}.{ext}");
*res.name_mut() = "index".to_string();
let mut rmap = ResourceMap::new(ResourceDef::new(""));
rmap.add(&mut res, None);
let req = TestRequest::with_header(header::HOST, "www.rust-lang.org")
.rmap(rmap)
.to_http_request();
assert_eq!(
req.url_for("unknown", ["test"]),
Err(crate::web::error::UrlGenerationError::ResourceNotFound)
);
assert_eq!(
req.url_for("index", ["test"]),
Err(crate::web::error::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"
);
}
#[cfg(feature = "url")]
#[test]
fn test_url_for_static() {
let mut rdef = ResourceDef::new("/index.html");
*rdef.name_mut() = "index".to_string();
let mut rmap = ResourceMap::new(ResourceDef::new(""));
rmap.add(&mut rdef, None);
let req = TestRequest::with_uri("/test")
.header(header::HOST, "www.rust-lang.org")
.rmap(rmap)
.to_http_request();
let url = req.url_for_static("index");
assert_eq!(
url.ok().unwrap().as_str(),
"http://www.rust-lang.org/index.html"
);
}
#[cfg(feature = "url")]
#[test]
fn test_url_for_external() {
let mut rdef = ResourceDef::new("https://youtube.com/watch/{video_id}");
*rdef.name_mut() = "youtube".to_string();
let mut rmap = ResourceMap::new(ResourceDef::new(""));
rmap.add(&mut rdef, None);
let req = TestRequest::default().rmap(rmap).to_http_request();
let url = req.url_for("youtube", ["oHg5SJYRHA0"]);
assert_eq!(
url.ok().unwrap().as_str(),
"https://youtube.com/watch/oHg5SJYRHA0"
);
}
#[crate::rt_test]
async fn test_state() {
let srv = init_service(App::new().state(10usize).service(web::resource("/").to(
|req: HttpRequest| async move {
if req.app_state::<usize>().is_some() {
HttpResponse::Ok()
} else {
HttpResponse::BadRequest()
}
},
)))
.await;
let req = TestRequest::default().to_request();
let resp = call_service(&srv, req).await;
assert_eq!(resp.status(), StatusCode::OK);
let srv = init_service(App::new().state(10u32).service(web::resource("/").to(
|req: HttpRequest| async move {
if req.app_state::<usize>().is_some() {
HttpResponse::Ok()
} else {
HttpResponse::BadRequest()
}
},
)))
.await;
let req = TestRequest::default().to_request();
let resp = call_service(&srv, req).await;
assert_eq!(resp.status(), StatusCode::BAD_REQUEST);
}
#[crate::rt_test]
async fn test_extensions_dropped() {
struct Tracker {
dropped: bool,
}
struct Foo {
tracker: Rc<RefCell<Tracker>>,
}
impl Drop for Foo {
fn drop(&mut self) {
self.tracker.borrow_mut().dropped = true;
}
}
let tracker = Rc::new(RefCell::new(Tracker { dropped: false }));
{
let tracker2 = Rc::clone(&tracker);
let srv = init_service(App::new().state(10u32).service(web::resource("/").to(
move |req: HttpRequest| {
req.extensions_mut().insert(Foo {
tracker: Rc::clone(&tracker2),
});
async { HttpResponse::Ok() }
},
)))
.await;
let req = TestRequest::default().to_request();
let resp = call_service(&srv, req).await;
assert_eq!(resp.status(), StatusCode::OK);
}
assert!(tracker.borrow().dropped);
}
}