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 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625
use std::cell::RefCell; use std::fmt; use std::marker::PhantomData; use std::rc::Rc; use actix_http::body::{Body, MessageBody}; use actix_service::boxed::{self, BoxedNewService}; use actix_service::{ apply_transform, IntoNewService, IntoTransform, NewService, Transform, }; use futures::IntoFuture; use crate::app_service::{AppEntry, AppInit, AppRoutingFactory}; use crate::config::{AppConfig, AppConfigInner, ServiceConfig}; use crate::data::{Data, DataFactory}; use crate::dev::ResourceDef; use crate::error::Error; use crate::resource::Resource; use crate::route::Route; use crate::service::{ HttpServiceFactory, ServiceFactory, ServiceFactoryWrapper, ServiceRequest, ServiceResponse, }; type HttpNewService = BoxedNewService<(), ServiceRequest, ServiceResponse, Error, ()>; /// Application builder - structure that follows the builder pattern /// for building application instances. pub struct App<T, B> { endpoint: T, services: Vec<Box<ServiceFactory>>, default: Option<Rc<HttpNewService>>, factory_ref: Rc<RefCell<Option<AppRoutingFactory>>>, data: Vec<Box<DataFactory>>, config: AppConfigInner, external: Vec<ResourceDef>, _t: PhantomData<(B)>, } impl App<AppEntry, Body> { /// Create application builder. Application can be configured with a builder-like pattern. pub fn new() -> Self { let fref = Rc::new(RefCell::new(None)); App { endpoint: AppEntry::new(fref.clone()), data: Vec::new(), services: Vec::new(), default: None, factory_ref: fref, config: AppConfigInner::default(), external: Vec::new(), _t: PhantomData, } } } impl<T, B> App<T, B> where B: MessageBody, T: NewService< Config = (), Request = ServiceRequest, Response = ServiceResponse<B>, Error = Error, InitError = (), >, { /// Set application data. Application data could be accessed /// by using `Data<T>` extractor where `T` is data type. /// /// **Note**: http server accepts an application factory rather than /// an application instance. Http server constructs an application /// instance for each thread, thus application data must be constructed /// multiple times. If you want to share data between different /// threads, a shared object should be used, e.g. `Arc`. Application /// data does not need to be `Send` or `Sync`. /// /// ```rust /// use std::cell::Cell; /// use actix_web::{web, App}; /// /// struct MyData { /// counter: Cell<usize>, /// } /// /// fn index(data: web::Data<MyData>) { /// data.counter.set(data.counter.get() + 1); /// } /// /// fn main() { /// let app = App::new() /// .data(MyData{ counter: Cell::new(0) }) /// .service( /// web::resource("/index.html").route( /// web::get().to(index))); /// } /// ``` pub fn data<U: 'static>(mut self, data: U) -> Self { self.data.push(Box::new(Data::new(data))); self } /// Run external configuration as part of the application building /// process /// /// This function is useful for moving parts of configuration to a /// different module or even library. For example, /// some of the resource's configuration could be moved to different module. /// /// ```rust /// # extern crate actix_web; /// use actix_web::{web, middleware, App, HttpResponse}; /// /// // this function could be located in different module /// fn config(cfg: &mut web::ServiceConfig) { /// cfg.service(web::resource("/test") /// .route(web::get().to(|| HttpResponse::Ok())) /// .route(web::head().to(|| HttpResponse::MethodNotAllowed())) /// ); /// } /// /// fn main() { /// let app = App::new() /// .wrap(middleware::Logger::default()) /// .configure(config) // <- register resources /// .route("/index.html", web::get().to(|| HttpResponse::Ok())); /// } /// ``` pub fn configure<F>(mut self, f: F) -> Self where F: FnOnce(&mut ServiceConfig), { let mut cfg = ServiceConfig::new(); f(&mut cfg); self.data.extend(cfg.data); self.services.extend(cfg.services); self.external.extend(cfg.external); self } /// Configure route for a specific path. /// /// This is a simplified version of the `App::service()` method. /// This method can be used multiple times with same path, in that case /// multiple resources with one route would be registered for same resource path. /// /// ```rust /// use actix_web::{web, App, HttpResponse}; /// /// fn index(data: web::Path<(String, String)>) -> &'static str { /// "Welcome!" /// } /// /// fn main() { /// let app = App::new() /// .route("/test1", web::get().to(index)) /// .route("/test2", web::post().to(|| HttpResponse::MethodNotAllowed())); /// } /// ``` pub fn route(self, path: &str, mut route: Route) -> Self { self.service( Resource::new(path) .add_guards(route.take_guards()) .route(route), ) } /// Register http service. /// /// Http service is any type that implements `HttpServiceFactory` trait. /// /// Actix web provides several services implementations: /// /// * *Resource* is an entry in resource table which corresponds to requested URL. /// * *Scope* is a set of resources with common root path. /// * "StaticFiles" is a service for static files support pub fn service<F>(mut self, factory: F) -> Self where F: HttpServiceFactory + 'static, { self.services .push(Box::new(ServiceFactoryWrapper::new(factory))); self } /// Set server host name. /// /// Host name is used by application router as a hostname for url /// generation. Check [ConnectionInfo](./dev/struct.ConnectionInfo. /// html#method.host) documentation for more information. /// /// By default host name is set to a "localhost" value. pub fn hostname(mut self, val: &str) -> Self { self.config.host = val.to_owned(); self } /// Default service to be used if no matching resource could be found. /// /// It is possible to use services like `Resource`, `Route`. /// /// ```rust /// use actix_web::{web, App, HttpResponse}; /// /// fn index() -> &'static str { /// "Welcome!" /// } /// /// fn main() { /// let app = App::new() /// .service( /// web::resource("/index.html").route(web::get().to(index))) /// .default_service( /// web::route().to(|| HttpResponse::NotFound())); /// } /// ``` /// /// It is also possible to use static files as default service. /// /// ```rust /// use actix_files::Files; /// use actix_web::{web, App, HttpResponse}; /// /// fn main() { /// let app = App::new() /// .service( /// web::resource("/index.html").to(|| HttpResponse::Ok())) /// .default_service( /// Files::new("", "./static") /// ); /// } /// ``` pub fn default_service<F, U>(mut self, f: F) -> Self where F: IntoNewService<U>, U: NewService< Config = (), Request = ServiceRequest, Response = ServiceResponse, Error = Error, > + 'static, U::InitError: fmt::Debug, { // create and configure default resource self.default = Some(Rc::new(boxed::new_service( f.into_new_service().map_init_err(|e| { log::error!("Can not construct default service: {:?}", e) }), ))); self } /// Register an external resource. /// /// External resources are useful for URL generation purposes only /// and are never considered for matching at request time. Calls to /// `HttpRequest::url_for()` will work as expected. /// /// ```rust /// use actix_web::{web, App, HttpRequest, HttpResponse, Result}; /// /// fn index(req: HttpRequest) -> Result<HttpResponse> { /// let url = req.url_for("youtube", &["asdlkjqme"])?; /// assert_eq!(url.as_str(), "https://youtube.com/watch/asdlkjqme"); /// Ok(HttpResponse::Ok().into()) /// } /// /// fn main() { /// let app = App::new() /// .service(web::resource("/index.html").route( /// web::get().to(index))) /// .external_resource("youtube", "https://youtube.com/watch/{video_id}"); /// } /// ``` pub fn external_resource<N, U>(mut self, name: N, url: U) -> Self where N: AsRef<str>, U: AsRef<str>, { let mut rdef = ResourceDef::new(url.as_ref()); *rdef.name_mut() = name.as_ref().to_string(); self.external.push(rdef); self } /// Registers middleware, in the form of a middleware component (type), /// that runs during inbound and/or outbound processing in the request /// lifecycle (request -> response), modifying request/response as /// necessary, across all requests managed by the *Application*. /// /// Use middleware when you need to read or modify *every* request or /// response in some way. /// /// Notice that the keyword for registering middleware is `wrap`. As you /// register middleware using `wrap` in the App builder, imagine wrapping /// layers around an inner App. The first middleware layer exposed to a /// Request is the outermost layer-- the *last* registered in /// the builder chain. Consequently, the *first* middleware registered /// in the builder chain is the *last* to execute during request processing. /// /// ```rust /// use actix_service::Service; /// # use futures::Future; /// use actix_web::{middleware, web, App}; /// use actix_web::http::{header::CONTENT_TYPE, HeaderValue}; /// /// fn index() -> &'static str { /// "Welcome!" /// } /// /// fn main() { /// let app = App::new() /// .wrap(middleware::Logger::default()) /// .route("/index.html", web::get().to(index)); /// } /// ``` pub fn wrap<M, B1, F>( self, mw: F, ) -> App< impl NewService< Config = (), Request = ServiceRequest, Response = ServiceResponse<B1>, Error = Error, InitError = (), >, B1, > where M: Transform< T::Service, Request = ServiceRequest, Response = ServiceResponse<B1>, Error = Error, InitError = (), >, B1: MessageBody, F: IntoTransform<M, T::Service>, { let endpoint = apply_transform(mw, self.endpoint); App { endpoint, data: self.data, services: self.services, default: self.default, factory_ref: self.factory_ref, config: self.config, external: self.external, _t: PhantomData, } } /// Registers middleware, in the form of a closure, that runs during inbound /// and/or outbound processing in the request lifecycle (request -> response), /// modifying request/response as necessary, across all requests managed by /// the *Application*. /// /// Use middleware when you need to read or modify *every* request or response in some way. /// /// ```rust /// use actix_service::Service; /// # use futures::Future; /// use actix_web::{web, App}; /// use actix_web::http::{header::CONTENT_TYPE, HeaderValue}; /// /// fn index() -> &'static str { /// "Welcome!" /// } /// /// fn main() { /// let app = App::new() /// .wrap_fn(|req, srv| /// srv.call(req).map(|mut res| { /// res.headers_mut().insert( /// CONTENT_TYPE, HeaderValue::from_static("text/plain"), /// ); /// res /// })) /// .route("/index.html", web::get().to(index)); /// } /// ``` pub fn wrap_fn<B1, F, R>( self, mw: F, ) -> App< impl NewService< Config = (), Request = ServiceRequest, Response = ServiceResponse<B1>, Error = Error, InitError = (), >, B1, > where B1: MessageBody, F: FnMut(ServiceRequest, &mut T::Service) -> R + Clone, R: IntoFuture<Item = ServiceResponse<B1>, Error = Error>, { self.wrap(mw) } } impl<T, B> IntoNewService<AppInit<T, B>> for App<T, B> where B: MessageBody, T: NewService< Config = (), Request = ServiceRequest, Response = ServiceResponse<B>, Error = Error, InitError = (), >, { fn into_new_service(self) -> AppInit<T, B> { AppInit { data: Rc::new(self.data), endpoint: self.endpoint, services: Rc::new(RefCell::new(self.services)), external: RefCell::new(self.external), default: self.default, factory_ref: self.factory_ref, config: RefCell::new(AppConfig(Rc::new(self.config))), } } } #[cfg(test)] mod tests { use actix_service::Service; use bytes::Bytes; use futures::{Future, IntoFuture}; use super::*; use crate::http::{header, HeaderValue, Method, StatusCode}; use crate::service::{ServiceRequest, ServiceResponse}; use crate::test::{ block_fn, block_on, call_service, init_service, read_body, TestRequest, }; use crate::{web, Error, HttpRequest, HttpResponse}; #[test] fn test_default_resource() { let mut srv = init_service( App::new().service(web::resource("/test").to(|| HttpResponse::Ok())), ); let req = TestRequest::with_uri("/test").to_request(); let resp = block_fn(|| srv.call(req)).unwrap(); assert_eq!(resp.status(), StatusCode::OK); let req = TestRequest::with_uri("/blah").to_request(); let resp = block_on(srv.call(req)).unwrap(); assert_eq!(resp.status(), StatusCode::NOT_FOUND); let mut srv = init_service( App::new() .service(web::resource("/test").to(|| HttpResponse::Ok())) .service( web::resource("/test2") .default_service(|r: ServiceRequest| { r.into_response(HttpResponse::Created()) }) .route(web::get().to(|| HttpResponse::Ok())), ) .default_service(|r: ServiceRequest| { r.into_response(HttpResponse::MethodNotAllowed()) }), ); let req = TestRequest::with_uri("/blah").to_request(); let resp = block_on(srv.call(req)).unwrap(); assert_eq!(resp.status(), StatusCode::METHOD_NOT_ALLOWED); let req = TestRequest::with_uri("/test2").to_request(); let resp = block_on(srv.call(req)).unwrap(); assert_eq!(resp.status(), StatusCode::OK); let req = TestRequest::with_uri("/test2") .method(Method::POST) .to_request(); let resp = block_on(srv.call(req)).unwrap(); assert_eq!(resp.status(), StatusCode::CREATED); } // #[test] // fn test_data_factory() { // let mut srv = // init_service(App::new().data_factory(|| Ok::<_, ()>(10usize)).service( // web::resource("/").to(|_: web::Data<usize>| HttpResponse::Ok()), // )); // let req = TestRequest::default().to_request(); // let resp = block_on(srv.call(req)).unwrap(); // assert_eq!(resp.status(), StatusCode::OK); // let mut srv = // init_service(App::new().data_factory(|| Ok::<_, ()>(10u32)).service( // web::resource("/").to(|_: web::Data<usize>| HttpResponse::Ok()), // )); // let req = TestRequest::default().to_request(); // let resp = block_on(srv.call(req)).unwrap(); // assert_eq!(resp.status(), StatusCode::INTERNAL_SERVER_ERROR); // } fn md<S, B>( req: ServiceRequest, srv: &mut S, ) -> impl IntoFuture<Item = ServiceResponse<B>, Error = Error> where S: Service< Request = ServiceRequest, Response = ServiceResponse<B>, Error = Error, >, { srv.call(req).map(|mut res| { res.headers_mut() .insert(header::CONTENT_TYPE, HeaderValue::from_static("0001")); res }) } #[test] fn test_wrap() { let mut srv = init_service( App::new() .wrap(md) .route("/test", web::get().to(|| HttpResponse::Ok())), ); let req = TestRequest::with_uri("/test").to_request(); let resp = call_service(&mut srv, req); assert_eq!(resp.status(), StatusCode::OK); assert_eq!( resp.headers().get(header::CONTENT_TYPE).unwrap(), HeaderValue::from_static("0001") ); } #[test] fn test_router_wrap() { let mut srv = init_service( App::new() .route("/test", web::get().to(|| HttpResponse::Ok())) .wrap(md), ); let req = TestRequest::with_uri("/test").to_request(); let resp = call_service(&mut srv, req); assert_eq!(resp.status(), StatusCode::OK); assert_eq!( resp.headers().get(header::CONTENT_TYPE).unwrap(), HeaderValue::from_static("0001") ); } #[test] fn test_wrap_fn() { let mut srv = init_service( App::new() .wrap_fn(|req, srv| { srv.call(req).map(|mut res| { res.headers_mut().insert( header::CONTENT_TYPE, HeaderValue::from_static("0001"), ); res }) }) .service(web::resource("/test").to(|| HttpResponse::Ok())), ); let req = TestRequest::with_uri("/test").to_request(); let resp = call_service(&mut srv, req); assert_eq!(resp.status(), StatusCode::OK); assert_eq!( resp.headers().get(header::CONTENT_TYPE).unwrap(), HeaderValue::from_static("0001") ); } #[test] fn test_router_wrap_fn() { let mut srv = init_service( App::new() .route("/test", web::get().to(|| HttpResponse::Ok())) .wrap_fn(|req, srv| { srv.call(req).map(|mut res| { res.headers_mut().insert( header::CONTENT_TYPE, HeaderValue::from_static("0001"), ); res }) }), ); let req = TestRequest::with_uri("/test").to_request(); let resp = call_service(&mut srv, req); assert_eq!(resp.status(), StatusCode::OK); assert_eq!( resp.headers().get(header::CONTENT_TYPE).unwrap(), HeaderValue::from_static("0001") ); } #[test] fn test_external_resource() { let mut srv = init_service( App::new() .external_resource("youtube", "https://youtube.com/watch/{video_id}") .route( "/test", web::get().to(|req: HttpRequest| { HttpResponse::Ok().body(format!( "{}", req.url_for("youtube", &["12345"]).unwrap() )) }), ), ); let req = TestRequest::with_uri("/test").to_request(); let resp = call_service(&mut srv, req); assert_eq!(resp.status(), StatusCode::OK); let body = read_body(resp); assert_eq!(body, Bytes::from_static(b"https://youtube.com/watch/12345")); } }