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
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
use async_std::io::{self, prelude::*};
use async_std::task::{Context, Poll};
use route_recognizer::Params;

use std::ops::Index;
use std::pin::Pin;

#[cfg(feature = "cookies")]
use crate::cookies::CookieData;
#[cfg(feature = "cookies")]
use crate::http::cookies::Cookie;
use crate::http::format_err;
use crate::http::headers::{self, HeaderName, HeaderValues, ToHeaderValues};
use crate::http::{self, Body, Method, Mime, StatusCode, Url, Version};
use crate::Response;

pin_project_lite::pin_project! {
    /// An HTTP request.

    ///

    /// The `Request` gives endpoints access to basic information about the incoming

    /// request, route parameters, and various ways of accessing the request's body.

    ///

    /// Requests also provide *extensions*, a type map primarily used for low-level

    /// communication between middleware and endpoints.

    #[derive(Debug)]
    pub struct Request<State> {
        pub(crate) state: State,
        #[pin]
        pub(crate) req: http::Request,
        pub(crate) route_params: Vec<Params>,
    }
}

impl<State> Request<State> {
    /// Create a new `Request`.

    pub(crate) fn new(state: State, req: http_types::Request, route_params: Vec<Params>) -> Self {
        Self {
            state,
            req,
            route_params,
        }
    }

    /// Access the request's HTTP method.

    ///

    /// # Examples

    ///

    /// ```no_run

    /// # use async_std::task::block_on;

    /// # fn main() -> Result<(), std::io::Error> { block_on(async {

    /// #

    /// use tide::Request;

    ///

    /// let mut app = tide::new();

    /// app.at("/").get(|req: Request<()>| async move {

    ///     assert_eq!(req.method(), http_types::Method::Get);

    ///     Ok("")

    /// });

    /// app.listen("127.0.0.1:8080").await?;

    /// #

    /// # Ok(()) })}

    /// ```

    #[must_use]
    pub fn method(&self) -> Method {
        self.req.method()
    }

    /// Access the request's full URI method.

    ///

    /// # Examples

    ///

    /// ```no_run

    /// # use async_std::task::block_on;

    /// # fn main() -> Result<(), std::io::Error> { block_on(async {

    /// #

    /// use tide::Request;

    ///

    /// let mut app = tide::new();

    /// app.at("/").get(|req: Request<()>| async move {

    ///     assert_eq!(req.url(), &"/".parse::<tide::http::Url>().unwrap());

    ///     Ok("")

    /// });

    /// app.listen("127.0.0.1:8080").await?;

    /// #

    /// # Ok(()) })}

    /// ```

    #[must_use]
    pub fn url(&self) -> &Url {
        self.req.url()
    }

    /// Access the request's HTTP version.

    ///

    /// # Examples

    ///

    /// ```no_run

    /// # use async_std::task::block_on;

    /// # fn main() -> Result<(), std::io::Error> { block_on(async {

    /// #

    /// use tide::Request;

    ///

    /// let mut app = tide::new();

    /// app.at("/").get(|req: Request<()>| async move {

    ///     assert_eq!(req.version(), Some(http_types::Version::Http1_1));

    ///     Ok("")

    /// });

    /// app.listen("127.0.0.1:8080").await?;

    /// #

    /// # Ok(()) })}

    /// ```

    #[must_use]
    pub fn version(&self) -> Option<Version> {
        self.req.version()
    }

    /// Get the peer socket address for the underlying transport, if

    /// that information is available for this request.

    #[must_use]
    pub fn peer_addr(&self) -> Option<&str> {
        self.req.peer_addr()
    }

    /// Get the local socket address for the underlying transport, if

    /// that information is available for this request.

    #[must_use]
    pub fn local_addr(&self) -> Option<&str> {
        self.req.local_addr()
    }

    /// Get the remote address for this request.

    ///

    /// This is determined in the following priority:

    /// 1. `Forwarded` header `for` key

    /// 2. The first `X-Forwarded-For` header

    /// 3. Peer address of the transport

