1use std::{cell::RefCell, fmt, future::Future, rc::Rc};
2
3use actix_http::Extensions;
4use actix_router::{IntoPatterns, Patterns};
5use actix_service::{
6 apply, apply_fn_factory, boxed, fn_service, IntoServiceFactory, Service, ServiceFactory,
7 ServiceFactoryExt, Transform,
8};
9use futures_core::future::LocalBoxFuture;
10use futures_util::future::join_all;
11
12use crate::{
13 body::MessageBody,
14 data::Data,
15 dev::{ensure_leading_slash, AppService, ResourceDef},
16 guard::{self, Guard},
17 handler::Handler,
18 http::header,
19 route::{Route, RouteService},
20 service::{
21 BoxedHttpService, BoxedHttpServiceFactory, HttpServiceFactory, ServiceRequest,
22 ServiceResponse,
23 },
24 web, Error, FromRequest, HttpResponse, Responder,
25};
26
27pub struct Resource<T = ResourceEndpoint> {
52 endpoint: T,
53 rdef: Patterns,
54 name: Option<String>,
55 routes: Vec<Route>,
56 app_data: Option<Extensions>,
57 guards: Vec<Box<dyn Guard>>,
58 default: BoxedHttpServiceFactory,
59 factory_ref: Rc<RefCell<Option<ResourceFactory>>>,
60}
61
62impl Resource {
63 pub fn new<T: IntoPatterns>(path: T) -> Resource {
65 let factory_ref = Rc::new(RefCell::new(None));
66
67 Resource {
68 routes: Vec::new(),
69 rdef: path.patterns(),
70 name: None,
71 endpoint: ResourceEndpoint::new(Rc::clone(&factory_ref)),
72 factory_ref,
73 guards: Vec::new(),
74 app_data: None,
75 default: boxed::factory(fn_service(|req: ServiceRequest| async {
76 use crate::HttpMessage as _;
77
78 let allowed = req.extensions().get::<guard::RegisteredMethods>().cloned();
79
80 if let Some(methods) = allowed {
81 Ok(req.into_response(
82 HttpResponse::MethodNotAllowed()
83 .insert_header(header::Allow(methods.0))
84 .finish(),
85 ))
86 } else {
87 Ok(req.into_response(HttpResponse::MethodNotAllowed()))
88 }
89 })),
90 }
91 }
92}
93
94impl<T> Resource<T>
95where
96 T: ServiceFactory<ServiceRequest, Config = (), Error = Error, InitError = ()>,
97{
98 pub fn name(mut self, name: &str) -> Self {
102 self.name = Some(name.to_string());
103 self
104 }
105
106 pub fn guard<G: Guard + 'static>(mut self, guard: G) -> Self {
128 self.guards.push(Box::new(guard));
129 self
130 }
131
132 pub(crate) fn add_guards(mut self, guards: Vec<Box<dyn Guard>>) -> Self {
133 self.guards.extend(guards);
134 self
135 }
136
137 pub fn route(mut self, route: Route) -> Self {
169 self.routes.push(route);
170 self
171 }
172
173 #[doc(alias = "manage")]
206 pub fn app_data<U: 'static>(mut self, data: U) -> Self {
207 self.app_data
208 .get_or_insert_with(Extensions::new)
209 .insert(data);
210
211 self
212 }
213
214 #[deprecated(since = "4.0.0", note = "Use `.app_data(Data::new(val))` instead.")]
218 pub fn data<U: 'static>(self, data: U) -> Self {
219 self.app_data(Data::new(data))
220 }
221
222 pub fn to<F, Args>(mut self, handler: F) -> Self
242 where
243 F: Handler<Args>,
244 Args: FromRequest + 'static,
245 F::Output: Responder + 'static,
246 {
247 self.routes.push(Route::new().to(handler));
248 self
249 }
250
251 #[doc(alias = "middleware")]
258 #[doc(alias = "use")] pub fn wrap<M, B>(
260 self,
261 mw: M,
262 ) -> Resource<
263 impl ServiceFactory<
264 ServiceRequest,
265 Config = (),
266 Response = ServiceResponse<B>,
267 Error = Error,
268 InitError = (),
269 >,
270 >
271 where
272 M: Transform<
273 T::Service,
274 ServiceRequest,
275 Response = ServiceResponse<B>,
276 Error = Error,
277 InitError = (),
278 > + 'static,
279 B: MessageBody,
280 {
281 Resource {
282 endpoint: apply(mw, self.endpoint),
283 rdef: self.rdef,
284 name: self.name,
285 guards: self.guards,
286 routes: self.routes,
287 default: self.default,
288 app_data: self.app_data,
289 factory_ref: self.factory_ref,
290 }
291 }
292
293 #[doc(alias = "middleware")]
301 #[doc(alias = "use")] pub fn wrap_fn<F, R, B>(
303 self,
304 mw: F,
305 ) -> Resource<
306 impl ServiceFactory<
307 ServiceRequest,
308 Config = (),
309 Response = ServiceResponse<B>,
310 Error = Error,
311 InitError = (),
312 >,
313 >
314 where
315 F: Fn(ServiceRequest, &T::Service) -> R + Clone + 'static,
316 R: Future<Output = Result<ServiceResponse<B>, Error>>,
317 B: MessageBody,
318 {
319 Resource {
320 endpoint: apply_fn_factory(self.endpoint, mw),
321 rdef: self.rdef,
322 name: self.name,
323 guards: self.guards,
324 routes: self.routes,
325 default: self.default,
326 app_data: self.app_data,
327 factory_ref: self.factory_ref,
328 }
329 }
330
331 pub fn default_service<F, U>(mut self, f: F) -> Self
354 where
355 F: IntoServiceFactory<U, ServiceRequest>,
356 U: ServiceFactory<ServiceRequest, Config = (), Response = ServiceResponse, Error = Error>
357 + 'static,
358 U::InitError: fmt::Debug,
359 {
360 self.default = boxed::factory(f.into_factory().map_init_err(|err| {
362 log::error!("Can not construct default service: {err:?}");
363 }));
364
365 self
366 }
367}
368
369macro_rules! route_shortcut {
370 ($method_fn:ident, $method_upper:literal) => {
371 #[doc = concat!(" Adds a ", $method_upper, " route.")]
372 #[doc = concat!(" .", stringify!($method_fn), "(|| async { \"Hello World!\" })")]
381 pub fn $method_fn<F, Args>(self, handler: F) -> Self
384 where
385 F: Handler<Args>,
386 Args: FromRequest + 'static,
387 F::Output: Responder + 'static,
388 {
389 self.route(web::$method_fn().to(handler))
390 }
391 };
392}
393
394impl<T> Resource<T>
396where
397 T: ServiceFactory<ServiceRequest, Config = (), Error = Error, InitError = ()>,
398{
399 route_shortcut!(get, "GET");
400 route_shortcut!(post, "POST");
401 route_shortcut!(put, "PUT");
402 route_shortcut!(patch, "PATCH");
403 route_shortcut!(delete, "DELETE");
404 route_shortcut!(head, "HEAD");
405 route_shortcut!(trace, "TRACE");
406}
407
408impl<T, B> HttpServiceFactory for Resource<T>
409where
410 T: ServiceFactory<
411 ServiceRequest,
412 Config = (),
413 Response = ServiceResponse<B>,
414 Error = Error,
415 InitError = (),
416 > + 'static,
417 B: MessageBody + 'static,
418{
419 fn register(mut self, config: &mut AppService) {
420 let routes = std::mem::take(&mut self.routes);
421
422 let guards = if self.guards.is_empty() {
423 None
424 } else {
425 Some(std::mem::take(&mut self.guards))
426 };
427
428 let mut rdef = if config.is_root() || !self.rdef.is_empty() {
429 ResourceDef::new(ensure_leading_slash(self.rdef.clone()))
430 } else {
431 ResourceDef::new(self.rdef.clone())
432 };
433 #[cfg(feature = "experimental-introspection")]
434 {
435 use crate::http::Method;
436
437 let full_paths = crate::introspection::expand_patterns(&config.current_prefix, &rdef);
438 let patterns = rdef
439 .pattern_iter()
440 .map(|pattern| pattern.to_string())
441 .collect::<Vec<_>>();
442 let guards_routes = routes.iter().map(|r| r.guards()).collect::<Vec<_>>();
443 let scope_id = config.scope_id_stack.last().copied();
444 let resource_guards: &[Box<dyn Guard>] = guards.as_deref().unwrap_or(&[]);
445 let resource_name = self.name.clone();
446
447 for route_guards in guards_routes {
448 let mut guard_names = Vec::new();
450 let mut methods = Vec::new();
451
452 for guard in resource_guards.iter().chain(route_guards.iter()) {
453 guard_names.push(guard.name());
454 methods.extend(
455 guard
456 .details()
457 .unwrap_or_default()
458 .into_iter()
459 .flat_map(|d| {
460 if let crate::guard::GuardDetail::HttpMethods(v) = d {
461 v.into_iter()
462 .filter_map(|s| s.parse::<Method>().ok())
463 .collect::<Vec<_>>()
464 } else {
465 Vec::new()
466 }
467 }),
468 );
469 }
470
471 let guard_details = crate::introspection::guard_reports_from_iter(
472 resource_guards.iter().chain(route_guards.iter()),
473 );
474
475 for full_path in &full_paths {
476 let info = crate::introspection::RouteInfo::new(
477 full_path.clone(),
478 methods.clone(),
479 guard_names.clone(),
480 guard_details.clone(),
481 patterns.clone(),
482 resource_name.clone(),
483 );
484 config
485 .introspector
486 .borrow_mut()
487 .register_route(info, scope_id);
488 }
489 }
490 }
491
492 if let Some(ref name) = self.name {
493 rdef.set_name(name);
494 }
495
496 *self.factory_ref.borrow_mut() = Some(ResourceFactory {
497 routes,
498 default: self.default,
499 });
500
501 let resource_data = self.app_data.map(Rc::new);
502
503 let endpoint = apply_fn_factory(self.endpoint, move |mut req: ServiceRequest, srv| {
505 if let Some(ref data) = resource_data {
506 req.add_data_container(Rc::clone(data));
507 }
508
509 let fut = srv.call(req);
510
511 async { Ok(fut.await?.map_into_boxed_body()) }
512 });
513
514 config.register_service(rdef, guards, endpoint, None)
515 }
516}
517
518pub struct ResourceFactory {
519 routes: Vec<Route>,
520 default: BoxedHttpServiceFactory,
521}
522
523impl ServiceFactory<ServiceRequest> for ResourceFactory {
524 type Response = ServiceResponse;
525 type Error = Error;
526 type Config = ();
527 type Service = ResourceService;
528 type InitError = ();
529 type Future = LocalBoxFuture<'static, Result<Self::Service, Self::InitError>>;
530
531 fn new_service(&self, _: ()) -> Self::Future {
532 let default_fut = self.default.new_service(());
534
535 let factory_fut = join_all(self.routes.iter().map(|route| route.new_service(())));
537
538 Box::pin(async move {
539 let default = default_fut.await?;
540 let routes = factory_fut
541 .await
542 .into_iter()
543 .collect::<Result<Vec<_>, _>>()?;
544
545 Ok(ResourceService { routes, default })
546 })
547 }
548}
549
550pub struct ResourceService {
551 routes: Vec<RouteService>,
552 default: BoxedHttpService,
553}
554
555impl Service<ServiceRequest> for ResourceService {
556 type Response = ServiceResponse;
557 type Error = Error;
558 type Future = LocalBoxFuture<'static, Result<Self::Response, Self::Error>>;
559
560 actix_service::always_ready!();
561
562 fn call(&self, mut req: ServiceRequest) -> Self::Future {
563 for route in &self.routes {
564 if route.check(&mut req) {
565 return route.call(req);
566 }
567 }
568
569 self.default.call(req)
570 }
571}
572
573#[doc(hidden)]
574pub struct ResourceEndpoint {
575 factory: Rc<RefCell<Option<ResourceFactory>>>,
576}
577
578impl ResourceEndpoint {
579 fn new(factory: Rc<RefCell<Option<ResourceFactory>>>) -> Self {
580 ResourceEndpoint { factory }
581 }
582}
583
584impl ServiceFactory<ServiceRequest> for ResourceEndpoint {
585 type Response = ServiceResponse;
586 type Error = Error;
587 type Config = ();
588 type Service = ResourceService;
589 type InitError = ();
590 type Future = LocalBoxFuture<'static, Result<Self::Service, Self::InitError>>;
591
592 fn new_service(&self, _: ()) -> Self::Future {
593 self.factory.borrow().as_ref().unwrap().new_service(())
594 }
595}
596
597#[cfg(test)]
598mod tests {
599 use std::{future::ready, time::Duration};
600
601 use tokio::time::sleep;
602
603 use super::*;
604 use crate::{
605 http::{header::HeaderValue, Method, StatusCode},
606 middleware::DefaultHeaders,
607 test::{call_service, init_service, TestRequest},
608 App, HttpMessage,
609 };
610
611 #[test]
612 fn can_be_returned_from_fn() {
613 fn my_resource_1() -> Resource {
614 web::resource("/test1").route(web::get().to(|| async { "hello" }))
615 }
616
617 fn my_resource_2() -> Resource<
618 impl ServiceFactory<
619 ServiceRequest,
620 Config = (),
621 Response = ServiceResponse<impl MessageBody>,
622 Error = Error,
623 InitError = (),
624 >,
625 > {
626 web::resource("/test2")
627 .wrap_fn(|req, srv| {
628 let fut = srv.call(req);
629 async { Ok(fut.await?.map_into_right_body::<()>()) }
630 })
631 .route(web::get().to(|| async { "hello" }))
632 }
633
634 fn my_resource_3() -> impl HttpServiceFactory {
635 web::resource("/test3").route(web::get().to(|| async { "hello" }))
636 }
637
638 App::new()
639 .service(my_resource_1())
640 .service(my_resource_2())
641 .service(my_resource_3());
642 }
643
644 #[actix_rt::test]
645 async fn test_middleware() {
646 let srv = init_service(
647 App::new().service(
648 web::resource("/test")
649 .name("test")
650 .wrap(
651 DefaultHeaders::new()
652 .add((header::CONTENT_TYPE, HeaderValue::from_static("0001"))),
653 )
654 .route(web::get().to(HttpResponse::Ok)),
655 ),
656 )
657 .await;
658 let req = TestRequest::with_uri("/test").to_request();
659 let resp = call_service(&srv, req).await;
660 assert_eq!(resp.status(), StatusCode::OK);
661 assert_eq!(
662 resp.headers().get(header::CONTENT_TYPE).unwrap(),
663 HeaderValue::from_static("0001")
664 );
665 }
666
667 #[actix_rt::test]
668 async fn test_middleware_fn() {
669 let srv = init_service(
670 App::new().service(
671 web::resource("/test")
672 .wrap_fn(|req, srv| {
673 let fut = srv.call(req);
674 async {
675 fut.await.map(|mut res| {
676 res.headers_mut()
677 .insert(header::CONTENT_TYPE, HeaderValue::from_static("0001"));
678 res
679 })
680 }
681 })
682 .route(web::get().to(HttpResponse::Ok)),
683 ),
684 )
685 .await;
686 let req = TestRequest::with_uri("/test").to_request();
687 let resp = call_service(&srv, req).await;
688 assert_eq!(resp.status(), StatusCode::OK);
689 assert_eq!(
690 resp.headers().get(header::CONTENT_TYPE).unwrap(),
691 HeaderValue::from_static("0001")
692 );
693 }
694
695 #[actix_rt::test]
696 async fn test_to() {
697 let srv = init_service(App::new().service(web::resource("/test").to(|| async {
698 sleep(Duration::from_millis(100)).await;
699 Ok::<_, Error>(HttpResponse::Ok())
700 })))
701 .await;
702 let req = TestRequest::with_uri("/test").to_request();
703 let resp = call_service(&srv, req).await;
704 assert_eq!(resp.status(), StatusCode::OK);
705 }
706
707 #[actix_rt::test]
708 async fn test_pattern() {
709 let srv = init_service(App::new().service(
710 web::resource(["/test", "/test2"]).to(|| async { Ok::<_, Error>(HttpResponse::Ok()) }),
711 ))
712 .await;
713 let req = TestRequest::with_uri("/test").to_request();
714 let resp = call_service(&srv, req).await;
715 assert_eq!(resp.status(), StatusCode::OK);
716 let req = TestRequest::with_uri("/test2").to_request();
717 let resp = call_service(&srv, req).await;
718 assert_eq!(resp.status(), StatusCode::OK);
719 }
720
721 #[actix_rt::test]
722 async fn test_default_resource() {
723 let srv = init_service(
724 App::new()
725 .service(
726 web::resource("/test")
727 .route(web::get().to(HttpResponse::Ok))
728 .route(web::delete().to(HttpResponse::Ok)),
729 )
730 .default_service(|r: ServiceRequest| {
731 ready(Ok(r.into_response(HttpResponse::BadRequest())))
732 }),
733 )
734 .await;
735 let req = TestRequest::with_uri("/test").to_request();
736 let resp = call_service(&srv, req).await;
737 assert_eq!(resp.status(), StatusCode::OK);
738
739 let req = TestRequest::with_uri("/test")
740 .method(Method::POST)
741 .to_request();
742 let resp = call_service(&srv, req).await;
743 assert_eq!(resp.status(), StatusCode::METHOD_NOT_ALLOWED);
744 assert_eq!(
745 resp.headers().get(header::ALLOW).unwrap().as_bytes(),
746 b"GET, DELETE"
747 );
748
749 let srv = init_service(
750 App::new().service(
751 web::resource("/test")
752 .route(web::get().to(HttpResponse::Ok))
753 .default_service(|r: ServiceRequest| {
754 ready(Ok(r.into_response(HttpResponse::BadRequest())))
755 }),
756 ),
757 )
758 .await;
759
760 let req = TestRequest::with_uri("/test").to_request();
761 let resp = call_service(&srv, req).await;
762 assert_eq!(resp.status(), StatusCode::OK);
763
764 let req = TestRequest::with_uri("/test")
765 .method(Method::POST)
766 .to_request();
767 let resp = call_service(&srv, req).await;
768 assert_eq!(resp.status(), StatusCode::BAD_REQUEST);
769 }
770
771 #[actix_rt::test]
772 async fn test_resource_guards() {
773 let srv = init_service(
774 App::new()
775 .service(
776 web::resource("/test/{p}")
777 .guard(guard::Get())
778 .to(HttpResponse::Ok),
779 )
780 .service(
781 web::resource("/test/{p}")
782 .guard(guard::Put())
783 .to(HttpResponse::Created),
784 )
785 .service(
786 web::resource("/test/{p}")
787 .guard(guard::Delete())
788 .to(HttpResponse::NoContent),
789 ),
790 )
791 .await;
792
793 let req = TestRequest::with_uri("/test/it")
794 .method(Method::GET)
795 .to_request();
796 let resp = call_service(&srv, req).await;
797 assert_eq!(resp.status(), StatusCode::OK);
798
799 let req = TestRequest::with_uri("/test/it")
800 .method(Method::PUT)
801 .to_request();
802 let resp = call_service(&srv, req).await;
803 assert_eq!(resp.status(), StatusCode::CREATED);
804
805 let req = TestRequest::with_uri("/test/it")
806 .method(Method::DELETE)
807 .to_request();
808 let resp = call_service(&srv, req).await;
809 assert_eq!(resp.status(), StatusCode::NO_CONTENT);
810 }
811
812 #[allow(deprecated)]
814 #[actix_rt::test]
815 async fn test_data() {
816 let srv = init_service(
817 App::new()
818 .data(1.0f64)
819 .data(1usize)
820 .app_data(web::Data::new('-'))
821 .service(
822 web::resource("/test")
823 .data(10usize)
824 .app_data(web::Data::new('*'))
825 .guard(guard::Get())
826 .to(
827 |data1: web::Data<usize>,
828 data2: web::Data<char>,
829 data3: web::Data<f64>| {
830 assert_eq!(**data1, 10);
831 assert_eq!(**data2, '*');
832 let error = f64::EPSILON;
833 assert!((**data3 - 1.0).abs() < error);
834 HttpResponse::Ok()
835 },
836 ),
837 ),
838 )
839 .await;
840
841 let req = TestRequest::get().uri("/test").to_request();
842 let resp = call_service(&srv, req).await;
843 assert_eq!(resp.status(), StatusCode::OK);
844 }
845
846 #[allow(deprecated)]
848 #[actix_rt::test]
849 async fn test_data_default_service() {
850 let srv =
851 init_service(
852 App::new().data(1usize).service(
853 web::resource("/test")
854 .data(10usize)
855 .default_service(web::to(|data: web::Data<usize>| {
856 assert_eq!(**data, 10);
857 HttpResponse::Ok()
858 })),
859 ),
860 )
861 .await;
862
863 let req = TestRequest::get().uri("/test").to_request();
864 let resp = call_service(&srv, req).await;
865 assert_eq!(resp.status(), StatusCode::OK);
866 }
867
868 #[actix_rt::test]
869 async fn test_middleware_app_data() {
870 let srv = init_service(
871 App::new().service(
872 web::resource("test")
873 .app_data(1usize)
874 .wrap_fn(|req, srv| {
875 assert_eq!(req.app_data::<usize>(), Some(&1usize));
876 req.extensions_mut().insert(1usize);
877 srv.call(req)
878 })
879 .route(web::get().to(HttpResponse::Ok))
880 .default_service(|req: ServiceRequest| async move {
881 let (req, _) = req.into_parts();
882
883 assert_eq!(req.extensions().get::<usize>(), Some(&1));
884
885 Ok(ServiceResponse::new(
886 req,
887 HttpResponse::BadRequest().finish(),
888 ))
889 }),
890 ),
891 )
892 .await;
893
894 let req = TestRequest::get().uri("/test").to_request();
895 let resp = call_service(&srv, req).await;
896 assert_eq!(resp.status(), StatusCode::OK);
897
898 let req = TestRequest::post().uri("/test").to_request();
899 let resp = call_service(&srv, req).await;
900 assert_eq!(resp.status(), StatusCode::BAD_REQUEST);
901 }
902
903 #[actix_rt::test]
904 async fn test_middleware_body_type() {
905 let srv = init_service(
906 App::new().service(
907 web::resource("/test")
908 .wrap_fn(|req, srv| {
909 let fut = srv.call(req);
910 async { Ok(fut.await?.map_into_right_body::<()>()) }
911 })
912 .route(web::get().to(|| async { "hello" })),
913 ),
914 )
915 .await;
916
917 use actix_http::body::MessageBody as _;
919 let req = TestRequest::with_uri("/test").to_request();
920 let resp = call_service(&srv, req).await;
921 let body = resp.into_body();
922 assert_eq!(body.try_into_bytes().unwrap(), b"hello".as_ref());
923 }
924}