use std::cell::RefCell; use std::fmt; use std::future::Future; use std::pin::Pin; use std::rc::Rc; use std::task::{Context, Poll}; use actix_http::{Error, Extensions, Response}; use actix_service::boxed::{self, BoxedNewService, BoxedService}; use actix_service::{ apply, apply_fn_factory, IntoServiceFactory, Service, ServiceFactory, Transform, }; use futures::future::{ok, Either, LocalBoxFuture, Ready}; use pin_project::pin_project; use crate::data::Data; use crate::dev::{insert_slash, AppService, HttpServiceFactory, ResourceDef}; use crate::extract::FromRequest; use crate::guard::Guard; use crate::handler::Factory; use crate::responder::Responder; use crate::route::{CreateRouteService, Route, RouteService}; use crate::service::{ServiceRequest, ServiceResponse}; type HttpService = BoxedService; type HttpNewService = BoxedNewService<(), ServiceRequest, ServiceResponse, Error, ()>; /// *Resource* is an entry in resources table which corresponds to requested URL. /// /// Resource in turn has at least one route. /// Route consists of an handlers objects and list of guards /// (objects that implement `Guard` trait). /// Resources and routes uses builder-like pattern for configuration. /// During request handling, resource object iterate through all routes /// and check guards for specific route, if request matches all /// guards, route considered matched and route handler get called. /// /// ```rust /// use actix_web::{web, App, HttpResponse}; /// /// fn main() { /// let app = App::new().service( /// web::resource("/") /// .route(web::get().to(|| HttpResponse::Ok()))); /// } /// ``` /// /// If no matching route could be found, *405* response code get returned. /// Default behavior could be overriden with `default_resource()` method. pub struct Resource { endpoint: T, rdef: String, name: Option, routes: Vec, data: Option, guards: Vec>, default: Rc>>>, factory_ref: Rc>>, } impl Resource { pub fn new(path: &str) -> Resource { let fref = Rc::new(RefCell::new(None)); Resource { routes: Vec::new(), rdef: path.to_string(), name: None, endpoint: ResourceEndpoint::new(fref.clone()), factory_ref: fref, guards: Vec::new(), data: None, default: Rc::new(RefCell::new(None)), } } } impl Resource where T: ServiceFactory< Config = (), Request = ServiceRequest, Response = ServiceResponse, Error = Error, InitError = (), >, { /// Set resource name. /// /// Name is used for url generation. pub fn name(mut self, name: &str) -> Self { self.name = Some(name.to_string()); self } /// Add match guard to a resource. /// /// ```rust /// use actix_web::{web, guard, App, HttpResponse}; /// /// async fn index(data: web::Path<(String, String)>) -> &'static str { /// "Welcome!" /// } /// /// fn main() { /// let app = App::new() /// .service( /// web::resource("/app") /// .guard(guard::Header("content-type", "text/plain")) /// .route(web::get().to(index)) /// ) /// .service( /// web::resource("/app") /// .guard(guard::Header("content-type", "text/json")) /// .route(web::get().to(|| HttpResponse::MethodNotAllowed())) /// ); /// } /// ``` pub fn guard(mut self, guard: G) -> Self { self.guards.push(Box::new(guard)); self } pub(crate) fn add_guards(mut self, guards: Vec>) -> Self { self.guards.extend(guards); self } /// Register a new route. /// /// ```rust /// use actix_web::{web, guard, App, HttpResponse}; /// /// fn main() { /// let app = App::new().service( /// web::resource("/").route( /// web::route() /// .guard(guard::Any(guard::Get()).or(guard::Put())) /// .guard(guard::Header("Content-Type", "text/plain")) /// .to(|| HttpResponse::Ok())) /// ); /// } /// ``` /// /// Multiple routes could be added to a resource. Resource object uses /// match guards for route selection. /// /// ```rust /// use actix_web::{web, guard, App, HttpResponse}; /// /// fn main() { /// let app = App::new().service( /// web::resource("/container/") /// .route(web::get().to(get_handler)) /// .route(web::post().to(post_handler)) /// .route(web::delete().to(delete_handler)) /// ); /// } /// # async fn get_handler() -> impl actix_web::Responder { HttpResponse::Ok() } /// # async fn post_handler() -> impl actix_web::Responder { HttpResponse::Ok() } /// # async fn delete_handler() -> impl actix_web::Responder { HttpResponse::Ok() } /// ``` pub fn route(mut self, route: Route) -> Self { self.routes.push(route); self } /// Provide resource specific data. This method allows to add extractor /// configuration or specific state available via `Data` extractor. /// Provided data is available for all routes registered for the current resource. /// Resource data overrides data registered by `App::data()` method. /// /// ```rust /// use actix_web::{web, App, FromRequest}; /// /// /// extract text data from request /// async fn index(body: String) -> String { /// format!("Body {}!", body) /// } /// /// fn main() { /// let app = App::new().service( /// web::resource("/index.html") /// // limit size of the payload /// .data(String::configure(|cfg| { /// cfg.limit(4096) /// })) /// .route( /// web::get() /// // register handler /// .to(index) /// )); /// } /// ``` pub fn data(self, data: U) -> Self { self.register_data(Data::new(data)) } /// Set or override application data. /// /// This method has the same effect as [`Resource::data`](#method.data), /// except that instead of taking a value of some type `T`, it expects a /// value of type `Data`. Use a `Data` extractor to retrieve its /// value. pub fn register_data(mut self, data: Data) -> Self { if self.data.is_none() { self.data = Some(Extensions::new()); } self.data.as_mut().unwrap().insert(data); self } /// Register a new route and add handler. This route matches all requests. /// /// ```rust /// use actix_web::*; /// /// fn index(req: HttpRequest) -> HttpResponse { /// unimplemented!() /// } /// /// App::new().service(web::resource("/").to(index)); /// ``` /// /// This is shortcut for: /// /// ```rust /// # extern crate actix_web; /// # use actix_web::*; /// # fn index(req: HttpRequest) -> HttpResponse { unimplemented!() } /// App::new().service(web::resource("/").route(web::route().to(index))); /// ``` pub fn to(mut self, handler: F) -> Self where F: Factory, I: FromRequest + 'static, R: Future + 'static, U: Responder + 'static, { self.routes.push(Route::new().to(handler)); self } /// Register a resource middleware. /// /// This is similar to `App's` middlewares, but middleware get invoked on resource level. /// Resource level middlewares are not allowed to change response /// type (i.e modify response's body). /// /// **Note**: middlewares get called in opposite order of middlewares registration. pub fn wrap( self, mw: M, ) -> Resource< impl ServiceFactory< Config = (), Request = ServiceRequest, Response = ServiceResponse, Error = Error, InitError = (), >, > where M: Transform< T::Service, Request = ServiceRequest, Response = ServiceResponse, Error = Error, InitError = (), >, { Resource { endpoint: apply(mw, self.endpoint), rdef: self.rdef, name: self.name, guards: self.guards, routes: self.routes, default: self.default, data: self.data, factory_ref: self.factory_ref, } } /// Register a resource middleware function. /// /// This function accepts instance of `ServiceRequest` type and /// mutable reference to the next middleware in chain. /// /// This is similar to `App's` middlewares, but middleware get invoked on resource level. /// Resource level middlewares are not allowed to change response /// type (i.e modify response's body). /// /// ```rust /// use actix_service::Service; /// use actix_web::{web, App}; /// use actix_web::http::{header::CONTENT_TYPE, HeaderValue}; /// /// async fn index() -> &'static str { /// "Welcome!" /// } /// /// fn main() { /// let app = App::new().service( /// web::resource("/index.html") /// .wrap_fn(|req, srv| { /// let fut = srv.call(req); /// async { /// let mut res = fut.await?; /// res.headers_mut().insert( /// CONTENT_TYPE, HeaderValue::from_static("text/plain"), /// ); /// Ok(res) /// } /// }) /// .route(web::get().to(index))); /// } /// ``` pub fn wrap_fn( self, mw: F, ) -> Resource< impl ServiceFactory< Config = (), Request = ServiceRequest, Response = ServiceResponse, Error = Error, InitError = (), >, > where F: FnMut(ServiceRequest, &mut T::Service) -> R + Clone, R: Future>, { Resource { endpoint: apply_fn_factory(self.endpoint, mw), rdef: self.rdef, name: self.name, guards: self.guards, routes: self.routes, default: self.default, data: self.data, factory_ref: self.factory_ref, } } /// Default service to be used if no matching route could be found. /// By default *405* response get returned. Resource does not use /// default handler from `App` or `Scope`. pub fn default_service(mut self, f: F) -> Self where F: IntoServiceFactory, U: ServiceFactory< Config = (), Request = ServiceRequest, Response = ServiceResponse, Error = Error, > + 'static, U::InitError: fmt::Debug, { // create and configure default resource self.default = Rc::new(RefCell::new(Some(Rc::new(boxed::factory( f.into_factory().map_init_err(|e| { log::error!("Can not construct default service: {:?}", e) }), ))))); self } } impl HttpServiceFactory for Resource where T: ServiceFactory< Config = (), Request = ServiceRequest, Response = ServiceResponse, Error = Error, InitError = (), > + 'static, { fn register(mut self, config: &mut AppService) { let guards = if self.guards.is_empty() { None } else { Some(std::mem::replace(&mut self.guards, Vec::new())) }; let mut rdef = if config.is_root() || !self.rdef.is_empty() { ResourceDef::new(&insert_slash(&self.rdef)) } else { ResourceDef::new(&self.rdef) }; if let Some(ref name) = self.name { *rdef.name_mut() = name.clone(); } // custom app data storage if let Some(ref mut ext) = self.data { config.set_service_data(ext); } config.register_service(rdef, guards, self, None) } } impl IntoServiceFactory for Resource where T: ServiceFactory< Config = (), Request = ServiceRequest, Response = ServiceResponse, Error = Error, InitError = (), >, { fn into_factory(self) -> T { *self.factory_ref.borrow_mut() = Some(ResourceFactory { routes: self.routes, data: self.data.map(Rc::new), default: self.default, }); self.endpoint } } pub struct ResourceFactory { routes: Vec, data: Option>, default: Rc>>>, } impl ServiceFactory for ResourceFactory { type Config = (); type Request = ServiceRequest; type Response = ServiceResponse; type Error = Error; type InitError = (); type Service = ResourceService; type Future = CreateResourceService; fn new_service(&self, _: &()) -> Self::Future { let default_fut = if let Some(ref default) = *self.default.borrow() { Some(default.new_service(&())) } else { None }; CreateResourceService { fut: self .routes .iter() .map(|route| CreateRouteServiceItem::Future(route.new_service(&()))) .collect(), data: self.data.clone(), default: None, default_fut, } } } enum CreateRouteServiceItem { Future(CreateRouteService), Service(RouteService), } pub struct CreateResourceService { fut: Vec, data: Option>, default: Option, default_fut: Option>>, } impl Future for CreateResourceService { type Output = Result; fn poll(mut self: Pin<&mut Self>, cx: &mut Context) -> Poll { let mut done = true; if let Some(ref mut fut) = self.default_fut { match Pin::new(fut).poll(cx)? { Poll::Ready(default) => self.default = Some(default), Poll::Pending => done = false, } } // poll http services for item in &mut self.fut { match item { CreateRouteServiceItem::Future(ref mut fut) => match Pin::new(fut) .poll(cx)? { Poll::Ready(route) => *item = CreateRouteServiceItem::Service(route), Poll::Pending => { done = false; } }, CreateRouteServiceItem::Service(_) => continue, }; } if done { let routes = self .fut .drain(..) .map(|item| match item { CreateRouteServiceItem::Service(service) => service, CreateRouteServiceItem::Future(_) => unreachable!(), }) .collect(); Poll::Ready(Ok(ResourceService { routes, data: self.data.clone(), default: self.default.take(), })) } else { Poll::Pending } } } pub struct ResourceService { routes: Vec, data: Option>, default: Option, } impl Service for ResourceService { type Request = ServiceRequest; type Response = ServiceResponse; type Error = Error; type Future = Either< Ready>, LocalBoxFuture<'static, Result>, >; fn poll_ready(&mut self, _: &mut Context) -> Poll> { Poll::Ready(Ok(())) } fn call(&mut self, mut req: ServiceRequest) -> Self::Future { for route in self.routes.iter_mut() { if route.check(&mut req) { if let Some(ref data) = self.data { req.set_data_container(data.clone()); } return Either::Right(route.call(req)); } } if let Some(ref mut default) = self.default { Either::Right(default.call(req)) } else { let req = req.into_parts().0; Either::Left(ok(ServiceResponse::new( req, Response::MethodNotAllowed().finish(), ))) } } } #[doc(hidden)] pub struct ResourceEndpoint { factory: Rc>>, } impl ResourceEndpoint { fn new(factory: Rc>>) -> Self { ResourceEndpoint { factory } } } impl ServiceFactory for ResourceEndpoint { type Config = (); type Request = ServiceRequest; type Response = ServiceResponse; type Error = Error; type InitError = (); type Service = ResourceService; type Future = CreateResourceService; fn new_service(&self, _: &()) -> Self::Future { self.factory.borrow_mut().as_mut().unwrap().new_service(&()) } } #[cfg(test)] mod tests { use std::time::Duration; use actix_service::Service; use futures::future::{ok, Future}; use tokio_timer::delay_for; use crate::http::{header, HeaderValue, Method, StatusCode}; use crate::middleware::DefaultHeaders; use crate::service::{ServiceRequest, ServiceResponse}; use crate::test::{block_on, call_service, init_service, TestRequest}; use crate::{guard, web, App, Error, HttpResponse}; fn md( req: ServiceRequest, srv: &mut S, ) -> impl Future, Error>> where S: Service< Request = ServiceRequest, Response = ServiceResponse, Error = Error, >, { let fut = srv.call(req); async move { let mut res = fut.await?; res.headers_mut() .insert(header::CONTENT_TYPE, HeaderValue::from_static("0001")); Ok(res) } } #[test] fn test_middleware() { block_on(async { let mut srv = init_service( App::new().service( web::resource("/test") .name("test") .wrap(DefaultHeaders::new().header( header::CONTENT_TYPE, HeaderValue::from_static("0001"), )) .route(web::get().to(|| HttpResponse::Ok())), ), ) .await; let req = TestRequest::with_uri("/test").to_request(); let resp = call_service(&mut srv, req).await; assert_eq!(resp.status(), StatusCode::OK); assert_eq!( resp.headers().get(header::CONTENT_TYPE).unwrap(), HeaderValue::from_static("0001") ); }) } #[test] fn test_middleware_fn() { block_on(async { let mut srv = init_service( App::new().service( web::resource("/test") .wrap_fn(|req, srv| { let fut = srv.call(req); async { fut.await.map(|mut res| { res.headers_mut().insert( header::CONTENT_TYPE, HeaderValue::from_static("0001"), ); res }) } }) .route(web::get().to(|| HttpResponse::Ok())), ), ) .await; let req = TestRequest::with_uri("/test").to_request(); let resp = call_service(&mut srv, req).await; assert_eq!(resp.status(), StatusCode::OK); assert_eq!( resp.headers().get(header::CONTENT_TYPE).unwrap(), HeaderValue::from_static("0001") ); }) } #[test] fn test_to() { block_on(async { let mut srv = init_service(App::new().service(web::resource("/test").to(|| { async { delay_for(Duration::from_millis(100)).await; Ok::<_, Error>(HttpResponse::Ok()) } }))) .await; let req = TestRequest::with_uri("/test").to_request(); let resp = call_service(&mut srv, req).await; assert_eq!(resp.status(), StatusCode::OK); }) } #[test] fn test_default_resource() { block_on(async { let mut srv = init_service( App::new() .service( web::resource("/test") .route(web::get().to(|| HttpResponse::Ok())), ) .default_service(|r: ServiceRequest| { ok(r.into_response(HttpResponse::BadRequest())) }), ) .await; let req = TestRequest::with_uri("/test").to_request(); let resp = call_service(&mut srv, req).await; assert_eq!(resp.status(), StatusCode::OK); let req = TestRequest::with_uri("/test") .method(Method::POST) .to_request(); let resp = call_service(&mut srv, req).await; assert_eq!(resp.status(), StatusCode::METHOD_NOT_ALLOWED); let mut srv = init_service( App::new().service( web::resource("/test") .route(web::get().to(|| HttpResponse::Ok())) .default_service(|r: ServiceRequest| { ok(r.into_response(HttpResponse::BadRequest())) }), ), ) .await; let req = TestRequest::with_uri("/test").to_request(); let resp = call_service(&mut srv, req).await; assert_eq!(resp.status(), StatusCode::OK); let req = TestRequest::with_uri("/test") .method(Method::POST) .to_request(); let resp = call_service(&mut srv, req).await; assert_eq!(resp.status(), StatusCode::BAD_REQUEST); }) } #[test] fn test_resource_guards() { block_on(async { let mut srv = init_service( App::new() .service( web::resource("/test/{p}") .guard(guard::Get()) .to(|| HttpResponse::Ok()), ) .service( web::resource("/test/{p}") .guard(guard::Put()) .to(|| HttpResponse::Created()), ) .service( web::resource("/test/{p}") .guard(guard::Delete()) .to(|| HttpResponse::NoContent()), ), ) .await; let req = TestRequest::with_uri("/test/it") .method(Method::GET) .to_request(); let resp = call_service(&mut srv, req).await; assert_eq!(resp.status(), StatusCode::OK); let req = TestRequest::with_uri("/test/it") .method(Method::PUT) .to_request(); let resp = call_service(&mut srv, req).await; assert_eq!(resp.status(), StatusCode::CREATED); let req = TestRequest::with_uri("/test/it") .method(Method::DELETE) .to_request(); let resp = call_service(&mut srv, req).await; assert_eq!(resp.status(), StatusCode::NO_CONTENT); }) } #[test] fn test_data() { block_on(async { let mut srv = init_service( App::new() .data(1.0f64) .data(1usize) .register_data(web::Data::new('-')) .service( web::resource("/test") .data(10usize) .register_data(web::Data::new('*')) .guard(guard::Get()) .to( |data1: web::Data, data2: web::Data, data3: web::Data| { assert_eq!(*data1, 10); assert_eq!(*data2, '*'); assert_eq!(*data3, 1.0); HttpResponse::Ok() }, ), ), ) .await; let req = TestRequest::get().uri("/test").to_request(); let resp = call_service(&mut srv, req).await; assert_eq!(resp.status(), StatusCode::OK); }) } }