    #[must_use]
    pub fn remote(&self) -> Option<&str> {
        self.req.remote()
    }

    /// Get the destination host for this request.

    ///

    /// This is determined in the following priority:

    /// 1. `Forwarded` header `host` key

    /// 2. The first `X-Forwarded-Host` header

    /// 3. `Host` header

    /// 4. URL domain, if any

    #[must_use]
    pub fn host(&self) -> Option<&str> {
        self.req.host()
    }

    /// Get the request content type as a `Mime`.

    ///

    /// This gets the request `Content-Type` header.

    ///

    /// [Read more on MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)

    #[must_use]
    pub fn content_type(&self) -> Option<Mime> {
        self.req.content_type()
    }

    /// Get an HTTP header.

    ///

    /// # Examples

    ///

    /// ```no_run

    /// # use async_std::task::block_on;

    /// # fn main() -> Result<(), std::io::Error> { block_on(async {

    /// #

    /// use tide::Request;

    ///

    /// let mut app = tide::new();

    /// app.at("/").get(|req: Request<()>| async move {

    ///     assert_eq!(req.header("X-Forwarded-For").unwrap(), "127.0.0.1");

    ///     Ok("")

    /// });

    /// app.listen("127.0.0.1:8080").await?;

    /// #

    /// # Ok(()) })}

    /// ```

    #[must_use]
    pub fn header(
        &self,
        key: impl Into<http_types::headers::HeaderName>,
    ) -> Option<&http_types::headers::HeaderValues> {
        self.req.header(key)
    }

    /// Get a mutable reference to a header.

    pub fn header_mut(&mut self, name: impl Into<HeaderName>) -> Option<&mut HeaderValues> {
        self.req.header_mut(name)
    }

    /// Set an HTTP header.

    pub fn insert_header(
        &mut self,
        name: impl Into<HeaderName>,
        values: impl ToHeaderValues,
    ) -> Option<HeaderValues> {
        self.req.insert_header(name, values)
    }

    /// Append a header to the headers.

    ///

    /// Unlike `insert` this function will not override the contents of a header, but insert a

    /// header if there aren't any. Or else append to the existing list of headers.

    pub fn append_header(&mut self, name: impl Into<HeaderName>, values: impl ToHeaderValues) {
        self.req.append_header(name, values)
    }

    /// Remove a header.

    pub fn remove_header(&mut self, name: impl Into<HeaderName>) -> Option<HeaderValues> {
        self.req.remove_header(name)
    }

    /// An iterator visiting all header pairs in arbitrary order.

