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
use std::cell::RefCell; use std::net::SocketAddr; use std::fmt; use term_painter::Color::*; use term_painter::ToStyle; use state::Container; use error::Error; use super::{FromParam, FromSegments}; use router::Route; use http::uri::{URI, Segments}; use http::{Method, ContentType, Header, HeaderMap, Cookie, Cookies}; use http::hyper; /// The type of an incoming web request. /// /// This should be used sparingly in Rocket applications. In particular, it /// should likely only be used when writing /// [FromRequest](/rocket/request/trait.FromRequest.html) implementations. It /// contains all of the information for a given web request except for the body /// data. This includes the HTTP method, URI, cookies, headers, and more. pub struct Request<'r> { method: Method, uri: URI<'r>, headers: HeaderMap<'r>, remote: Option<SocketAddr>, params: RefCell<Vec<(usize, usize)>>, cookies: Cookies, state: Option<&'r Container>, } impl<'r> Request<'r> { /// Create a new `Request` with the given `method` and `uri`. The `uri` /// parameter can be of any type that implements `Into<URI>` including /// `&str` and `String`; it must be a valid absolute URI. /// /// # Example /// /// ```rust /// use rocket::Request; /// use rocket::http::Method; /// /// # #[allow(unused_variables)] /// let request = Request::new(Method::Get, "/uri"); /// ``` pub fn new<U: Into<URI<'r>>>(method: Method, uri: U) -> Request<'r> { Request { method: method, uri: uri.into(), headers: HeaderMap::new(), remote: None, params: RefCell::new(Vec::new()), cookies: Cookies::new(&[]), state: None } } /// Retrieve the method from `self`. /// /// # Example /// /// ```rust /// use rocket::Request; /// use rocket::http::Method; /// /// let request = Request::new(Method::Get, "/uri"); /// assert_eq!(request.method(), Method::Get); /// ``` #[inline(always)] pub fn method(&self) -> Method { self.method } /// Set the method of `self`. /// /// # Example /// /// ```rust /// use rocket::Request; /// use rocket::http::Method; /// /// let mut request = Request::new(Method::Get, "/uri"); /// assert_eq!(request.method(), Method::Get); /// /// request.set_method(Method::Post); /// assert_eq!(request.method(), Method::Post); /// ``` #[inline(always)] pub fn set_method(&mut self, method: Method) { self.method = method; } /// Borrow the URI from `self`, which must be an absolute URI. /// /// # Example /// /// ```rust /// use rocket::Request; /// use rocket::http::Method; /// /// let request = Request::new(Method::Get, "/uri"); /// assert_eq!(request.uri().as_str(), "/uri"); /// ``` #[inline(always)] pub fn uri(&self) -> &URI { &self.uri } /// Set the URI in `self`. The `uri` parameter can be of any type that /// implements `Into<URI>` including `&str` and `String`; it must be a valid /// absolute URI. /// /// # Example /// /// ```rust /// use rocket::Request; /// use rocket::http::Method; /// /// let mut request = Request::new(Method::Get, "/uri"); /// /// request.set_uri("/hello/Sergio?type=greeting"); /// assert_eq!(request.uri().as_str(), "/hello/Sergio?type=greeting"); /// ``` #[inline(always)] pub fn set_uri<'u: 'r, U: Into<URI<'u>>>(&mut self, uri: U) { self.uri = uri.into(); self.params = RefCell::new(Vec::new()); } /// Returns the address of the remote connection that initiated this /// request if the address is known. If the address is not known, `None` is /// returned. /// /// # Example /// /// ```rust /// use rocket::Request; /// use rocket::http::Method; /// /// let request = Request::new(Method::Get, "/uri"); /// assert!(request.remote().is_none()); /// ``` #[inline(always)] pub fn remote(&self) -> Option<SocketAddr> { self.remote } /// Sets the remote address of `self` to `address`. /// /// # Example /// /// Set the remote address to be 127.0.0.1:8000: /// /// ```rust /// use rocket::Request; /// use rocket::http::Method; /// use std::net::{SocketAddr, IpAddr, Ipv4Addr}; /// /// let mut request = Request::new(Method::Get, "/uri"); /// /// let (ip, port) = (IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8000); /// let localhost = SocketAddr::new(ip, port); /// request.set_remote(localhost); /// /// assert_eq!(request.remote(), Some(localhost)); /// ``` #[doc(hidden)] #[inline(always)] pub fn set_remote(&mut self, address: SocketAddr) { self.remote = Some(address); } /// Returns a `HeaderMap` of all of the headers in `self`. /// /// # Example /// /// ```rust /// use rocket::Request; /// use rocket::http::Method; /// /// let request = Request::new(Method::Get, "/uri"); /// let header_map = request.headers(); /// assert!(header_map.is_empty()); /// ``` #[inline(always)] pub fn headers(&self) -> &HeaderMap<'r> { &self.headers } /// Add the `header` to `self`'s headers. /// /// # Example /// /// ```rust /// use rocket::Request; /// use rocket::http::{Method, ContentType}; /// /// let mut request = Request::new(Method::Get, "/uri"); /// assert!(request.headers().is_empty()); /// /// request.add_header(ContentType::HTML); /// assert!(request.headers().contains("Content-Type")); /// assert_eq!(request.headers().len(), 1); /// ``` #[inline(always)] pub fn add_header<H: Into<Header<'r>>>(&mut self, header: H) { self.headers.add(header.into()); } /// Replaces the value of the header with `header.name` with `header.value`. /// If no such header existed, `header` is added. /// /// # Example /// /// ```rust /// use rocket::Request; /// use rocket::http::{Method, ContentType}; /// /// let mut request = Request::new(Method::Get, "/uri"); /// assert!(request.headers().is_empty()); /// /// request.add_header(ContentType::HTML); /// assert_eq!(request.content_type(), Some(ContentType::HTML)); /// /// request.replace_header(ContentType::JSON); /// assert_eq!(request.content_type(), Some(ContentType::JSON)); /// ``` #[inline(always)] pub fn replace_header<H: Into<Header<'r>>>(&mut self, header: H) { self.headers.replace(header.into()); } /// Returns a borrow to the cookies in `self`. /// /// Note that `Cookies` implements internal mutability, so this method /// allows you to get _and_ set cookies in `self`. /// /// # Example /// /// Add a new cookie to a request's cookies: /// /// ```rust /// use rocket::Request; /// use rocket::http::{Cookie, Method}; /// /// let request = Request::new(Method::Get, "/uri"); /// request.cookies().add(Cookie::new("key", "val")); /// request.cookies().add(Cookie::new("ans", format!("life: {}", 38 + 4))); /// ``` #[inline(always)] pub fn cookies(&self) -> &Cookies { &self.cookies } /// Replace all of the cookies in `self` with `cookies`. #[inline] pub(crate) fn set_cookies(&mut self, cookies: Cookies) { self.cookies = cookies; } /// Returns `Some` of the Content-Type header of `self`. If the header is /// not present, returns `None`. /// /// # Example /// /// ```rust /// use rocket::Request; /// use rocket::http::{Method, ContentType}; /// /// let mut request = Request::new(Method::Get, "/uri"); /// assert_eq!(request.content_type(), None); /// /// request.replace_header(ContentType::JSON); /// assert_eq!(request.content_type(), Some(ContentType::JSON)); /// ``` #[inline(always)] pub fn content_type(&self) -> Option<ContentType> { self.headers().get_one("Content-Type") .and_then(|value| value.parse().ok()) } /// Retrieves and parses into `T` the 0-indexed `n`th dynamic parameter from /// the request. Returns `Error::NoKey` if `n` is greater than the number of /// params. Returns `Error::BadParse` if the parameter type `T` can't be /// parsed from the parameter. /// /// This method exists only to be used by manual routing. To retrieve /// parameters from a request, use Rocket's code generation facilities. /// /// # Example /// /// Retrieve parameter `0`, which is expected to be an `&str`, in a manual /// route: /// /// ```rust /// use rocket::{Request, Data}; /// use rocket::handler::Outcome; /// /// # #[allow(dead_code)] /// fn name<'a>(req: &'a Request, _: Data) -> Outcome<'a> { /// Outcome::of(req.get_param(0).unwrap_or("unnamed")) /// } /// ``` pub fn get_param<'a, T: FromParam<'a>>(&'a self, n: usize) -> Result<T, Error> { let param = self.get_param_str(n).ok_or(Error::NoKey)?; T::from_param(param).map_err(|_| Error::BadParse) } /// Set `self`'s parameters given that the route used to reach this request /// was `route`. This should only be used internally by `Rocket` as improper /// use may result in out of bounds indexing. /// TODO: Figure out the mount path from here. #[inline] pub(crate) fn set_params(&self, route: &Route) { *self.params.borrow_mut() = route.get_param_indexes(self.uri()); } /// Get the `n`th path parameter as a string, if it exists. This is used by /// codegen. #[doc(hidden)] pub fn get_param_str(&self, n: usize) -> Option<&str> { let params = self.params.borrow(); if n >= params.len() { debug!("{} is >= param count {}", n, params.len()); return None; } let (i, j) = params[n]; let path = self.uri.path(); if j > path.len() { error!("Couldn't retrieve parameter: internal count incorrect."); return None; } Some(&path[i..j]) } /// Retrieves and parses into `T` all of the path segments in the request /// URI beginning at the 0-indexed `n`th dynamic parameter. `T` must /// implement [FromSegments](/rocket/request/trait.FromSegments.html), which /// is used to parse the segments. /// /// This method exists only to be used by manual routing. To retrieve /// segments from a request, use Rocket's code generation facilities. /// /// # Error /// /// If there are less than `n` segments, returns an `Err` of `NoKey`. If /// parsing the segments failed, returns an `Err` of `BadParse`. /// /// # Example /// /// If the request URI is `"/hello/there/i/am/here"`, and the matched route /// path for this request is `"/hello/<name>/i/<segs..>"`, then /// `request.get_segments::<T>(1)` will attempt to parse the segments /// `"am/here"` as type `T`. pub fn get_segments<'a, T: FromSegments<'a>>(&'a self, n: usize) -> Result<T, Error> { let segments = self.get_raw_segments(n).ok_or(Error::NoKey)?; T::from_segments(segments).map_err(|_| Error::BadParse) } /// Get the segments beginning at the `n`th dynamic parameter, if they /// exist. Used by codegen. #[doc(hidden)] pub fn get_raw_segments(&self, n: usize) -> Option<Segments> { let params = self.params.borrow(); if n >= params.len() { debug!("{} is >= param (segments) count {}", n, params.len()); return None; } let (i, j) = params[n]; let path = self.uri.path(); if j > path.len() { error!("Couldn't retrieve segments: internal count incorrect."); return None; } Some(Segments(&path[i..j])) } /// Get the managed state container, if it exists. For internal use only! #[inline] pub(crate) fn get_state(&self) -> Option<&'r Container> { self.state } /// Set the state. For internal use only! #[inline] pub(crate) fn set_state(&mut self, state: &'r Container) { self.state = Some(state); } /// Convert from Hyper types into a Rocket Request. pub(crate) fn from_hyp(h_method: hyper::Method, h_headers: hyper::header::Headers, h_uri: hyper::RequestUri, h_addr: SocketAddr, ) -> Result<Request<'r>, String> { // Get a copy of the URI for later use. let uri = match h_uri { hyper::RequestUri::AbsolutePath(s) => s, _ => return Err(format!("Bad URI: {}", h_uri)), }; // Ensure that the method is known. TODO: Allow made-up methods? let method = match Method::from_hyp(&h_method) { Some(method) => method, None => return Err(format!("Invalid method: {}", h_method)) }; // Construct the request object. let mut request = Request::new(method, uri); // Set the request cookies, if they exist. TODO: Use session key. if let Some(cookie_headers) = h_headers.get_raw("Cookie") { let mut cookies = Cookies::new(&[]); for header in cookie_headers { let raw_str = match ::std::str::from_utf8(header) { Ok(string) => string, Err(_) => continue }; for cookie_str in raw_str.split(";") { let cookie = match Cookie::parse_encoded(cookie_str.to_string()) { Ok(cookie) => cookie, Err(_) => continue }; cookies.add_original(cookie); } } request.set_cookies(cookies); } // Set the rest of the headers. for hyp in h_headers.iter() { let header = Header::new(hyp.name().to_string(), hyp.value_string()); request.add_header(header); } // Set the remote address. request.set_remote(h_addr); Ok(request) } } impl<'r> fmt::Display for Request<'r> { /// Pretty prints a Request. This is primarily used by Rocket's logging /// infrastructure. fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!(f, "{} {}", Green.paint(&self.method), Blue.paint(&self.uri))?; if let Some(content_type) = self.content_type() { if self.method.supports_payload() { write!(f, " {}", Yellow.paint(content_type))?; } } Ok(()) } }