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
use std::ops::{Deref, DerefMut};
use http::StatusCode;
use serde::{de::DeserializeOwned, Serialize};
use crate::{
error::ParseXmlError, http::header, web::RequestBody, FromRequest, IntoResponse, Request,
Response, Result,
};
/// XML extractor and response.
///
/// To extract the specified type of XML from the body, `T` must implement
/// [`serde::Deserialize`].
///
/// # Errors
///
/// - [`ReadBodyError`](crate::error::ReadBodyError)
/// - [`ParseXmlError`]
///
/// ```
/// use poem::{
/// handler,
/// http::{header, Method, StatusCode},
/// post,
/// test::TestClient,
/// web::Xml,
/// Endpoint, Request, Route,
/// };
/// use serde::Deserialize;
///
/// #[derive(Deserialize)]
/// struct User {
/// name: String,
/// }
///
/// #[handler]
/// async fn index(Xml(user): Xml<User>) -> String {
/// format!("welcome {}!", user.name)
/// }
///
/// let app = Route::new().at("/", post(index));
/// let cli = TestClient::new(app);
///
/// # tokio::runtime::Runtime::new().unwrap().block_on(async {
/// let resp = cli
/// .post("/")
/// .header(header::CONTENT_TYPE, "application/xml")
/// .body(r#"<User name="foo"/>"#)
/// .send()
/// .await;
/// resp.assert_status_is_ok();
/// resp.assert_text("welcome foo!").await;
/// # });
/// ```
///
/// # Response
///
/// To serialize the specified type to XML, `T` must implement
/// [`serde::Serialize`].
///
/// ```
/// use poem::{
/// get, handler, http::StatusCode, test::TestClient, web::Xml, Endpoint, Request, Route,
/// };
/// use serde::Serialize;
///
/// #[derive(Serialize)]
/// struct User {
/// name: String,
/// }
///
/// #[handler]
/// async fn index() -> Xml<User> {
/// Xml(User {
/// name: "foo".to_string(),
/// })
/// }
///
/// let app = Route::new().at("/", get(index));
/// let cli = TestClient::new(app);
///
/// # tokio::runtime::Runtime::new().unwrap().block_on(async {
/// let resp = cli.get("/").send().await;
/// resp.assert_status_is_ok();
/// resp.assert_text(r#"<User name="foo"/>"#).await;
/// # });
/// ```
#[cfg_attr(docsrs, doc(cfg(feature = "xml")))]
#[derive(Debug, Clone, Eq, PartialEq, Default)]
pub struct Xml<T>(pub T);
impl<T> Deref for Xml<T> {
type Target = T;
fn deref(&self) -> &Self::Target {
&self.0
}
}
impl<T> DerefMut for Xml<T> {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.0
}
}
#[async_trait::async_trait]
impl<'a, T: DeserializeOwned> FromRequest<'a> for Xml<T> {
async fn from_request(req: &'a Request, body: &mut RequestBody) -> Result<Self> {
let content_type = req
.headers()
.get(header::CONTENT_TYPE)
.and_then(|content_type| content_type.to_str().ok())
.ok_or(ParseXmlError::ContentTypeRequired)?;
if !is_xml_content_type(content_type) {
return Err(ParseXmlError::InvalidContentType(content_type.into()).into());
}
Ok(Self(
quick_xml::de::from_reader(body.take()?.into_bytes().await?.as_ref())
.map_err(ParseXmlError::Parse)?,
))
}
}
fn is_xml_content_type(content_type: &str) -> bool {
matches!(content_type.parse::<mime::Mime>(),
Ok(content_type) if content_type.type_() == "application"
&& (content_type.subtype() == "xml"
|| content_type
.suffix()
.map_or(false, |v| v == "xml")))
}
impl<T: Serialize + Send> IntoResponse for Xml<T> {
fn into_response(self) -> Response {
let data = match quick_xml::se::to_string(&self.0) {
Ok(data) => data,
Err(err) => {
return Response::builder()
.status(StatusCode::INTERNAL_SERVER_ERROR)
.body(err.to_string())
}
};
Response::builder()
.header(header::CONTENT_TYPE, "application/xml; charset=utf-8")
.body(data)
}
}
#[cfg(test)]
mod tests {
use serde::{Deserialize, Serialize};
use super::*;
use crate::{handler, test::TestClient};
#[derive(Deserialize, Serialize, Debug, Eq, PartialEq)]
struct CreateResource {
name: String,
value: i32,
}
#[tokio::test]
async fn test_xml_extractor() {
#[handler(internal)]
async fn index(query: Xml<CreateResource>) {
assert_eq!(query.name, "abc");
assert_eq!(query.value, 100);
}
let cli = TestClient::new(index);
cli.post("/")
.body_xml(&CreateResource {
name: "abc".to_string(),
value: 100,
}) // body_xml has already set request with `application/xml` content type
.send()
.await
.assert_status_is_ok();
}
#[tokio::test]
async fn test_xml_extractor_fail() {
#[handler(internal)]
async fn index(query: Xml<CreateResource>) {
assert_eq!(query.name, "abc");
assert_eq!(query.value, 100);
}
let create_resource = CreateResource {
name: "abc".to_string(),
value: 100,
};
let cli = TestClient::new(index);
cli.post("/")
// .header(header::CONTENT_TYPE, "application/json")
.body(quick_xml::se::to_string(&create_resource).expect("Invalid xml"))
.send()
.await
.assert_status(StatusCode::UNSUPPORTED_MEDIA_TYPE);
}
#[tokio::test]
async fn test_xml_response() {
#[handler(internal)]
async fn index() -> Xml<CreateResource> {
Xml(CreateResource {
name: "abc".to_string(),
value: 100,
})
}
let cli = TestClient::new(index);
let resp = cli.get("/").send().await;
resp.assert_status_is_ok();
resp.assert_xml(&CreateResource {
name: "abc".to_string(),
value: 100,
})
.await;
}
}