    #[must_use]
    pub fn iter(&self) -> headers::Iter<'_> {
        self.req.iter()
    }

    /// An iterator visiting all header pairs in arbitrary order, with mutable references to the

    /// values.

    #[must_use]
    pub fn iter_mut(&mut self) -> headers::IterMut<'_> {
        self.req.iter_mut()
    }

    /// An iterator visiting all header names in arbitrary order.

    #[must_use]
    pub fn header_names(&self) -> headers::Names<'_> {
        self.req.header_names()
    }

    /// An iterator visiting all header values in arbitrary order.

    #[must_use]
    pub fn header_values(&self) -> headers::Values<'_> {
        self.req.header_values()
    }

    /// Get a request extension value.

    #[must_use]
    pub fn ext<T: Send + Sync + 'static>(&self) -> Option<&T> {
        self.req.ext().get()
    }

    /// Get a mutable reference to value stored in request extensions.

    #[must_use]
    pub fn ext_mut<T: Send + Sync + 'static>(&mut self) -> Option<&mut T> {
        self.req.ext_mut().get_mut()
    }

    /// Set a request extension value.

    pub fn set_ext<T: Send + Sync + 'static>(&mut self, val: T) -> Option<T> {
        self.req.ext_mut().insert(val)
    }

    #[must_use]
    ///  Access application scoped state.

    pub fn state(&self) -> &State {
        &self.state
    }

    /// Extract and parse a route parameter by name.

    ///

    /// Returns the parameter as a `&str`, borrowed from this `Request`.

    ///

    /// The name should *not* include the leading `:` or the trailing `*` (if

    /// any).

    ///

    /// # Errors

    ///

    /// An error is returned if `key` is not a valid parameter for the route.

    ///

    /// # Examples

    ///

    /// ```no_run

    /// # use async_std::task::block_on;

    /// # fn main() -> Result<(), std::io::Error> { block_on(async {

    /// #

    /// use tide::{Request, Result};

    ///

    /// async fn greet(req: Request<()>) -> Result<String> {

    ///     let name = req.param("name").unwrap_or("world");

    ///     Ok(format!("Hello, {}!", name))

    /// }

    ///

    /// let mut app = tide::new();

    /// app.at("/hello").get(greet);

    /// app.at("/hello/:name").get(greet);

    /// app.listen("127.0.0.1:8080").await?;

    /// #

    /// # Ok(()) })}

    /// ```

    pub fn param(&self, key: &str) -> crate::Result<&str> {
        self.route_params
            .iter()
            .rev()
            .find_map(|params| params.find(key))
            .ok_or_else(|| format_err!("Param \"{}\" not found", key.to_string()))
    }

    /// Parse the URL query component into a struct, using [serde_qs](https://docs.rs/serde_qs). To

    /// get the entire query as an unparsed string, use `request.url().query()`

    ///

    /// ```rust

    /// # fn main() -> Result<(), std::io::Error> { async_std::task::block_on(async {

    /// use tide::prelude::*;

    /// let mut app = tide::new();

    ///

    /// #[derive(Deserialize)]

    /// #[serde(default)]

    /// struct Page {

    ///     size: u8,

    ///     offset: u8,

    /// }

    /// impl Default for Page {

    ///     fn default() -> Self {

    ///         Self {

    ///             size: 25,

    ///             offset: 0,

    ///         }

    ///     }

    /// }

    /// app.at("/pages").post(|req: tide::Request<()>| async move {

    ///     let page: Page = req.query()?;

    ///     Ok(format!("page {}, with {} items", page.offset, page.size))

    /// });

    ///

    /// # if false {

    /// app.listen("localhost:8000").await?;

    /// # }

    ///

    /// // $ curl localhost:8000/pages

    /// // page 0, with 25 items

    ///

    /// // $ curl localhost:8000/pages?offset=1

    /// // page 1, with 25 items

    ///

    /// // $ curl localhost:8000/pages?offset=2&size=50

    /// // page 2, with 50 items

    ///

    /// // $ curl localhost:8000/pages?size=5000

    /// // failed with reason: number too large to fit in target type

    ///

    /// // $ curl localhost:8000/pages?size=all

    /// // failed with reason: invalid digit found in string

    /// # Ok(()) })}

    /// ```


    pub fn query<T: serde::de::DeserializeOwned>(&self) -> crate::Result<T> {
        self.req.query()
    }

    /// Set the body reader.

    pub fn set_body(&mut self, body: impl Into<Body>) {
        self.req.set_body(body)
    }

    /// Take the request body as a `Body`.

    ///

    /// This method can be called after the body has already been taken or read,

    /// but will return an empty `Body`.

    ///

    /// This is useful for consuming the body via an AsyncReader or AsyncBufReader.

    pub fn take_body(&mut self) -> Body {
        self.req.take_body()
    }

    /// Reads the entire request body into a byte buffer.

    ///

    /// This method can be called after the body has already been read, but will

    /// produce an empty buffer.

    ///

    /// # Errors

    ///

    /// Any I/O error encountered while reading the body is immediately returned

    /// as an `Err`.

    ///

    /// # Examples

    ///

    /// ```no_run

    /// # use async_std::task::block_on;

    /// # fn main() -> Result<(), std::io::Error> { block_on(async {

    /// #

    /// use tide::Request;

    ///

    /// let mut app = tide::new();

    /// app.at("/").get(|mut req: Request<()>| async move {

    ///     let _body: Vec<u8> = req.body_bytes().await.unwrap();

    ///     Ok("")

    /// });

    /// app.listen("127.0.0.1:8080").await?;

    /// #

    /// # Ok(()) })}

    /// ```

    pub async fn body_bytes(&mut self) -> crate::Result<Vec<u8>> {
        let res = self.req.body_bytes().await?;
        Ok(res)
    }

    /// Reads the entire request body into a string.

    ///

    /// This method can be called after the body has already been read, but will

    /// produce an empty buffer.

    ///

    /// # Errors

    ///

    /// Any I/O error encountered while reading the body is immediately returned

    /// as an `Err`.

    ///

    /// If the body cannot be interpreted as valid UTF-8, an `Err` is returned.

    ///

    /// # Examples

    ///

    /// ```no_run

    /// # use async_std::task::block_on;

    /// # fn main() -> Result<(), std::io::Error> { block_on(async {

    /// #

    /// use tide::Request;

    ///

    /// let mut app = tide::new();

    /// app.at("/").get(|mut req: Request<()>| async move {

    ///     let _body: String = req.body_string().await.unwrap();

    ///     Ok("")

    /// });

    /// app.listen("127.0.0.1:8080").await?;

    /// #

    /// # Ok(()) })}

    /// ```

    pub async fn body_string(&mut self) -> crate::Result<String> {
        let res = self.req.body_string().await?;
        Ok(res)
    }

    /// Reads and deserialized the entire request body via json.

    ///

    /// # Errors

    ///

    /// Any I/O error encountered while reading the body is immediately returned

    /// as an `Err`.

    ///

    /// If the body cannot be interpreted as valid json for the target type `T`,

    /// an `Err` is returned.

    pub async fn body_json<T: serde::de::DeserializeOwned>(&mut self) -> crate::Result<T> {
        let res = self.req.body_json().await?;
        Ok(res)
    }

    /// Parse the request body as a form.

    ///

    /// ```rust

    /// # fn main() -> Result<(), std::io::Error> { async_std::task::block_on(async {

    /// use tide::prelude::*;

    /// let mut app = tide::new();

    ///

    /// #[derive(Deserialize)]

    /// struct Animal {

    ///   name: String,

    ///   legs: u8

    /// }

    ///

    /// app.at("/").post(|mut req: tide::Request<()>| async move {

    ///     let animal: Animal = req.body_form().await?;

    ///     Ok(format!(

    ///         "hello, {}! i've put in an order for {} shoes",

    ///         animal.name, animal.legs

    ///     ))

    /// });

    ///

    /// # if false {

    /// app.listen("localhost:8000").await?;

    /// # }

    ///

    /// // $ curl localhost:8000/orders/shoes -d "name=chashu&legs=4"

    /// // hello, chashu! i've put in an order for 4 shoes

    ///

    /// // $ curl localhost:8000/orders/shoes -d "name=mary%20millipede&legs=750"

    /// // number too large to fit in target type

    /// # Ok(()) })}

    /// ```

    pub async fn body_form<T: serde::de::DeserializeOwned>(&mut self) -> crate::Result<T> {
        let res = self.req.body_form().await?;
        Ok(res)
    }

    /// returns a `Cookie` by name of the cookie.

    #[cfg(feature = "cookies")]
    #[must_use]
    pub fn cookie(&self, name: &str) -> Option<Cookie<'static>> {
        self.ext::<CookieData>()
            .and_then(|cookie_data| cookie_data.content.read().unwrap().get(name).cloned())
    }

    /// Retrieves a reference to the current session.

    ///

    /// # Panics

    ///

    /// This method will panic if a tide::sessions:SessionMiddleware has not

    /// been run.

    #[cfg(feature = "sessions")]
    pub fn session(&self) -> &crate::sessions::Session {
        self.ext::<crate::sessions::Session>().expect(
            "request session not initialized, did you enable tide::sessions::SessionMiddleware?",
        )
    }

    /// Retrieves a mutable reference to the current session.

    ///

    /// # Panics

    ///

    /// This method will panic if a tide::sessions:SessionMiddleware has not

    /// been run.

    #[cfg(feature = "sessions")]
    pub fn session_mut(&mut self) -> &mut crate::sessions::Session {
        self.ext_mut().expect(
            "request session not initialized, did you enable tide::sessions::SessionMiddleware?",
        )
    }

    /// Get the length of the body stream, if it has been set.

    ///

    /// This value is set when passing a fixed-size object into as the body. E.g. a string, or a

    /// buffer. Consumers of this API should check this value to decide whether to use `Chunked`

    /// encoding, or set the response length.

    #[must_use]
    pub fn len(&self) -> Option<usize> {
        self.req.len()
    }

    /// Returns `true` if the request has a set body stream length of zero, `false` otherwise.

    #[must_use]
    pub fn is_empty(&self) -> Option<bool> {
        Some(self.req.len()? == 0)
    }
}

