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
//! Query extractor (serde_qs based). use crate::error::Error; use std::ops::Deref; use std::sync::Arc; use std::{fmt, ops}; use actix_web::{FromRequest, HttpRequest}; use futures::future::{err, ok, Ready}; use serde::de; use serde_qs::Config as QsConfig; use validator::Validate; /// Query extractor configuration (serde_qs based). /// /// ```rust /// use actix_web::{error, web, App, FromRequest, HttpResponse}; /// use serde_qs::actix::QsQuery; /// use serde_qs::Config as QsConfig; /// use serde::Deserialize; /// /// #[derive(Deserialize)] /// struct Info { /// username: String, /// } /// /// /// deserialize `Info` from request's querystring /// fn index(info: QsQuery<Info>) -> HttpResponse { /// format!("Welcome {}!", info.username).into() /// } /// /// fn main() { /// let app = App::new().service( /// web::resource("/index.html").app_data( /// // change query extractor configuration /// QsQuery::<Info>::configure(|cfg| { /// cfg.error_handler(|err, req| { // <- create custom error response /// error::InternalError::from_response( /// err, HttpResponse::Conflict().finish()).into() /// }) /// .qs_config(QsConfig::default()) /// })) /// .route(web::post().to(index)) /// ); /// } /// ``` pub struct QsQueryConfig { ehandler: Option<Arc<dyn Fn(Error, &HttpRequest) -> actix_web::Error + Send + Sync>>, qs_config: QsConfig, } impl QsQueryConfig { /// Set custom error handler pub fn error_handler<F>(mut self, f: F) -> Self where F: Fn(Error, &HttpRequest) -> actix_web::Error + Send + Sync + 'static, { self.ehandler = Some(Arc::new(f)); self } /// Set custom serialization parameters pub fn qs_config(mut self, config: QsConfig) -> Self { self.qs_config = config; self } } impl Default for QsQueryConfig { fn default() -> Self { QsQueryConfig { ehandler: None, qs_config: QsConfig::default(), } } } /// Extract and validate typed information from the request's query (serde_qs based). /// /// For query decoding uses [serde_qs](https://docs.rs/serde_qs/latest/serde_qs/) crate /// [`QsQueryConfig`] allows to configure extraction process. /// /// ## Example /// /// ```rust /// use actix_web::{web, App}; /// use serde::Deserialize; /// use actix_web_validator::QsQuery; /// use validator::Validate; /// /// #[derive(Debug, Deserialize)] /// pub enum ResponseType { /// Token, /// Code /// } /// /// #[derive(Deserialize, Validate)] /// pub struct AuthRequest { /// #[validate(range(min = 1000, max = 9999))] /// id: u64, /// response_type: ResponseType, /// } /// /// // Use `Query` extractor for query information (and destructure it within the signature). /// // This handler gets called only if the request's query string contains a `id` and /// // `response_type` fields. /// // The correct request for this handler would be `/index.html?id=1234&response_type=Code"`. /// async fn index(info: QsQuery<AuthRequest>) -> String { /// format!("Authorization request for client with id={} and type={:?}!", info.id, info.response_type) /// } /// /// fn main() { /// let app = App::new().service( /// web::resource("/index.html").route(web::get().to(index))); // <- use `Query` extractor /// } /// ``` #[derive(PartialEq, Eq, PartialOrd, Ord)] pub struct QsQuery<T>(pub T); impl<T> AsRef<T> for QsQuery<T> { fn as_ref(&self) -> &T { &self.0 } } impl<T> Deref for QsQuery<T> { type Target = T; fn deref(&self) -> &T { &self.0 } } impl<T> ops::DerefMut for QsQuery<T> { fn deref_mut(&mut self) -> &mut T { &mut self.0 } } impl<T: fmt::Debug> fmt::Debug for QsQuery<T> { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { self.0.fmt(f) } } impl<T: fmt::Display> fmt::Display for QsQuery<T> { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { self.0.fmt(f) } } impl<T> QsQuery<T> where T: Validate, { /// Deconstruct to an inner value. pub fn into_inner(self) -> T { self.0 } } /// Extract typed information from the request's query. /// /// ## Example /// /// ```rust /// use actix_web::{web, App}; /// use serde::Deserialize; /// use actix_web_validator::QsQuery; /// use validator::Validate; /// /// #[derive(Debug, Deserialize)] /// pub enum ResponseType { /// Token, /// Code /// } /// /// #[derive(Deserialize, Validate)] /// pub struct AuthRequest { /// #[validate(range(min = 1000, max = 9999))] /// id: u64, /// response_type: ResponseType, /// } /// /// // Use `Query` extractor for query information (and destructure it within the signature). /// // This handler gets called only if the request's query string contains a `id` and /// // `response_type` fields. /// // The correct request for this handler would be `/index.html?id=19&response_type=Code"`. /// async fn index(QsQuery(info): QsQuery<AuthRequest>) -> String { /// format!("Authorization request for client with id={} and type={:?}!", info.id, info.response_type) /// } /// /// fn main() { /// let app = App::new().service( /// web::resource("/index.html").route(web::get().to(index))); // <- use `Query` extractor /// } /// ``` impl<T> FromRequest for QsQuery<T> where T: de::DeserializeOwned + Validate, { type Error = actix_web::Error; type Future = Ready<Result<Self, Self::Error>>; type Config = QsQueryConfig; /// Builds Query struct from request and provides validation mechanism #[inline] fn from_request( req: &actix_web::web::HttpRequest, _: &mut actix_web::dev::Payload, ) -> Self::Future { let query_config = req.app_data::<QsQueryConfig>(); let error_handler = query_config.map(|c| c.ehandler.clone()).unwrap_or(None); let default_qsconfig = QsConfig::default(); let qsconfig = query_config .map(|c| &c.qs_config) .unwrap_or(&default_qsconfig); qsconfig .deserialize_str::<T>(req.query_string()) .map_err(Error::from) .and_then(|value| { value .validate() .map(move |_| value) .map_err(Error::Validate) }) .map_err(move |e| { log::debug!( "Failed during Query extractor validation. \ Request path: {:?}", req.path() ); if let Some(error_handler) = error_handler { (error_handler)(e, req) } else { e.into() } }) .map(|value| ok(QsQuery(value))) .unwrap_or_else(err) } }