1
0
mirror of https://github.com/actix/actix-extras.git synced 2024-11-24 16:02:59 +01:00
actix-extras/src/application.rs

988 lines
32 KiB
Rust
Raw Normal View History

2018-06-19 21:27:41 +02:00
use std::cell::RefCell;
2017-10-07 06:48:14 +02:00
use std::collections::HashMap;
2018-04-14 01:02:01 +02:00
use std::rc::Rc;
2017-10-07 06:48:14 +02:00
2018-05-04 01:22:08 +02:00
use handler::{AsyncResult, FromRequest, Handler, Responder, RouteHandler, WrapHandler};
2018-03-29 20:06:44 +02:00
use header::ContentEncoding;
2018-06-19 19:46:58 +02:00
use http::{Method, StatusCode};
use httprequest::HttpRequest;
2018-05-02 02:19:15 +02:00
use httpresponse::HttpResponse;
2017-12-27 04:59:41 +01:00
use middleware::Middleware;
2018-04-14 01:02:01 +02:00
use pipeline::{HandlerType, Pipeline, PipelineHandler};
2018-05-07 23:40:04 +02:00
use pred::Predicate;
2018-04-14 01:02:01 +02:00
use resource::ResourceHandler;
use router::{Resource, Router};
2018-04-30 04:35:50 +02:00
use scope::Scope;
2018-04-14 01:02:01 +02:00
use server::{HttpHandler, HttpHandlerTask, IntoHttpHandler, ServerSettings};
2017-10-07 06:48:14 +02:00
/// Application
2018-04-14 01:02:01 +02:00
pub struct HttpApplication<S = ()> {
2017-10-22 03:54:24 +02:00
state: Rc<S>,
prefix: String,
prefix_len: usize,
2017-12-26 18:00:45 +01:00
router: Router,
2018-06-19 21:27:41 +02:00
inner: Rc<RefCell<Inner<S>>>,
2018-06-08 04:46:38 +02:00
filters: Option<Vec<Box<Predicate<S>>>>,
middlewares: Rc<RefCell<Vec<Box<Middleware<S>>>>>,
2017-10-07 06:48:14 +02:00
}
2018-06-18 01:45:54 +02:00
#[doc(hidden)]
pub struct Inner<S> {
prefix: usize,
default: ResourceHandler<S>,
encoding: ContentEncoding,
resources: Vec<ResourceHandler<S>>,
handlers: Vec<PrefixHandlerType<S>>,
}
enum PrefixHandlerType<S> {
Handler(String, Box<RouteHandler<S>>),
2018-05-07 23:40:04 +02:00
Scope(Resource, Box<RouteHandler<S>>, Vec<Box<Predicate<S>>>),
2017-12-29 10:01:31 +01:00
}
2017-10-07 06:48:14 +02:00
2017-12-29 10:01:31 +01:00
impl<S: 'static> PipelineHandler<S> for Inner<S> {
fn encoding(&self) -> ContentEncoding {
self.encoding
}
2018-05-02 02:19:15 +02:00
fn handle(
&mut self, req: HttpRequest<S>, htype: HandlerType,
2018-05-04 01:22:08 +02:00
) -> AsyncResult<HttpResponse> {
match htype {
2018-06-19 19:46:58 +02:00
HandlerType::Normal(idx) => match self.resources[idx].handle(req) {
Ok(result) => result,
Err(req) => match self.default.handle(req) {
Ok(result) => result,
Err(_) => AsyncResult::ok(HttpResponse::new(StatusCode::NOT_FOUND)),
},
},
HandlerType::Handler(idx) => match self.handlers[idx] {
PrefixHandlerType::Handler(_, ref mut hnd) => hnd.handle(req),
2018-05-07 23:40:04 +02:00
PrefixHandlerType::Scope(_, ref mut hnd, _) => hnd.handle(req),
},
2018-06-19 19:46:58 +02:00
HandlerType::Default => match self.default.handle(req) {
Ok(result) => result,
Err(_) => AsyncResult::ok(HttpResponse::new(StatusCode::NOT_FOUND)),
},
}
}
}
impl<S: 'static> HttpApplication<S> {
#[inline]
fn get_handler(&self, req: &mut HttpRequest<S>) -> HandlerType {
if let Some(idx) = self.router.recognize(req) {
HandlerType::Normal(idx)
2017-10-22 03:54:24 +02:00
} else {
2018-06-19 21:27:41 +02:00
let inner = self.inner.borrow();
2018-06-19 12:45:26 +02:00
req.match_info_mut().set_tail(0);
2018-05-07 23:40:04 +02:00
'outer: for idx in 0..inner.handlers.len() {
match inner.handlers[idx] {
PrefixHandlerType::Handler(ref prefix, _) => {
let m = {
2018-06-19 12:45:26 +02:00
let path = &req.path()[inner.prefix..];
let path_len = path.len();
path.starts_with(prefix)
&& (path_len == prefix.len()
|| path.split_at(prefix.len()).1.starts_with('/'))
};
if m {
2018-06-19 12:45:26 +02:00
let prefix_len = (inner.prefix + prefix.len()) as u16;
let url = req.url().clone();
req.set_prefix_len(prefix_len);
req.match_info_mut().set_url(url);
req.match_info_mut().set_tail(prefix_len);
return HandlerType::Handler(idx);
}
}
2018-05-07 23:40:04 +02:00
PrefixHandlerType::Scope(ref pattern, _, ref filters) => {
if let Some(prefix_len) =
2018-06-19 12:45:26 +02:00
pattern.match_prefix_with_params(req, inner.prefix)
{
2018-05-07 23:40:04 +02:00
for filter in filters {
if !filter.check(req) {
continue 'outer;
}
}
2018-06-19 12:45:26 +02:00
let prefix_len = (inner.prefix + prefix_len) as u16;
let url = req.url().clone();
req.set_prefix_len(prefix_len);
let params = req.match_info_mut();
params.set_tail(prefix_len);
params.set_url(url);
return HandlerType::Handler(idx);
}
}
2018-01-02 22:09:02 +01:00
}
}
HandlerType::Default
2017-10-10 08:07:32 +02:00
}
2017-10-07 06:48:14 +02:00
}
#[cfg(test)]
2018-05-04 01:22:08 +02:00
pub(crate) fn run(&mut self, mut req: HttpRequest<S>) -> AsyncResult<HttpResponse> {
let tp = self.get_handler(&mut req);
2018-06-19 21:27:41 +02:00
self.inner.borrow_mut().handle(req, tp)
2017-12-29 10:01:31 +01:00
}
#[cfg(test)]
2017-12-29 10:01:31 +01:00
pub(crate) fn prepare_request(&self, req: HttpRequest) -> HttpRequest<S> {
req.with_state(Rc::clone(&self.state), self.router.clone())
}
}
2017-12-12 17:51:16 +01:00
impl<S: 'static> HttpHandler for HttpApplication<S> {
2018-06-18 01:45:54 +02:00
type Task = Pipeline<S, Inner<S>>;
fn handle(
&mut self, req: HttpRequest,
) -> Result<Pipeline<S, Inner<S>>, HttpRequest> {
let m = {
let path = req.path();
2018-04-14 01:02:01 +02:00
path.starts_with(&self.prefix)
&& (path.len() == self.prefix_len
|| path.split_at(self.prefix_len).1.starts_with('/'))
};
if m {
2018-06-08 04:46:38 +02:00
let mut req2 =
req.clone_with_state(Rc::clone(&self.state), self.router.clone());
if let Some(ref filters) = self.filters {
for filter in filters {
if !filter.check(&mut req2) {
return Err(req);
}
}
}
let tp = self.get_handler(&mut req2);
2017-12-29 10:01:31 +01:00
let inner = Rc::clone(&self.inner);
2018-06-18 01:45:54 +02:00
Ok(Pipeline::new(req2, Rc::clone(&self.middlewares), inner, tp))
2017-11-29 22:53:52 +01:00
} else {
Err(req)
}
}
}
2017-12-06 20:00:39 +01:00
struct ApplicationParts<S> {
state: S,
prefix: String,
2017-12-29 20:33:04 +01:00
settings: ServerSettings,
default: ResourceHandler<S>,
resources: Vec<(Resource, Option<ResourceHandler<S>>)>,
handlers: Vec<PrefixHandlerType<S>>,
external: HashMap<String, Resource>,
encoding: ContentEncoding,
2017-12-09 13:33:40 +01:00
middlewares: Vec<Box<Middleware<S>>>,
2018-06-08 04:46:38 +02:00
filters: Vec<Box<Predicate<S>>>,
2017-12-06 20:00:39 +01:00
}
2018-04-14 01:02:01 +02:00
/// Structure that follows the builder pattern for building application
/// instances.
pub struct App<S = ()> {
2017-12-06 20:00:39 +01:00
parts: Option<ApplicationParts<S>>,
}
2018-03-31 09:16:55 +02:00
impl App<()> {
2018-04-14 01:02:01 +02:00
/// Create application with empty state. Application can
/// be configured with a builder-like pattern.
2018-03-31 09:16:55 +02:00
pub fn new() -> App<()> {
App::with_state(())
2017-10-07 06:48:14 +02:00
}
}
2018-03-31 09:16:55 +02:00
impl Default for App<()> {
fn default() -> Self {
2018-03-31 09:16:55 +02:00
App::new()
}
}
2018-04-14 01:02:01 +02:00
impl<S> App<S>
where
S: 'static,
{
/// Create application with specified state. Application can be
/// configured with a builder-like pattern.
2017-12-06 20:00:39 +01:00
///
/// State is shared with all resources within same application and
/// could be accessed with `HttpRequest::state()` method.
///
/// **Note**: http server accepts an application factory rather than
/// an application instance. Http server constructs an application
2018-04-18 19:49:03 +02:00
/// instance for each thread, thus application state must be constructed
/// multiple times. If you want to share state between different
/// threads, a shared object should be used, e.g. `Arc`. Application
/// state does not need to be `Send` and `Sync`.
2018-03-31 09:16:55 +02:00
pub fn with_state(state: S) -> App<S> {
App {
2017-12-06 20:00:39 +01:00
parts: Some(ApplicationParts {
2018-02-26 23:33:56 +01:00
state,
prefix: "/".to_owned(),
2017-12-29 20:33:04 +01:00
settings: ServerSettings::default(),
default: ResourceHandler::default_not_found(),
2018-02-22 14:48:18 +01:00
resources: Vec::new(),
2018-01-02 22:09:02 +01:00
handlers: Vec::new(),
external: HashMap::new(),
middlewares: Vec::new(),
2018-06-08 04:46:38 +02:00
filters: Vec::new(),
encoding: ContentEncoding::Auto,
2018-04-14 01:02:01 +02:00
}),
2017-10-15 23:17:41 +02:00
}
}
/// Get reference to the application state
pub fn state(&self) -> &S {
let parts = self.parts.as_ref().expect("Use after finish");
&parts.state
}
/// Set application prefix.
///
/// Only requests that match the application's prefix get
/// processed by this application.
///
/// The application prefix always contains a leading slash (`/`).
/// If the supplied prefix does not contain leading slash, it is
/// inserted.
///
/// Prefix should consist of valid path segments. i.e for an
/// application with the prefix `/app` any request with the paths
/// `/app`, `/app/` or `/app/test` would match, but the path
/// `/application` would not.
///
/// In the following example only requests with an `/app/` path
/// prefix get handled. Requests with path `/app/test/` would be
/// handled, while requests with the paths `/application` or
/// `/other/...` would return `NOT FOUND`.
///
/// ```rust
/// # extern crate actix_web;
2018-03-31 09:16:55 +02:00
/// use actix_web::{http, App, HttpResponse};
///
/// fn main() {
2018-03-31 09:16:55 +02:00
/// let app = App::new()
/// .prefix("/app")
/// .resource("/test", |r| {
2018-06-01 18:37:14 +02:00
/// r.get().f(|_| HttpResponse::Ok());
/// r.head().f(|_| HttpResponse::MethodNotAllowed());
/// })
/// .finish();
/// }
/// ```
2018-03-31 09:16:55 +02:00
pub fn prefix<P: Into<String>>(mut self, prefix: P) -> App<S> {
{
let parts = self.parts.as_mut().expect("Use after finish");
let mut prefix = prefix.into();
if !prefix.starts_with('/') {
prefix.insert(0, '/')
}
parts.prefix = prefix;
}
self
}
2018-06-08 04:46:38 +02:00
/// Add match predicate to application.
///
/// ```rust
/// # extern crate actix_web;
/// # use actix_web::*;
/// # fn main() {
/// App::new()
2018-06-08 05:22:23 +02:00
/// .filter(pred::Host("www.rust-lang.org"))
2018-06-08 04:46:38 +02:00
/// .resource("/path", |r| r.f(|_| HttpResponse::Ok()))
/// # .finish();
/// # }
/// ```
pub fn filter<T: Predicate<S> + 'static>(mut self, p: T) -> App<S> {
{
let parts = self.parts.as_mut().expect("Use after finish");
parts.filters.push(Box::new(p));
}
self
}
/// Configure route for a specific path.
///
/// This is a simplified version of the `App::resource()` method.
/// Handler functions need to accept one request extractor
/// argument.
2018-04-07 06:18:42 +02:00
///
/// This method could be called multiple times, in that case
/// multiple routes would be registered for same resource path.
2018-04-07 06:18:42 +02:00
///
/// ```rust
/// # extern crate actix_web;
/// use actix_web::{http, App, HttpRequest, HttpResponse};
///
/// fn main() {
/// let app = App::new()
2018-06-01 18:37:14 +02:00
/// .route("/test", http::Method::GET, |_: HttpRequest| {
/// HttpResponse::Ok()
/// })
/// .route("/test", http::Method::POST, |_: HttpRequest| {
/// HttpResponse::MethodNotAllowed()
/// });
2018-04-07 06:18:42 +02:00
/// }
/// ```
pub fn route<T, F, R>(mut self, path: &str, method: Method, f: F) -> App<S>
2018-04-14 01:02:01 +02:00
where
F: Fn(T) -> R + 'static,
R: Responder + 'static,
T: FromRequest<S> + 'static,
2018-04-07 06:18:42 +02:00
{
{
2018-06-19 21:27:41 +02:00
let parts = self.parts.as_mut().expect("Use after finish");
2018-04-07 06:18:42 +02:00
// get resource handler
2018-06-19 21:27:41 +02:00
let mut found = false;
for &mut (ref pattern, ref handler) in &mut parts.resources {
if handler.is_some() && pattern.pattern() == path {
found = true;
break;
2018-04-07 06:18:42 +02:00
}
}
2018-06-19 21:27:41 +02:00
if !found {
let mut handler = ResourceHandler::default();
handler.method(method).with(f);
let pattern = Resource::new(handler.get_name(), path);
parts.resources.push((pattern, Some(handler)));
} else {
for &mut (ref pattern, ref mut handler) in &mut parts.resources {
if let Some(ref mut handler) = *handler {
if pattern.pattern() == path {
handler.method(method).with(f);
break;
}
}
}
}
2018-04-07 06:18:42 +02:00
}
self
}
2018-04-30 04:35:50 +02:00
/// Configure scope for common root path.
///
/// Scopes collect multiple paths under a common path prefix.
/// Scope path can contain variable path segments as resources.
2018-04-30 04:35:50 +02:00
///
/// ```rust
/// # extern crate actix_web;
/// use actix_web::{http, App, HttpRequest, HttpResponse};
///
/// fn main() {
2018-06-01 18:37:14 +02:00
/// let app = App::new().scope("/{project_id}", |scope| {
/// scope
/// .resource("/path1", |r| r.f(|_| HttpResponse::Ok()))
/// .resource("/path2", |r| r.f(|_| HttpResponse::Ok()))
/// .resource("/path3", |r| r.f(|_| HttpResponse::MethodNotAllowed()))
/// });
2018-04-30 04:35:50 +02:00
/// }
/// ```
///
2018-04-30 04:49:26 +02:00
/// In the above example, three routes get added:
/// * /{project_id}/path1
/// * /{project_id}/path2
/// * /{project_id}/path3
2018-04-30 04:35:50 +02:00
///
pub fn scope<F>(mut self, path: &str, f: F) -> App<S>
where
F: FnOnce(Scope<S>) -> Scope<S>,
{
{
2018-05-07 23:40:04 +02:00
let mut scope = Box::new(f(Scope::new()));
2018-04-30 04:35:50 +02:00
let parts = self.parts.as_mut().expect("Use after finish");
2018-05-07 23:40:04 +02:00
let filters = scope.take_filters();
parts.handlers.push(PrefixHandlerType::Scope(
Resource::prefix("", &path),
scope,
2018-05-07 23:40:04 +02:00
filters,
));
2018-04-30 04:35:50 +02:00
}
self
}
/// Configure resource for a specific path.
2017-10-15 23:17:41 +02:00
///
/// Resources may have variable path segments. For example, a
/// resource with the path `/a/{name}/c` would match all incoming
/// requests with paths such as `/a/b/c`, `/a/1/c`, or `/a/etc/c`.
2017-10-22 03:54:24 +02:00
///
/// A variable segment is specified in the form `{identifier}`,
/// where the identifier can be used later in a request handler to
/// access the matched value for that segment. This is done by
/// looking up the identifier in the `Params` object returned by
/// `HttpRequest.match_info()` method.
2017-10-22 03:54:24 +02:00
///
/// By default, each segment matches the regular expression `[^{}/]+`.
2017-10-22 03:54:24 +02:00
///
/// You can also specify a custom regex in the form `{identifier:regex}`:
///
/// For instance, to route `GET`-requests on any route matching
/// `/users/{userid}/{friend}` and store `userid` and `friend` in
/// the exposed `Params` object:
2017-10-22 03:54:24 +02:00
///
2017-10-15 23:17:41 +02:00
/// ```rust
2017-12-06 20:00:39 +01:00
/// # extern crate actix_web;
2018-03-31 09:16:55 +02:00
/// use actix_web::{http, App, HttpResponse};
2017-10-15 23:17:41 +02:00
///
/// fn main() {
2018-06-01 18:37:14 +02:00
/// let app = App::new().resource("/users/{userid}/{friend}", |r| {
/// r.get().f(|_| HttpResponse::Ok());
/// r.head().f(|_| HttpResponse::MethodNotAllowed());
/// });
2017-10-15 23:17:41 +02:00
/// }
/// ```
2018-04-04 07:06:18 +02:00
pub fn resource<F, R>(mut self, path: &str, f: F) -> App<S>
2018-04-14 01:02:01 +02:00
where
F: FnOnce(&mut ResourceHandler<S>) -> R + 'static,
2017-10-15 23:17:41 +02:00
{
{
let parts = self.parts.as_mut().expect("Use after finish");
2018-04-07 06:18:42 +02:00
// add resource handler
let mut handler = ResourceHandler::default();
f(&mut handler);
2018-04-07 06:18:42 +02:00
let pattern = Resource::new(handler.get_name(), path);
parts.resources.push((pattern, Some(handler)));
2017-10-15 23:17:41 +02:00
}
self
}
/// Configure resource for a specific path.
#[doc(hidden)]
pub fn register_resource(&mut self, path: &str, resource: ResourceHandler<S>) {
let pattern = Resource::new(resource.get_name(), path);
2018-04-14 01:02:01 +02:00
self.parts
.as_mut()
.expect("Use after finish")
.resources
.push((pattern, Some(resource)));
}
/// Default resource to be used if no matching route could be found.
2018-04-04 07:06:18 +02:00
pub fn default_resource<F, R>(mut self, f: F) -> App<S>
2018-04-14 01:02:01 +02:00
where
F: FnOnce(&mut ResourceHandler<S>) -> R + 'static,
2017-10-15 23:17:41 +02:00
{
{
let parts = self.parts.as_mut().expect("Use after finish");
f(&mut parts.default);
}
self
}
/// Set default content encoding. `ContentEncoding::Auto` is set by default.
2018-04-14 01:02:01 +02:00
pub fn default_encoding(mut self, encoding: ContentEncoding) -> App<S> {
{
let parts = self.parts.as_mut().expect("Use after finish");
parts.encoding = encoding;
}
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
/// # extern crate actix_web;
2018-03-31 09:16:55 +02:00
/// use actix_web::{App, HttpRequest, HttpResponse, Result};
///
/// fn index(mut req: HttpRequest) -> Result<HttpResponse> {
2018-06-01 18:37:14 +02:00
/// let url = req.url_for("youtube", &["oHg5SJYRHA0"])?;
/// assert_eq!(url.as_str(), "https://youtube.com/watch/oHg5SJYRHA0");
/// Ok(HttpResponse::Ok().into())
/// }
///
/// fn main() {
2018-03-31 09:16:55 +02:00
/// let app = App::new()
/// .resource("/index.html", |r| r.get().f(index))
/// .external_resource("youtube", "https://youtube.com/watch/{video_id}")
/// .finish();
/// }
/// ```
2018-03-31 09:16:55 +02:00
pub fn external_resource<T, U>(mut self, name: T, url: U) -> App<S>
2018-04-14 01:02:01 +02:00
where
T: AsRef<str>,
U: AsRef<str>,
{
{
let parts = self.parts.as_mut().expect("Use after finish");
if parts.external.contains_key(name.as_ref()) {
panic!("External resource {:?} is registered.", name.as_ref());
}
parts.external.insert(
String::from(name.as_ref()),
2018-04-14 01:02:01 +02:00
Resource::external(name.as_ref(), url.as_ref()),
);
}
self
}
2018-01-02 22:09:02 +01:00
/// Configure handler for specific path prefix.
///
/// A path prefix consists of valid path segments, i.e for the
/// prefix `/app` any request with the paths `/app`, `/app/` or
/// `/app/test` would match, but the path `/application` would
/// not.
2018-01-02 22:09:02 +01:00
///
2018-04-17 21:55:13 +02:00
/// Path tail is available as `tail` parameter in request's match_dict.
///
2018-01-02 22:09:02 +01:00
/// ```rust
/// # extern crate actix_web;
2018-03-31 09:16:55 +02:00
/// use actix_web::{http, App, HttpRequest, HttpResponse};
2018-01-02 22:09:02 +01:00
///
/// fn main() {
2018-06-01 18:37:14 +02:00
/// let app = App::new().handler("/app", |req: HttpRequest| match *req.method() {
/// http::Method::GET => HttpResponse::Ok(),
/// http::Method::POST => HttpResponse::MethodNotAllowed(),
/// _ => HttpResponse::NotFound(),
/// });
2018-01-02 22:09:02 +01:00
/// }
/// ```
2018-04-14 01:02:01 +02:00
pub fn handler<H: Handler<S>>(mut self, path: &str, handler: H) -> App<S> {
2018-01-02 22:09:02 +01:00
{
let mut path = path.trim().trim_right_matches('/').to_owned();
if !path.is_empty() && !path.starts_with('/') {
path.insert(0, '/')
}
if path.len() > 1 && path.ends_with('/') {
path.pop();
}
2018-01-02 22:09:02 +01:00
let parts = self.parts.as_mut().expect("Use after finish");
parts.handlers.push(PrefixHandlerType::Handler(
path,
Box::new(WrapHandler::new(handler)),
));
2018-01-02 22:09:02 +01:00
}
self
}
/// Register a middleware.
2018-03-31 09:16:55 +02:00
pub fn middleware<M: Middleware<S>>(mut self, mw: M) -> App<S> {
2018-04-29 18:09:08 +02:00
self.parts
.as_mut()
.expect("Use after finish")
.middlewares
.push(Box::new(mw));
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 event library. For example we can move
/// some of the resources' configuration to different module.
///
/// ```rust
/// # extern crate actix_web;
2018-06-01 18:37:14 +02:00
/// use actix_web::{fs, middleware, App, HttpResponse};
///
/// // this function could be located in different module
2018-03-31 09:16:55 +02:00
/// fn config(app: App) -> App {
2018-06-01 18:37:14 +02:00
/// app.resource("/test", |r| {
/// r.get().f(|_| HttpResponse::Ok());
/// r.head().f(|_| HttpResponse::MethodNotAllowed());
/// })
/// }
///
/// fn main() {
2018-03-31 09:16:55 +02:00
/// let app = App::new()
/// .middleware(middleware::Logger::default())
/// .configure(config) // <- register resources
2018-04-07 04:34:55 +02:00
/// .handler("/static", fs::StaticFiles::new("."));
/// }
/// ```
2018-03-31 09:16:55 +02:00
pub fn configure<F>(self, cfg: F) -> App<S>
2018-04-14 01:02:01 +02:00
where
F: Fn(App<S>) -> App<S>,
{
cfg(self)
}
/// Finish application configuration and create `HttpHandler` object.
2017-12-06 20:00:39 +01:00
pub fn finish(&mut self) -> HttpApplication<S> {
2017-10-22 03:54:24 +02:00
let parts = self.parts.take().expect("Use after finish");
2017-12-07 01:26:27 +01:00
let prefix = parts.prefix.trim().trim_right_matches('/');
let (prefix, prefix_len) = if prefix.is_empty() {
("/".to_owned(), 0)
} else {
(prefix.to_owned(), prefix.len())
};
let mut resources = parts.resources;
for (_, pattern) in parts.external {
2018-02-22 14:48:18 +01:00
resources.push((pattern, None));
}
let (router, resources) = Router::new(&prefix, parts.settings, resources);
2017-12-29 10:01:31 +01:00
2018-06-19 21:27:41 +02:00
let inner = Rc::new(RefCell::new(Inner {
2018-04-14 01:02:01 +02:00
prefix: prefix_len,
default: parts.default,
encoding: parts.encoding,
handlers: parts.handlers,
resources,
}));
2018-06-08 04:46:38 +02:00
let filters = if parts.filters.is_empty() {
None
} else {
Some(parts.filters)
};
2017-12-29 10:01:31 +01:00
2017-12-06 20:00:39 +01:00
HttpApplication {
2017-10-22 03:54:24 +02:00
state: Rc::new(parts.state),
2017-12-29 10:01:31 +01:00
router: router.clone(),
middlewares: Rc::new(RefCell::new(parts.middlewares)),
prefix,
prefix_len,
2018-02-26 23:33:56 +01:00
inner,
2018-06-08 04:46:38 +02:00
filters,
}
2017-10-15 23:17:41 +02:00
}
/// Convenience method for creating `Box<HttpHandler>` instances.
///
/// This method is useful if you need to register multiple
/// application instances with different state.
///
/// ```rust
/// # use std::thread;
/// # extern crate actix_web;
2018-04-06 18:45:10 +02:00
/// use actix_web::{server, App, HttpResponse};
///
/// struct State1;
///
/// struct State2;
///
/// fn main() {
2018-06-01 19:27:23 +02:00
/// # thread::spawn(|| {
2018-06-01 18:37:14 +02:00
/// server::new(|| {
/// vec![
/// App::with_state(State1)
/// .prefix("/app1")
/// .resource("/", |r| r.f(|r| HttpResponse::Ok()))
/// .boxed(),
/// App::with_state(State2)
/// .prefix("/app2")
/// .resource("/", |r| r.f(|r| HttpResponse::Ok()))
/// .boxed(),
/// ]
/// }).bind("127.0.0.1:8080")
/// .unwrap()
/// .run()
2018-06-01 19:27:23 +02:00
/// # });
/// }
/// ```
2018-06-18 01:45:54 +02:00
pub fn boxed(mut self) -> Box<HttpHandler<Task = Box<HttpHandlerTask>>> {
Box::new(BoxedApplication { app: self.finish() })
}
}
struct BoxedApplication<S> {
app: HttpApplication<S>,
}
impl<S: 'static> HttpHandler for BoxedApplication<S> {
type Task = Box<HttpHandlerTask>;
fn handle(&mut self, req: HttpRequest) -> Result<Self::Task, HttpRequest> {
self.app.handle(req).map(|t| {
let task: Self::Task = Box::new(t);
task
})
}
2017-10-15 23:17:41 +02:00
}
2017-10-07 06:48:14 +02:00
2018-03-31 09:16:55 +02:00
impl<S: 'static> IntoHttpHandler for App<S> {
2017-12-06 20:00:39 +01:00
type Handler = HttpApplication<S>;
2017-12-29 20:33:04 +01:00
fn into_handler(mut self, settings: ServerSettings) -> HttpApplication<S> {
{
let parts = self.parts.as_mut().expect("Use after finish");
parts.settings = settings;
}
2017-12-06 20:00:39 +01:00
self.finish()
}
}
2018-03-31 09:16:55 +02:00
impl<'a, S: 'static> IntoHttpHandler for &'a mut App<S> {
2017-12-06 20:00:39 +01:00
type Handler = HttpApplication<S>;
2017-12-29 20:33:04 +01:00
fn into_handler(self, settings: ServerSettings) -> HttpApplication<S> {
{
let parts = self.parts.as_mut().expect("Use after finish");
parts.settings = settings;
}
2017-12-06 20:00:39 +01:00
self.finish()
2017-10-22 03:54:24 +02:00
}
2017-10-07 06:48:14 +02:00
}
2017-12-06 20:00:39 +01:00
#[doc(hidden)]
2018-03-31 09:16:55 +02:00
impl<S: 'static> Iterator for App<S> {
2017-12-06 20:00:39 +01:00
type Item = HttpApplication<S>;
2017-10-07 06:48:14 +02:00
2017-10-22 03:54:24 +02:00
fn next(&mut self) -> Option<Self::Item> {
if self.parts.is_some() {
Some(self.finish())
2017-10-07 06:48:14 +02:00
} else {
2017-10-22 03:54:24 +02:00
None
2017-10-07 06:48:14 +02:00
}
}
}
2017-12-06 22:02:53 +01:00
#[cfg(test)]
mod tests {
use super::*;
use body::{Binary, Body};
2018-04-14 01:02:01 +02:00
use http::StatusCode;
2017-12-06 22:02:53 +01:00
use httprequest::HttpRequest;
use httpresponse::HttpResponse;
2018-06-08 04:46:38 +02:00
use pred;
use test::{TestRequest, TestServer};
2017-12-06 22:02:53 +01:00
#[test]
fn test_default_resource() {
2018-04-29 18:09:08 +02:00
let mut app = App::new()
.resource("/test", |r| r.f(|_| HttpResponse::Ok()))
.finish();
2017-12-06 22:02:53 +01:00
2017-12-27 04:48:02 +01:00
let req = TestRequest::with_uri("/test").finish();
2017-12-09 22:25:06 +01:00
let resp = app.run(req);
2018-05-02 02:19:15 +02:00
assert_eq!(resp.as_msg().status(), StatusCode::OK);
2017-12-06 22:02:53 +01:00
2018-01-02 22:09:02 +01:00
let req = TestRequest::with_uri("/blah").finish();
2017-12-09 22:25:06 +01:00
let resp = app.run(req);
2018-05-02 02:19:15 +02:00
assert_eq!(resp.as_msg().status(), StatusCode::NOT_FOUND);
2017-12-06 22:02:53 +01:00
2018-03-31 09:16:55 +02:00
let mut app = App::new()
.default_resource(|r| r.f(|_| HttpResponse::MethodNotAllowed()))
2017-12-06 22:02:53 +01:00
.finish();
2018-01-02 22:09:02 +01:00
let req = TestRequest::with_uri("/blah").finish();
2017-12-09 22:25:06 +01:00
let resp = app.run(req);
2018-05-02 02:19:15 +02:00
assert_eq!(resp.as_msg().status(), StatusCode::METHOD_NOT_ALLOWED);
2017-12-06 22:02:53 +01:00
}
2017-12-07 03:39:13 +01:00
#[test]
fn test_unhandled_prefix() {
2018-03-31 09:16:55 +02:00
let mut app = App::new()
.prefix("/test")
.resource("/test", |r| r.f(|_| HttpResponse::Ok()))
2017-12-07 03:39:13 +01:00
.finish();
assert!(app.handle(HttpRequest::default()).is_err());
}
#[test]
fn test_state() {
2018-04-29 18:09:08 +02:00
let mut app = App::with_state(10)
.resource("/", |r| r.f(|_| HttpResponse::Ok()))
.finish();
2018-04-14 01:02:01 +02:00
let req =
HttpRequest::default().with_state(Rc::clone(&app.state), app.router.clone());
2017-12-09 22:25:06 +01:00
let resp = app.run(req);
2018-05-02 02:19:15 +02:00
assert_eq!(resp.as_msg().status(), StatusCode::OK);
2017-12-07 03:39:13 +01:00
}
#[test]
fn test_prefix() {
2018-03-31 09:16:55 +02:00
let mut app = App::new()
.prefix("/test")
.resource("/blah", |r| r.f(|_| HttpResponse::Ok()))
.finish();
let req = TestRequest::with_uri("/test").finish();
let resp = app.handle(req);
assert!(resp.is_ok());
let req = TestRequest::with_uri("/test/").finish();
let resp = app.handle(req);
assert!(resp.is_ok());
2018-01-02 22:09:02 +01:00
let req = TestRequest::with_uri("/test/blah").finish();
let resp = app.handle(req);
assert!(resp.is_ok());
let req = TestRequest::with_uri("/testing").finish();
let resp = app.handle(req);
assert!(resp.is_err());
}
2018-01-02 22:09:02 +01:00
#[test]
fn test_handler() {
2018-06-18 01:45:54 +02:00
let mut app = App::new().handler("/test", |_| HttpResponse::Ok()).finish();
2018-01-02 22:09:02 +01:00
let req = TestRequest::with_uri("/test").finish();
let resp = app.run(req);
2018-05-02 02:19:15 +02:00
assert_eq!(resp.as_msg().status(), StatusCode::OK);
2018-01-02 22:09:02 +01:00
let req = TestRequest::with_uri("/test/").finish();
let resp = app.run(req);
2018-05-02 02:19:15 +02:00
assert_eq!(resp.as_msg().status(), StatusCode::OK);
2018-01-02 22:09:02 +01:00
let req = TestRequest::with_uri("/test/app").finish();
let resp = app.run(req);
2018-05-02 02:19:15 +02:00
assert_eq!(resp.as_msg().status(), StatusCode::OK);
2018-01-02 22:09:02 +01:00
let req = TestRequest::with_uri("/testapp").finish();
let resp = app.run(req);
2018-05-02 02:19:15 +02:00
assert_eq!(resp.as_msg().status(), StatusCode::NOT_FOUND);
2018-01-02 22:09:02 +01:00
let req = TestRequest::with_uri("/blah").finish();
let resp = app.run(req);
2018-05-02 02:19:15 +02:00
assert_eq!(resp.as_msg().status(), StatusCode::NOT_FOUND);
}
#[test]
fn test_handler2() {
2018-06-18 01:45:54 +02:00
let mut app = App::new().handler("test", |_| HttpResponse::Ok()).finish();
let req = TestRequest::with_uri("/test").finish();
let resp = app.run(req);
2018-05-02 02:19:15 +02:00
assert_eq!(resp.as_msg().status(), StatusCode::OK);
let req = TestRequest::with_uri("/test/").finish();
let resp = app.run(req);
2018-05-02 02:19:15 +02:00
assert_eq!(resp.as_msg().status(), StatusCode::OK);
let req = TestRequest::with_uri("/test/app").finish();
let resp = app.run(req);
2018-05-02 02:19:15 +02:00
assert_eq!(resp.as_msg().status(), StatusCode::OK);
let req = TestRequest::with_uri("/testapp").finish();
let resp = app.run(req);
2018-05-02 02:19:15 +02:00
assert_eq!(resp.as_msg().status(), StatusCode::NOT_FOUND);
let req = TestRequest::with_uri("/blah").finish();
let resp = app.run(req);
2018-05-02 02:19:15 +02:00
assert_eq!(resp.as_msg().status(), StatusCode::NOT_FOUND);
}
#[test]
fn test_handler_with_prefix() {
let mut app = App::new()
.prefix("prefix")
.handler("/test", |_| HttpResponse::Ok())
.finish();
let req = TestRequest::with_uri("/prefix/test").finish();
let resp = app.run(req);
2018-05-02 02:19:15 +02:00
assert_eq!(resp.as_msg().status(), StatusCode::OK);
let req = TestRequest::with_uri("/prefix/test/").finish();
let resp = app.run(req);
2018-05-02 02:19:15 +02:00
assert_eq!(resp.as_msg().status(), StatusCode::OK);
let req = TestRequest::with_uri("/prefix/test/app").finish();
let resp = app.run(req);
2018-05-02 02:19:15 +02:00
assert_eq!(resp.as_msg().status(), StatusCode::OK);
let req = TestRequest::with_uri("/prefix/testapp").finish();
let resp = app.run(req);
2018-05-02 02:19:15 +02:00
assert_eq!(resp.as_msg().status(), StatusCode::NOT_FOUND);
let req = TestRequest::with_uri("/prefix/blah").finish();
let resp = app.run(req);
2018-05-02 02:19:15 +02:00
assert_eq!(resp.as_msg().status(), StatusCode::NOT_FOUND);
}
2018-04-07 06:18:42 +02:00
#[test]
fn test_route() {
let mut app = App::new()
2018-06-18 01:45:54 +02:00
.route("/test", Method::GET, |_: HttpRequest| HttpResponse::Ok())
2018-04-29 18:09:08 +02:00
.route("/test", Method::POST, |_: HttpRequest| {
HttpResponse::Created()
})
2018-04-07 06:18:42 +02:00
.finish();
2018-06-18 01:45:54 +02:00
let req = TestRequest::with_uri("/test").method(Method::GET).finish();
2018-04-07 06:18:42 +02:00
let resp = app.run(req);
2018-05-02 02:19:15 +02:00
assert_eq!(resp.as_msg().status(), StatusCode::OK);
2018-04-07 06:18:42 +02:00
2018-06-18 01:45:54 +02:00
let req = TestRequest::with_uri("/test").method(Method::POST).finish();
2018-04-07 06:18:42 +02:00
let resp = app.run(req);
2018-05-02 02:19:15 +02:00
assert_eq!(resp.as_msg().status(), StatusCode::CREATED);
2018-04-07 06:18:42 +02:00
2018-06-18 01:45:54 +02:00
let req = TestRequest::with_uri("/test").method(Method::HEAD).finish();
2018-04-07 06:18:42 +02:00
let resp = app.run(req);
2018-05-02 02:19:15 +02:00
assert_eq!(resp.as_msg().status(), StatusCode::NOT_FOUND);
2018-04-07 06:18:42 +02:00
}
#[test]
fn test_handler_prefix() {
2018-04-29 18:09:08 +02:00
let mut app = App::new()
.prefix("/app")
.handler("/test", |_| HttpResponse::Ok())
.finish();
let req = TestRequest::with_uri("/test").finish();
let resp = app.run(req);
2018-05-02 02:19:15 +02:00
assert_eq!(resp.as_msg().status(), StatusCode::NOT_FOUND);
let req = TestRequest::with_uri("/app/test").finish();
2018-05-01 07:04:24 +02:00
let resp = app.run(req.clone());
2018-05-02 02:19:15 +02:00
assert_eq!(resp.as_msg().status(), StatusCode::OK);
2018-05-01 07:04:24 +02:00
assert_eq!(req.prefix_len(), 9);
let req = TestRequest::with_uri("/app/test/").finish();
let resp = app.run(req);
2018-05-02 02:19:15 +02:00
assert_eq!(resp.as_msg().status(), StatusCode::OK);
let req = TestRequest::with_uri("/app/test/app").finish();
let resp = app.run(req);
2018-05-02 02:19:15 +02:00
assert_eq!(resp.as_msg().status(), StatusCode::OK);
let req = TestRequest::with_uri("/app/testapp").finish();
let resp = app.run(req);
2018-05-02 02:19:15 +02:00
assert_eq!(resp.as_msg().status(), StatusCode::NOT_FOUND);
let req = TestRequest::with_uri("/app/blah").finish();
let resp = app.run(req);
2018-05-02 02:19:15 +02:00
assert_eq!(resp.as_msg().status(), StatusCode::NOT_FOUND);
2018-01-02 22:09:02 +01:00
}
2018-06-08 04:46:38 +02:00
#[test]
fn test_filter() {
let mut srv = TestServer::with_factory(|| {
App::new()
.filter(pred::Get())
.handler("/test", |_| HttpResponse::Ok())
});
let request = srv.get().uri(srv.url("/test")).finish().unwrap();
let response = srv.execute(request.send()).unwrap();
assert_eq!(response.status(), StatusCode::OK);
let request = srv.post().uri(srv.url("/test")).finish().unwrap();
let response = srv.execute(request.send()).unwrap();
assert_eq!(response.status(), StatusCode::NOT_FOUND);
}
#[test]
fn test_option_responder() {
let mut app = App::new()
.resource("/none", |r| r.f(|_| -> Option<&'static str> { None }))
.resource("/some", |r| r.f(|_| Some("some")))
.finish();
let req = TestRequest::with_uri("/none").finish();
let resp = app.run(req);
assert_eq!(resp.as_msg().status(), StatusCode::NOT_FOUND);
let req = TestRequest::with_uri("/some").finish();
let resp = app.run(req);
assert_eq!(resp.as_msg().status(), StatusCode::OK);
2018-06-18 01:45:54 +02:00
assert_eq!(resp.as_msg().body(), &Body::Binary(Binary::Slice(b"some")));
}
2017-12-06 22:02:53 +01:00
}