impl<State> AsRef<http::Request> for Request<State> {
    fn as_ref(&self) -> &http::Request {
        &self.req
    }
}

impl<State> AsMut<http::Request> for Request<State> {
    fn as_mut(&mut self) -> &mut http::Request {
        &mut self.req
    }
}

impl<State> AsRef<http::Headers> for Request<State> {
    fn as_ref(&self) -> &http::Headers {
        self.req.as_ref()
    }
}

impl<State> AsMut<http::Headers> for Request<State> {
    fn as_mut(&mut self) -> &mut http::Headers {
        self.req.as_mut()
    }
}

impl<State> Read for Request<State> {
    fn poll_read(
        self: Pin<&mut Self>,
        cx: &mut Context<'_>,
        buf: &mut [u8],
    ) -> Poll<io::Result<usize>> {
        self.project().req.poll_read(cx, buf)
    }
}

impl<State> Into<http::Request> for Request<State> {
    fn into(self) -> http::Request {
        self.req
    }
}

impl<State: Default> Into<Request<State>> for http_types::Request {
    fn into(self) -> Request<State> {
        Request::new(State::default(), self, Vec::<Params>::new())
    }
}

// NOTE: From cannot be implemented for this conversion because `State` needs to

// be constrained by a type.

impl<State: Clone + Send + Sync + 'static> Into<Response> for Request<State> {
    fn into(mut self) -> Response {
        let mut res = Response::new(StatusCode::Ok);
        res.set_body(self.take_body());
        res
    }
}

