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 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586
pub(crate) mod fragment;
mod remote;
use self::fragment::{Fragment, FragmentSelect};
pub use self::remote::RemoteAddress;
use crate::HttpEntity;
use std::convert::TryFrom;
use std::str::FromStr;
macro_rules! forward {
() => {};
(
$(#[$m:meta])* $v:vis fn $name:ident(&self $(, $pn:ident: $pt:ty)*) -> $ret:ty;
$($tail:tt)*
) => {
$(#[$m])* $v fn $name(&self $(, $pn: $pt)*) -> $ret {
(self.0).$name($($pn),*)
}
forward! { $($tail)* }
};
(
$(#[$m:meta])* $v:vis fn $name:ident(&mut self $(, $pn:ident: $pt:ty)*) -> $ret:ty;
$($tail:tt)*
) => {
$(#[$m])* $v fn $name(&mut self $(, $pn: $pt)*) -> $ret {
(self.0).$name($($pn),*)
}
forward! { $($tail)* }
}
}
macro_rules! construct {
() => {};
($($(#[$m:meta])* $v:vis fn $method:ident = $action:expr;)+) => {
$($(#[$m])* $v fn $method<U>(uri: U) -> Result<Self, http::Error>
where
http::Uri: TryFrom<U>,
<http::Uri as TryFrom<U>>::Error: Into<http::Error>
{
http::request::Builder::new()
.method($action)
.uri(uri)
.body(hyper::Body::empty())
.map(Request)
})+
};
}
#[derive(Debug)]
/// Represents an HTTP request.
///
/// An HTTP Request consists of a head (a version, a method, a path, and some
/// headers), and a body (which may be empty). This type offers convenient
/// helpers for constructing HTTP request for you for common use-cases.
///
/// The request also contains an "extensions" type map, which is used by under
/// for containing routing information. It can also be used to insert state
/// into the request for endpoints.
///
/// # Examples
/// ```rust
/// # use under::*;
/// async fn respond_to(request: Request) -> Result<Response, anyhow::Error> {
/// if request.uri() != "/foo" {
/// return Ok(Response::empty_404());
/// }
///
/// Ok(Response::empty_204())
/// }
/// ```
///
///
pub struct Request(http::Request<hyper::Body>);
impl Request {
construct! {
/// Creates a new request initialized with the GET method and the given
/// URI.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let request = Request::get("https://example.com/a").unwrap();
/// assert_eq!(request.method(), http::Method::GET);
/// ```
pub fn get = http::Method::GET;
/// Creates a new request initialized with the POST method and the given
/// URI.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let request = Request::post("https://example.com/a").unwrap();
/// assert_eq!(request.method(), http::Method::POST);
/// ```
pub fn post = http::Method::POST;
/// Creates a new request initialized with the PUT method and the given
/// URI.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let request = Request::put("https://example.com/a").unwrap();
/// assert_eq!(request.method(), http::Method::PUT);
/// ```
pub fn put = http::Method::PUT;
/// Creates a new request initialized with the DELETE method and the given
/// URI.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let request = Request::delete("https://example.com/a").unwrap();
/// assert_eq!(request.method(), http::Method::DELETE);
/// ```
pub fn delete = http::Method::DELETE;
/// Creates a new request initialized with the HEAD method and the given
/// URI.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let request = Request::head("https://example.com/a").unwrap();
/// assert_eq!(request.method(), http::Method::HEAD);
/// ```
pub fn head = http::Method::HEAD;
/// Creates a new request initialized with the TRACE method and the given
/// URI.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let request = Request::trace("https://example.com/a").unwrap();
/// assert_eq!(request.method(), http::Method::TRACE);
/// ```
pub fn trace = http::Method::TRACE;
/// Creates a new request initialized with the CONNECT method and the
/// given URI.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let request = Request::connect("https://example.com/a").unwrap();
/// assert_eq!(request.method(), http::Method::CONNECT);
/// ```
pub fn connect = http::Method::CONNECT;
/// Creates a new request initialized with the PATCH method and the
/// given URI.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let request = Request::patch("https://example.com/a").unwrap();
/// assert_eq!(request.method(), http::Method::PATCH);
/// ```
pub fn patch = http::Method::PATCH;
}
/// Creates a new request initialized with the provided method and the
/// given URI.
///
/// # Errors
/// This method will return an error if the provided URI is invalid, or if
/// the provided method is not a valid HTTP method.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let method = http::Method::from_bytes(b"TEST").unwrap();
/// let request = Request::from_method("https://example.com/a", method.clone()).unwrap();
/// assert_eq!(request.method(), method);
/// ```
pub fn from_method<U>(uri: U, method: http::Method) -> Result<Self, http::Error>
where
http::Uri: TryFrom<U>,
<http::Uri as TryFrom<U>>::Error: Into<http::Error>,
{
http::request::Builder::new()
.method(method)
.uri(uri)
.body(hyper::Body::empty())
.map(Request)
}
/// Retrieves a path fragment from the request, then attempts to parse it.
/// The key can either be a number, or a string.
///
/// # Examples
/// ```rust,no_run
/// # use under::*;
///
/// async fn point(request: Request) -> Response {
/// let target: u32 = request.fragment("amount").unwrap();
/// Response::text(format!("you bought {} coconuts", target))
/// }
///
/// # #[tokio::main] async fn main() -> Result<(), anyhow::Error> {
/// let mut http = under::http();
/// http.at("/buy/{amount:uint}").get(point);
/// http.prepare();
/// let mut response = http.handle(Request::get("/buy/3")?).await?;
/// assert_eq!(response.status(), http::StatusCode::OK);
/// let body = response.data(512).into_text().await?;
/// assert_eq!(body, "you bought 3 coconuts");
/// # Ok(())
/// # }
/// ```
pub fn fragment<I: FromStr, K: FragmentSelect>(&self, key: K) -> Option<I> {
self.fragment_str(key).and_then(|s| s.parse().ok())
}
/// Retrieves a path fragment from the request. The key can either be
/// a number, or a string.
///
/// # Examples
/// ```rust
/// # use under::*;
///
/// async fn point(request: Request) -> Response {
/// let target = request.fragment_str("target").unwrap();
/// Response::text(format!("hello, {}", target))
/// }
///
/// # #[tokio::main] async fn main() -> Result<(), anyhow::Error> {
/// let mut http = under::http();
/// http.at("/hello/{target}").get(point);
/// http.prepare();
/// let mut response = http.handle(Request::get("/hello/foo")?).await?;
/// assert_eq!(response.status(), http::StatusCode::OK);
/// let body = response.data(512).into_text().await?;
/// assert_eq!(body, "hello, foo");
/// # Ok(())
/// # }
/// ```
pub fn fragment_str<K: FragmentSelect>(&self, key: K) -> Option<&str> {
self.fragment_ext()?.select(key)
}
fn fragment_ext(&self) -> Option<&Fragment> {
self.extensions().get::<Fragment>()
}
/// Parses the query string from the request into the provided type. If
/// there is no query string, then `None` is returned; or, if the query
/// string cannot be parsed into the given type, then `None` is also
/// returned.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let request = Request::get("/users?id=1").unwrap();
/// #[derive(serde::Deserialize)]
/// struct User { id: u32 }
/// let user: User = request.query().unwrap();
/// assert_eq!(user.id, 1);
/// ```
#[cfg(feature = "serde")]
#[doc(cfg(feature = "serde"))]
pub fn query<'q, S: serde::Deserialize<'q>>(&'q self) -> Option<S> {
self.uri()
.query()
.and_then(|s| serde_qs::from_str::<S>(s).ok())
}
/// Attempts to load the peer address of the request. This is only
/// available if loaded through the hyper service stack (i.e. the request
/// originates from [`crate::Router::listen`]), and so cannot garunteed
/// to be present.
///
/// # Examples
/// ```rust,no_run
/// # use under::*;
///
/// async fn handle(request: Request) -> Response {
/// let peer = request.peer_addr();
/// match request.peer_addr() {
/// Some(addr) => Response::text(format!("{}", addr)),
/// None => Response::text("no peer address")
/// }
/// }
///
/// # #[tokio::main] async fn main() -> Result<(), anyhow::Error> {
/// let mut http = under::http();
/// http.at("/").get(handle);
/// http.listen("0.0.0.0:8080").await?;
/// # Ok(())
/// # }
/// ```
pub fn peer_addr(&self) -> Option<std::net::SocketAddr> {
Some(self.ext::<crate::middleware::PeerAddress>()?.0)
}
/// Sets the peer address of this request to a localhost address. This is
/// only useful for testing, and should not be used in production. This
/// allows you to test the request handling without having to bind to a
/// port.
///
/// # Examples
/// ```rust
/// # use under::*;
/// use std::net::SocketAddr;
/// let request = Request::get("/").unwrap()
/// .with_local_addr();
/// assert_eq!(request.peer_addr(), Some(SocketAddr::from(([127, 0, 0, 1], 0))));
/// ```
#[must_use]
pub fn with_local_addr(mut self) -> Self {
self.extensions_mut()
.insert(crate::middleware::PeerAddress(std::net::SocketAddr::from(
([127, 0, 0, 1], 0),
)));
self
}
/// Attempts to load the "remote" address for this request. This is
/// determined in the following priority:
///
/// 1. The [`Forwarded` header] `for` key, if present;
/// 2. The _first_ item of the _first_ `X-Forwarded-For` header, if present;
/// 3. The peer address, if loaded through the hyper service stack (see
/// [`Self::peer_addr`]).
///
/// # Note
/// The client may (maliciously) include either the `Forwarded` header
/// or the `X-Forwarded-For` header, if your reverse proxy does not filter
/// either. Be wary of this when configuring your reverse proxy to provide
/// the correct address.
///
/// # Examples
/// ```rust
/// # use under::*;
/// use std::net::IpAddr;
/// let request = Request::get("/").unwrap()
/// .with_header("Forwarded", "for=10.0.0.3").unwrap();
/// assert_eq!(request.remote(), Some(IpAddr::from([10, 0, 0, 3])));
/// ```
///
/// ```rust
/// # use under::*;
/// use std::net::IpAddr;
/// let request = Request::get("/").unwrap()
/// .with_header("X-Forwarded-For", "10.0.0.3").unwrap();
/// assert_eq!(request.remote(), Some(IpAddr::from([10, 0, 0, 3])));
/// ```
///
/// ```rust
/// # use under::*;
/// use std::net::IpAddr;
/// let request = Request::get("/").unwrap()
/// .with_local_addr();
/// assert_eq!(request.remote(), Some(IpAddr::from([127, 0, 0, 1])));
/// ```
#[deprecated(note = "use remote_address instead")]
pub fn remote(&self) -> Option<std::net::IpAddr> {
use std::net::IpAddr;
fn forwarded_header(request: &Request) -> Option<IpAddr> {
request
.header("Forwarded")
.and_then(|s| s.to_str().ok())?
.split(';')
.find_map(|s| {
s.trim()
.strip_prefix("for=")
.and_then(|s| s.trim_matches('"').parse::<IpAddr>().ok())
})
}
fn x_forwarded_for_header(request: &Request) -> Option<IpAddr> {
request
.header("X-Forwarded-For")
.and_then(|s| s.to_str().ok())?
.split(',')
.next()
.and_then(|s| s.trim().parse::<IpAddr>().ok())
}
forwarded_header(self)
.or_else(|| x_forwarded_for_header(self))
.or_else(|| self.peer_addr().map(|addr| addr.ip()))
}
/// Returns a builder that can be used to configure how to extract the
/// client's IP address from the request. See [`RemoteAddress`] for more
/// information.
///
/// ```rust
/// # use under::*;
/// # use std::net::IpAddr;
/// # let mut request = Request::get("/").unwrap().with_local_addr();
/// request.set_header("X-Forwarded-For", "1.1.1.1, 2.2.2.2, 3.3.3.3");
/// let ip = request.remote_address()
/// .trust_cloudflare_header()
/// .trust_forwarded_for(-1)
/// .trust_peer_address()
/// .apply();
/// assert_eq!(ip, Some(IpAddr::from([3, 3, 3, 3])));
/// ```
pub fn remote_address(&self) -> RemoteAddress<'_> {
RemoteAddress::new(self)
}
/// Returns state information provided by the
/// [`crate::middleware::StateMiddleware`] middleware. This is a
/// shortcut to retrieving the [`crate::middleware::State`]
/// extension from the request.
///
/// # Examples
/// ```rust
/// # use under::*;
/// use under::middleware::State;
/// let mut request = Request::get("/").unwrap();
/// request.extensions_mut().insert(State(123u32));
/// assert_eq!(request.state::<u32>(), Some(&123u32));
/// ```
pub fn state<T: Send + Sync + 'static>(&self) -> Option<&T> {
self.ext::<crate::middleware::State<T>>().map(|v| &v.0)
}
/// Retrieves a specific extension from the extensions map. This is
/// the same as calling [`Self::extensions`].`get` wit the given
/// type parameter.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let mut request = Request::get("/").unwrap();
/// assert_eq!(request.ext::<u32>(), None);
/// ```
pub fn ext<T: Send + Sync + 'static>(&self) -> Option<&T> {
self.extensions().get::<T>()
}
/// Retrieves a mutable reference to the specific extension from the
/// extensions map. This is the same as calling
/// [`Self::extensions_mut`].`get_mut` with the given type
/// parameter.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let mut request = Request::get("/").unwrap();
/// assert_eq!(request.ext_mut::<u32>(), None);
/// ```
pub fn ext_mut<T: Send + Sync + 'static>(&mut self) -> Option<&mut T> {
self.extensions_mut().get_mut::<T>()
}
/// Sets the value of the specific extension in the extensions map.
/// This is the same as calling [`Self::extensions_mut`].`insert`
/// with the given parameter.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let mut request = Request::get("/").unwrap();
/// request.set_ext(123u32);
/// assert_eq!(request.ext::<u32>(), Some(&123u32));
/// ```
pub fn set_ext<T: Send + Sync + 'static>(&mut self, value: T) -> &mut Self {
self.extensions_mut().insert(value);
self
}
/// Sets the value of the specific extension in the extensions map,
/// consuming `self`, and then returning the new value. This is
/// the same as calling [`Self::set_ext`], but it consumes `self`.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let request = Request::get("/").unwrap();
/// let request = request.with_ext(123u32);
/// assert_eq!(request.ext::<u32>(), Some(&123u32));
/// ```
#[must_use]
pub fn with_ext<T: Send + Sync + 'static>(mut self, value: T) -> Self {
self.set_ext(value);
self
}
/// Removes the specific extension from the extensions map. This is
/// the same as calling [`Self::extensions_mut`].`remove` with the
/// given type parameter.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let mut request = Request::get("/").unwrap()
/// .with_ext(123u32);
/// assert_eq!(request.ext::<u32>(), Some(&123u32));
/// request.remove_ext::<u32>();
/// assert_eq!(request.ext::<u32>(), None);
/// ```
pub fn remove_ext<T: Send + Sync + 'static>(&mut self) -> Option<T> {
self.extensions_mut().remove::<T>()
}
/// Removes the specific extension from the extensions map,
/// consuming `self`, and then returning the removed value. This
/// is the same as calling [`Self::remove_ext`], but it consumes
/// `self`.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let request = Request::get("/").unwrap()
/// .with_ext(123u32);
/// assert_eq!(request.ext::<u32>(), Some(&123u32));
/// let request = request.without_ext::<u32>();
/// assert_eq!(request.ext::<u32>(), None);
/// ```
#[must_use]
pub fn without_ext<T: Send + Sync + 'static>(mut self) -> Self {
self.remove_ext::<T>();
self
}
forward! {
/// Returns a reference to the associated URI.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let request: Request = Request::get("/").unwrap();
/// assert_eq!(&*request.uri(), "/");
/// ```
#[inline]
pub fn uri(&self) -> &http::Uri;
/// Returns a reference to the associated HTTP method.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let request: Request = Request::get("/").unwrap();
/// assert_eq!(*request.method(), http::Method::GET);
/// ```
#[inline]
pub fn method(&self) -> &http::Method;
/// Returns a reference to the associated extensions.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let request: Request = Request::get("/").unwrap();
/// assert!(request.extensions().get::<i32>().is_none());
/// ```
#[inline]
pub fn extensions(&self) -> &http::Extensions;
/// Returns a mutable reference to the associated extensions.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let mut request: Request = Request::get("/").unwrap();
/// request.extensions_mut().insert("hello");
/// assert_eq!(request.extensions().get(), Some(&"hello"));
/// ```
#[inline]
pub fn extensions_mut(&mut self) -> &mut http::Extensions;
}
}
impl crate::HttpEntity for Request {
#[inline]
fn body_mut(&mut self) -> &mut hyper::Body {
self.0.body_mut()
}
#[inline]
fn headers(&self) -> &http::HeaderMap {
self.0.headers()
}
#[inline]
fn headers_mut(&mut self) -> &mut http::HeaderMap {
self.0.headers_mut()
}
}
impl From<http::Request<hyper::Body>> for Request {
fn from(r: http::Request<hyper::Body>) -> Self {
Request(r)
}
}