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
//! Path extractor. use std::fmt; use std::ops::Deref; use std::sync::Arc; use actix_router::PathDeserializer; use actix_web::dev::Payload; use actix_web::{FromRequest, HttpRequest}; use serde::de::{Deserialize, DeserializeOwned}; use validator::Validate; use crate::error::{DeserializeErrors, Error}; /// Extract typed information from the request's path. /// /// ## Example /// /// It is possible to extract path information to a specific type that /// implements `Deserialize` trait from *serde* and `Validate` trait from *validator*. /// /// ```rust /// use actix_web::{web, App, Error}; /// use serde_derive::Deserialize; /// use actix_web_validator::ValidatedPath; /// use validator::Validate; /// use validator_derive::Validate; /// /// #[derive(Deserialize, Validate)] /// struct Info { /// #[validate(length(min = 1))] /// username: String, /// } /// /// /// extract `Info` from a path using serde /// fn index(info: ValidatedPath<Info>) -> Result<String, Error> { /// Ok(format!("Welcome {}!", info.username)) /// } /// /// fn main() { /// let app = App::new().service( /// web::resource("/{username}/index.html") // <- define path parameters /// .route(web::get().to(index)) // <- use handler with Path` extractor /// ); /// } /// ``` #[derive(PartialEq, Eq, PartialOrd, Ord)] pub struct ValidatedPath<T> { inner: T, } impl<T> ValidatedPath<T> { /// Deconstruct to an inner value pub fn into_inner(self) -> T { self.inner } } impl<T> AsRef<T> for ValidatedPath<T> { fn as_ref(&self) -> &T { &self.inner } } impl<T> Deref for ValidatedPath<T> { type Target = T; fn deref(&self) -> &T { &self.inner } } impl<T: fmt::Debug> fmt::Debug for ValidatedPath<T> { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { self.inner.fmt(f) } } impl<T: fmt::Display> fmt::Display for ValidatedPath<T> { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { self.inner.fmt(f) } } /// Extract typed information from the request's path. /// /// ## Example /// /// It is possible to extract path information to a specific type that /// implements `Deserialize` trait from *serde* and `Validate` trait from *validator*. /// /// ```rust /// use actix_web::{web, App, Error}; /// use serde_derive::Deserialize; /// use actix_web_validator::ValidatedPath; /// use validator::Validate; /// use validator_derive::Validate; /// /// #[derive(Deserialize, Validate)] /// struct Info { /// #[validate(length(min = 1))] /// username: String, /// } /// /// /// extract `Info` from a path using serde /// fn index(info: ValidatedPath<Info>) -> Result<String, Error> { /// Ok(format!("Welcome {}!", info.username)) /// } /// /// fn main() { /// let app = App::new().service( /// web::resource("/{username}/index.html") // <- define path parameters /// .route(web::get().to(index)) // <- use handler with Path` extractor /// ); /// } /// ``` impl<T> FromRequest for ValidatedPath<T> where T: DeserializeOwned + Validate, { type Error = actix_web::Error; type Future = Result<Self, actix_web::Error>; type Config = PathConfig; #[inline] fn from_request(req: &HttpRequest, _: &mut Payload) -> Self::Future { let error_handler = req .app_data::<Self::Config>() .map(|c| c.ehandler.clone()) .unwrap_or(None); Deserialize::deserialize(PathDeserializer::new(req.match_info())) .map_err(|error| Error::Deserialize(DeserializeErrors::DeserializePath(error))) .and_then(|value: T| { value .validate() .map(move |_| value) .map_err(Error::Validate) }) .map(|inner| ValidatedPath { inner }) .map_err(move |e| { log::debug!( "Failed during Path extractor deserialization. \ Request path: {:?}", req.path() ); if let Some(error_handler) = error_handler { (error_handler)(e, req) } else { actix_web::error::ErrorNotFound(e) } }) } } /// Path extractor configuration /// /// ```rust /// use actix_web_validator::{PathConfig, ValidatedPath}; /// use actix_web::{error, web, App, FromRequest, HttpResponse}; /// use validator::Validate; /// use validator_derive::Validate; /// use serde_derive::Deserialize; /// /// #[derive(Deserialize, Debug)] /// enum Folder { /// #[serde(rename = "inbox")] /// Inbox, /// #[serde(rename = "outbox")] /// Outbox, /// } /// /// #[derive(Deserialize, Debug, Validate)] /// struct Filter { /// folder: Folder, /// #[validate(range(min = 1024))] /// id: u64, /// } /// /// // deserialize `Info` from request's path /// fn index(folder: ValidatedPath<Filter>) -> String { /// format!("Selected folder: {:?}!", folder) /// } /// /// fn main() { /// let app = App::new().service( /// web::resource("/messages/{folder}") /// .data(PathConfig::default().error_handler(|err, req| { /// error::InternalError::from_response( /// err, /// HttpResponse::Conflict().finish(), /// ) /// .into() /// })) /// .route(web::post().to(index)), /// ); /// } /// ``` #[derive(Clone)] pub struct PathConfig { ehandler: Option<Arc<dyn Fn(Error, &HttpRequest) -> actix_web::Error + Send + Sync>>, } impl PathConfig { /// 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 } } impl Default for PathConfig { fn default() -> Self { Self { ehandler: None } } }