impl<State> IntoIterator for Request<State> {
    type Item = (HeaderName, HeaderValues);
    type IntoIter = http_types::headers::IntoIter;

    /// Returns a iterator of references over the remaining items.

    #[inline]
    fn into_iter(self) -> Self::IntoIter {
        self.req.into_iter()
    }
}

impl<'a, State> IntoIterator for &'a Request<State> {
    type Item = (&'a HeaderName, &'a HeaderValues);
    type IntoIter = http_types::headers::Iter<'a>;

    #[inline]
    fn into_iter(self) -> Self::IntoIter {
        self.req.iter()
    }
}

impl<'a, State> IntoIterator for &'a mut Request<State> {
    type Item = (&'a HeaderName, &'a mut HeaderValues);
    type IntoIter = http_types::headers::IterMut<'a>;

    #[inline]
    fn into_iter(self) -> Self::IntoIter {
        self.req.iter_mut()
    }
}

impl<State> Index<HeaderName> for Request<State> {
    type Output = HeaderValues;

    /// Returns a reference to the value corresponding to the supplied name.

    ///

    /// # Panics

    ///

    /// Panics if the name is not present in `Request`.

    #[inline]
    fn index(&self, name: HeaderName) -> &HeaderValues {
        &self.req[name]
    }
}

impl<State> Index<&str> for Request<State> {
    type Output = HeaderValues;

    /// Returns a reference to the value corresponding to the supplied name.

    ///

    /// # Panics

    ///

    /// Panics if the name is not present in `Request`.

    #[inline]
    fn index(&self, name: &str) -> &HeaderValues {
        &self.req[name]
    }
}

pub(crate) fn rest(route_params: &[Params]) -> Option<&str> {
    route_params
        .last()
        .and_then(|params| params.find("--tide-path-rest"))
}