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
use std::ops::{Deref, DerefMut};
use serde::de::DeserializeOwned;
use crate::{
error::ParseFormError,
http::{
header::{self, HeaderValue},
Method,
},
web::RequestBody,
FromRequest, Request, Result,
};
/// An extractor that can deserialize some type from query string or body.
///
/// If the method is not `GET`, the query parameters will be parsed from the
/// body, otherwise it is like [`Query`](crate::web::Query).
///
/// If the `Content-Type` is not `application/x-www-form-urlencoded`, then a
/// `Bad Request` response will be returned.
///
/// # Errors
///
/// - [`ReadBodyError`](crate::error::ReadBodyError)
/// - [`ParseFormError`]
///
/// # Example
///
/// ```
/// use poem::{
/// get, handler,
/// http::{Method, StatusCode, Uri},
/// web::Form,
/// Endpoint, Request, Route,
/// };
/// use serde::Deserialize;
///
/// #[derive(Deserialize)]
/// struct CreateDocument {
/// title: String,
/// content: String,
/// }
///
/// #[handler]
/// fn index(Form(CreateDocument { title, content }): Form<CreateDocument>) -> String {
/// format!("{}:{}", title, content)
/// }
///
/// # tokio::runtime::Runtime::new().unwrap().block_on(async {
/// let app = Route::new().at("/", get(index).post(index));
///
/// let resp = app
/// .call(
/// Request::builder()
/// .uri(Uri::from_static("/?title=foo&content=bar"))
/// .finish(),
/// )
/// .await
/// .unwrap();
/// assert_eq!(resp.status(), StatusCode::OK);
/// assert_eq!(resp.into_body().into_string().await.unwrap(), "foo:bar");
///
/// let resp = app
/// .call(
/// Request::builder()
/// .method(Method::POST)
/// .uri(Uri::from_static("/"))
/// .content_type("application/x-www-form-urlencoded")
/// .body("title=foo&content=bar"),
/// )
/// .await
/// .unwrap();
/// assert_eq!(resp.status(), StatusCode::OK);
/// assert_eq!(resp.into_body().into_string().await.unwrap(), "foo:bar");
/// # });
/// ```
pub struct Form<T>(pub T);
impl<T> Deref for Form<T> {
type Target = T;
fn deref(&self) -> &Self::Target {
&self.0
}
}
impl<T> DerefMut for Form<T> {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.0
}
}
#[async_trait::async_trait]
impl<'a, T: DeserializeOwned> FromRequest<'a> for Form<T> {
async fn from_request(req: &'a Request, body: &mut RequestBody) -> Result<Self> {
if req.method() == Method::GET {
Ok(
serde_urlencoded::from_str(req.uri().query().unwrap_or_default())
.map_err(ParseFormError::UrlDecode)
.map(Self)?,
)
} else {
let content_type = req.headers().get(header::CONTENT_TYPE);
if content_type
!= Some(&HeaderValue::from_static(
"application/x-www-form-urlencoded",
))
{
return match content_type.and_then(|value| value.to_str().ok()) {
Some(ty) => Err(ParseFormError::InvalidContentType(ty.to_string()).into()),
None => Err(ParseFormError::ContentTypeRequired.into()),
};
}
Ok(Self(
serde_urlencoded::from_bytes(&body.take()?.into_vec().await?)
.map_err(ParseFormError::UrlDecode)?,
))
}
}
}
#[cfg(test)]
mod tests {
use serde::Deserialize;
use super::*;
use crate::{handler, http::Uri, Endpoint};
#[tokio::test]
async fn test_form_extractor() {
#[derive(Deserialize)]
struct CreateResource {
name: String,
value: i32,
}
#[handler(internal)]
async fn index(form: Form<CreateResource>) {
assert_eq!(form.name, "abc");
assert_eq!(form.value, 100);
}
index
.call(
Request::builder()
.uri(Uri::from_static("/?name=abc&value=100"))
.finish(),
)
.await
.unwrap();
index
.call(
Request::builder()
.method(Method::POST)
.header(header::CONTENT_TYPE, "application/x-www-form-urlencoded")
.body("name=abc&value=100"),
)
.await
.unwrap();
assert!(index
.call(
Request::builder()
.method(Method::POST)
.header(header::CONTENT_TYPE, "application/json")
.body("name=abc&value=100"),
)
.await
.unwrap_err()
.is::<ParseFormError>());
}
}