1
0
Fork 0
mirror of https://gitlab.com/msrd0/gotham-restful.git synced 2025-04-19 22:44:38 +00:00
deprecated-gotham-restful/src/routing.rs

444 lines
13 KiB
Rust
Raw Normal View History

2019-09-29 21:15:22 +02:00
#[cfg(feature = "openapi")]
use crate::openapi::{
2020-05-03 19:17:55 +02:00
builder::{OpenapiBuilder, OpenapiInfo},
router::OpenapiRouter
};
#[cfg(feature = "cors")]
use crate::CorsRoute;
use crate::{
2021-01-01 18:03:31 +01:00
resource::{
Resource, ResourceChange, ResourceChangeAll, ResourceCreate, ResourceRead, ResourceReadAll, ResourceRemove,
ResourceRemoveAll, ResourceSearch
},
result::{ResourceError, ResourceResult},
RequestBody, Response, StatusCode
};
2019-09-29 21:15:22 +02:00
use futures_util::{future, future::FutureExt};
2019-09-26 17:24:40 +02:00
use gotham::{
handler::{HandlerError, HandlerFuture},
2019-10-20 14:49:53 +00:00
helpers::http::response::{create_empty_response, create_response},
hyper::{body::to_bytes, header::CONTENT_TYPE, Body, HeaderMap, Method},
2019-09-26 17:24:40 +02:00
pipeline::chain::PipelineHandleChain,
2019-10-20 14:49:53 +00:00
router::{
2021-01-01 18:03:31 +01:00
builder::{DefineSingleRoute, DrawRoutes, ExtendRouteMatcher, RouterBuilder, ScopeBuilder},
2019-10-20 14:49:53 +00:00
non_match::RouteNonMatch,
2020-05-20 09:33:12 +02:00
route::matcher::{AcceptHeaderRouteMatcher, ContentTypeHeaderRouteMatcher, RouteMatcher}
2019-10-20 14:49:53 +00:00
},
2019-09-27 16:36:38 +02:00
state::{FromState, State}
2019-09-26 17:24:40 +02:00
};
2019-10-20 14:49:53 +00:00
use mime::{Mime, APPLICATION_JSON};
use std::{future::Future, panic::RefUnwindSafe, pin::Pin};
2019-09-26 17:24:40 +02:00
2019-09-27 16:36:38 +02:00
/// Allow us to extract an id from a path.
#[derive(Deserialize, StateData, StaticResponseExtender)]
struct PathExtractor<ID: RefUnwindSafe + Send + 'static> {
id: ID
2019-09-27 16:36:38 +02:00
}
2019-09-29 21:15:22 +02:00
/// This trait adds the `with_openapi` method to gotham's routing. It turns the default
/// router into one that will only allow RESTful resources, but record them and generate
/// an OpenAPI specification on request.
#[cfg(feature = "openapi")]
pub trait WithOpenapi<D> {
fn with_openapi<F>(&mut self, info: OpenapiInfo, block: F)
2019-09-29 21:15:22 +02:00
where
F: FnOnce(OpenapiRouter<'_, D>);
2019-09-29 21:15:22 +02:00
}
2019-09-26 17:42:28 +02:00
/// This trait adds the `resource` method to gotham's routing. It allows you to register
2020-11-22 23:55:52 +01:00
/// any RESTful [Resource] with a path.
pub trait DrawResources {
fn resource<R: Resource>(&mut self, path: &str);
2019-09-26 17:42:28 +02:00
}
/// This trait allows to draw routes within an resource. Use this only inside the
2020-11-22 23:55:52 +01:00
/// [Resource::setup] method.
pub trait DrawResourceRoutes {
fn read_all<Handler: ResourceReadAll>(&mut self);
fn read<Handler: ResourceRead>(&mut self);
fn search<Handler: ResourceSearch>(&mut self);
fn create<Handler: ResourceCreate>(&mut self)
2020-04-14 21:17:12 +02:00
where
Handler::Res: 'static,
Handler::Body: 'static;
fn change_all<Handler: ResourceChangeAll>(&mut self)
2020-04-14 21:17:12 +02:00
where
Handler::Res: 'static,
Handler::Body: 'static;
fn change<Handler: ResourceChange>(&mut self)
2020-04-14 21:17:12 +02:00
where
Handler::Res: 'static,
Handler::Body: 'static;
fn remove_all<Handler: ResourceRemoveAll>(&mut self);
fn remove<Handler: ResourceRemove>(&mut self);
2019-09-26 17:24:40 +02:00
}
fn response_from(res: Response, state: &State) -> gotham::hyper::Response<Body> {
2019-10-20 14:49:53 +00:00
let mut r = create_empty_response(state, res.status);
2021-01-14 18:37:51 +01:00
let headers = r.headers_mut();
if let Some(mime) = res.mime {
2021-01-14 18:37:51 +01:00
headers.insert(CONTENT_TYPE, mime.as_ref().parse().unwrap());
}
let mut last_name = None;
for (name, value) in res.headers {
if name.is_some() {
last_name = name;
}
// this unwrap is safe: the first item will always be Some
let name = last_name.clone().unwrap();
headers.insert(name, value);
2019-10-20 14:49:53 +00:00
}
2020-05-13 19:10:53 +02:00
let method = Method::borrow_from(state);
if method != Method::HEAD {
2019-10-20 14:49:53 +00:00
*r.body_mut() = res.body;
}
2020-05-13 19:10:53 +02:00
#[cfg(feature = "cors")]
crate::cors::handle_cors(state, &mut r);
2019-10-20 14:49:53 +00:00
r
}
async fn to_handler_future<F, R>(
state: State,
get_result: F
) -> Result<(State, gotham::hyper::Response<Body>), (State, HandlerError)>
2019-09-26 17:24:40 +02:00
where
F: FnOnce(State) -> Pin<Box<dyn Future<Output = (State, R)> + Send>>,
R: ResourceResult
2020-04-14 21:17:12 +02:00
{
2020-04-15 21:07:33 +02:00
let (state, res) = get_result(state).await;
2020-04-15 20:55:25 +02:00
let res = res.into_response().await;
match res {
Ok(res) => {
let r = response_from(res, &state);
Ok((state, r))
},
Err(e) => Err((state, e.into()))
2020-04-15 20:55:25 +02:00
}
2020-04-14 21:17:12 +02:00
}
async fn body_to_res<B, F, R>(
mut state: State,
get_result: F
) -> (State, Result<gotham::hyper::Response<Body>, HandlerError>)
2020-04-14 21:17:12 +02:00
where
B: RequestBody,
F: FnOnce(State, B) -> Pin<Box<dyn Future<Output = (State, R)> + Send>>,
R: ResourceResult
2019-09-26 17:24:40 +02:00
{
2020-04-14 21:17:12 +02:00
let body = to_bytes(Body::take_from(&mut state)).await;
2020-04-14 21:17:12 +02:00
let body = match body {
Ok(body) => body,
Err(e) => return (state, Err(e.into()))
2020-04-14 21:17:12 +02:00
};
let content_type: Mime = match HeaderMap::borrow_from(&state).get(CONTENT_TYPE) {
2020-04-14 21:17:12 +02:00
Some(content_type) => content_type.to_str().unwrap().parse().unwrap(),
None => {
let res = create_empty_response(&state, StatusCode::UNSUPPORTED_MEDIA_TYPE);
return (state, Ok(res));
2020-04-14 21:17:12 +02:00
}
};
2020-04-14 21:17:12 +02:00
let res = {
let body = match B::from_body(body, content_type) {
Ok(body) => body,
2020-04-14 22:40:27 +02:00
Err(e) => {
let error: ResourceError = e.into();
2020-04-14 22:40:27 +02:00
let res = match serde_json::to_string(&error) {
2020-04-14 21:17:12 +02:00
Ok(json) => {
let res = create_response(&state, StatusCode::BAD_REQUEST, APPLICATION_JSON, json);
Ok(res)
},
Err(e) => Err(e.into())
2020-04-14 22:40:27 +02:00
};
return (state, res);
2020-04-14 21:17:12 +02:00
}
};
2020-04-15 21:07:33 +02:00
get_result(state, body)
2020-04-14 21:17:12 +02:00
};
2020-04-15 21:07:33 +02:00
let (state, res) = res.await;
2020-04-15 20:55:25 +02:00
let res = res.into_response().await;
2020-04-15 20:55:25 +02:00
let res = match res {
2019-10-20 14:49:53 +00:00
Ok(res) => {
let r = response_from(res, &state);
2020-04-14 21:17:12 +02:00
Ok(r)
2019-09-26 17:24:40 +02:00
},
Err(e) => Err(e.into())
2020-04-14 22:40:27 +02:00
};
(state, res)
2019-09-26 17:24:40 +02:00
}
fn handle_with_body<B, F, R>(state: State, get_result: F) -> Pin<Box<HandlerFuture>>
2019-09-27 17:43:01 +02:00
where
B: RequestBody + 'static,
F: FnOnce(State, B) -> Pin<Box<dyn Future<Output = (State, R)> + Send>> + Send + 'static,
R: ResourceResult + Send + 'static
2019-09-27 17:43:01 +02:00
{
2020-04-14 22:40:27 +02:00
body_to_res(state, get_result)
.then(|(state, res)| match res {
2020-04-14 21:17:12 +02:00
Ok(ok) => future::ok((state, ok)),
Err(err) => future::err((state, err))
})
.boxed()
2019-09-27 17:43:01 +02:00
}
fn read_all_handler<Handler: ResourceReadAll>(state: State) -> Pin<Box<HandlerFuture>> {
2020-04-15 20:55:25 +02:00
to_handler_future(state, |state| Handler::read_all(state)).boxed()
2019-09-26 17:24:40 +02:00
}
fn read_handler<Handler: ResourceRead>(state: State) -> Pin<Box<HandlerFuture>> {
2019-09-27 16:36:38 +02:00
let id = {
let path: &PathExtractor<Handler::ID> = PathExtractor::borrow_from(&state);
2019-09-27 16:36:38 +02:00
path.id.clone()
};
2020-04-15 20:55:25 +02:00
to_handler_future(state, |state| Handler::read(state, id)).boxed()
2019-09-27 16:36:38 +02:00
}
fn search_handler<Handler: ResourceSearch>(mut state: State) -> Pin<Box<HandlerFuture>> {
2020-04-06 16:20:08 +00:00
let query = Handler::Query::take_from(&mut state);
2020-04-15 20:55:25 +02:00
to_handler_future(state, |state| Handler::search(state, query)).boxed()
2019-10-13 17:43:42 +02:00
}
fn create_handler<Handler: ResourceCreate>(state: State) -> Pin<Box<HandlerFuture>>
2020-04-14 21:17:12 +02:00
where
Handler::Res: 'static,
Handler::Body: 'static
2019-09-27 17:43:01 +02:00
{
2020-04-06 16:20:08 +00:00
handle_with_body::<Handler::Body, _, _>(state, |state, body| Handler::create(state, body))
2019-09-27 17:43:01 +02:00
}
fn change_all_handler<Handler: ResourceChangeAll>(state: State) -> Pin<Box<HandlerFuture>>
2020-04-14 21:17:12 +02:00
where
Handler::Res: 'static,
Handler::Body: 'static
2019-09-27 21:33:24 +02:00
{
handle_with_body::<Handler::Body, _, _>(state, |state, body| Handler::change_all(state, body))
2019-09-27 21:33:24 +02:00
}
fn change_handler<Handler: ResourceChange>(state: State) -> Pin<Box<HandlerFuture>>
2020-04-14 21:17:12 +02:00
where
Handler::Res: 'static,
Handler::Body: 'static
2019-09-27 21:33:24 +02:00
{
let id = {
let path: &PathExtractor<Handler::ID> = PathExtractor::borrow_from(&state);
2019-09-27 21:33:24 +02:00
path.id.clone()
};
handle_with_body::<Handler::Body, _, _>(state, |state, body| Handler::change(state, id, body))
2019-09-27 21:33:24 +02:00
}
fn remove_all_handler<Handler: ResourceRemoveAll>(state: State) -> Pin<Box<HandlerFuture>> {
to_handler_future(state, |state| Handler::remove_all(state)).boxed()
2019-09-29 19:19:38 +02:00
}
fn remove_handler<Handler: ResourceRemove>(state: State) -> Pin<Box<HandlerFuture>> {
2019-09-29 19:19:38 +02:00
let id = {
let path: &PathExtractor<Handler::ID> = PathExtractor::borrow_from(&state);
2019-09-29 19:19:38 +02:00
path.id.clone()
};
to_handler_future(state, |state| Handler::remove(state, id)).boxed()
2019-09-29 19:19:38 +02:00
}
2019-10-20 14:49:53 +00:00
#[derive(Clone)]
struct MaybeMatchAcceptHeader {
matcher: Option<AcceptHeaderRouteMatcher>
2019-10-20 14:49:53 +00:00
}
impl RouteMatcher for MaybeMatchAcceptHeader {
fn is_match(&self, state: &State) -> Result<(), RouteNonMatch> {
2019-10-20 14:49:53 +00:00
match &self.matcher {
Some(matcher) => matcher.is_match(state),
None => Ok(())
}
}
}
impl From<Option<Vec<Mime>>> for MaybeMatchAcceptHeader {
fn from(types: Option<Vec<Mime>>) -> Self {
let types = match types {
Some(types) if types.is_empty() => None,
types => types
};
2019-10-20 14:49:53 +00:00
Self {
2020-05-20 09:33:12 +02:00
matcher: types.map(AcceptHeaderRouteMatcher::new)
2019-10-20 14:49:53 +00:00
}
}
}
#[derive(Clone)]
struct MaybeMatchContentTypeHeader {
matcher: Option<ContentTypeHeaderRouteMatcher>
2019-10-20 14:49:53 +00:00
}
impl RouteMatcher for MaybeMatchContentTypeHeader {
fn is_match(&self, state: &State) -> Result<(), RouteNonMatch> {
2019-10-20 14:49:53 +00:00
match &self.matcher {
Some(matcher) => matcher.is_match(state),
None => Ok(())
}
}
}
impl From<Option<Vec<Mime>>> for MaybeMatchContentTypeHeader {
fn from(types: Option<Vec<Mime>>) -> Self {
2019-10-20 14:49:53 +00:00
Self {
2020-05-20 09:33:12 +02:00
matcher: types.map(|types| ContentTypeHeaderRouteMatcher::new(types).allow_no_type())
2019-10-20 14:49:53 +00:00
}
}
}
2019-09-26 17:24:40 +02:00
macro_rules! implDrawResourceRoutes {
($implType:ident) => {
2019-09-29 21:15:22 +02:00
#[cfg(feature = "openapi")]
impl<'a, C, P> WithOpenapi<Self> for $implType<'a, C, P>
where
C: PipelineHandleChain<P> + Copy + Send + Sync + 'static,
P: RefUnwindSafe + Send + Sync + 'static
2019-09-29 21:15:22 +02:00
{
fn with_openapi<F>(&mut self, info: OpenapiInfo, block: F)
2019-09-29 21:15:22 +02:00
where
F: FnOnce(OpenapiRouter<'_, $implType<'a, C, P>>)
2019-09-29 21:15:22 +02:00
{
let router = OpenapiRouter {
router: self,
scope: None,
2020-05-03 19:17:55 +02:00
openapi_builder: &mut OpenapiBuilder::new(info)
};
block(router);
2019-09-29 21:15:22 +02:00
}
}
2019-09-26 17:42:28 +02:00
impl<'a, C, P> DrawResources for $implType<'a, C, P>
where
C: PipelineHandleChain<P> + Copy + Send + Sync + 'static,
P: RefUnwindSafe + Send + Sync + 'static
2019-09-26 17:42:28 +02:00
{
fn resource<R: Resource>(&mut self, path: &str) {
R::setup((self, path));
2019-09-26 17:42:28 +02:00
}
}
2019-10-13 23:36:10 +02:00
#[allow(clippy::redundant_closure)] // doesn't work because of type parameters
impl<'a, C, P> DrawResourceRoutes for (&mut $implType<'a, C, P>, &str)
2019-09-26 17:24:40 +02:00
where
C: PipelineHandleChain<P> + Copy + Send + Sync + 'static,
P: RefUnwindSafe + Send + Sync + 'static
2019-09-26 17:24:40 +02:00
{
fn read_all<Handler: ResourceReadAll>(&mut self) {
let matcher: MaybeMatchAcceptHeader = Handler::Res::accepted_types().into();
self.0
.get(&self.1)
2019-10-20 14:49:53 +00:00
.extend_route_matcher(matcher)
2020-04-06 16:20:08 +00:00
.to(|state| read_all_handler::<Handler>(state));
2019-09-27 16:36:38 +02:00
}
fn read<Handler: ResourceRead>(&mut self) {
let matcher: MaybeMatchAcceptHeader = Handler::Res::accepted_types().into();
self.0
.get(&format!("{}/:id", self.1))
2019-10-20 14:49:53 +00:00
.extend_route_matcher(matcher)
2020-04-06 16:20:08 +00:00
.with_path_extractor::<PathExtractor<Handler::ID>>()
.to(|state| read_handler::<Handler>(state));
2019-09-26 17:24:40 +02:00
}
fn search<Handler: ResourceSearch>(&mut self) {
let matcher: MaybeMatchAcceptHeader = Handler::Res::accepted_types().into();
self.0
.get(&format!("{}/search", self.1))
2019-10-20 14:49:53 +00:00
.extend_route_matcher(matcher)
2020-04-06 16:20:08 +00:00
.with_query_string_extractor::<Handler::Query>()
.to(|state| search_handler::<Handler>(state));
2019-10-13 17:43:42 +02:00
}
fn create<Handler: ResourceCreate>(&mut self)
2020-04-14 21:17:12 +02:00
where
Handler::Res: Send + 'static,
Handler::Body: 'static
2019-09-27 17:43:01 +02:00
{
let accept_matcher: MaybeMatchAcceptHeader = Handler::Res::accepted_types().into();
let content_matcher: MaybeMatchContentTypeHeader = Handler::Body::supported_types().into();
self.0
.post(&self.1)
2019-10-20 14:49:53 +00:00
.extend_route_matcher(accept_matcher)
.extend_route_matcher(content_matcher)
2020-04-06 16:20:08 +00:00
.to(|state| create_handler::<Handler>(state));
2020-05-14 23:30:59 +02:00
#[cfg(feature = "cors")]
self.0.cors(&self.1, Method::POST);
2019-09-27 17:43:01 +02:00
}
2019-09-27 21:33:24 +02:00
fn change_all<Handler: ResourceChangeAll>(&mut self)
2020-04-14 21:17:12 +02:00
where
Handler::Res: Send + 'static,
Handler::Body: 'static
2019-09-27 21:33:24 +02:00
{
let accept_matcher: MaybeMatchAcceptHeader = Handler::Res::accepted_types().into();
let content_matcher: MaybeMatchContentTypeHeader = Handler::Body::supported_types().into();
self.0
.put(&self.1)
2019-10-20 14:49:53 +00:00
.extend_route_matcher(accept_matcher)
.extend_route_matcher(content_matcher)
.to(|state| change_all_handler::<Handler>(state));
2020-05-14 23:30:59 +02:00
#[cfg(feature = "cors")]
self.0.cors(&self.1, Method::PUT);
2019-09-27 21:33:24 +02:00
}
fn change<Handler: ResourceChange>(&mut self)
2020-04-14 21:17:12 +02:00
where
Handler::Res: Send + 'static,
Handler::Body: 'static
2019-09-27 21:33:24 +02:00
{
let accept_matcher: MaybeMatchAcceptHeader = Handler::Res::accepted_types().into();
let content_matcher: MaybeMatchContentTypeHeader = Handler::Body::supported_types().into();
2020-05-14 23:30:59 +02:00
let path = format!("{}/:id", self.1);
self.0
.put(&path)
2019-10-20 14:49:53 +00:00
.extend_route_matcher(accept_matcher)
.extend_route_matcher(content_matcher)
2020-04-06 16:20:08 +00:00
.with_path_extractor::<PathExtractor<Handler::ID>>()
.to(|state| change_handler::<Handler>(state));
2020-05-14 23:30:59 +02:00
#[cfg(feature = "cors")]
self.0.cors(&path, Method::PUT);
2019-09-27 21:33:24 +02:00
}
2019-09-29 19:19:38 +02:00
fn remove_all<Handler: ResourceRemoveAll>(&mut self) {
let matcher: MaybeMatchAcceptHeader = Handler::Res::accepted_types().into();
self.0
.delete(&self.1)
2019-10-20 14:49:53 +00:00
.extend_route_matcher(matcher)
.to(|state| remove_all_handler::<Handler>(state));
2020-05-14 23:30:59 +02:00
#[cfg(feature = "cors")]
self.0.cors(&self.1, Method::DELETE);
2019-09-29 19:19:38 +02:00
}
fn remove<Handler: ResourceRemove>(&mut self) {
let matcher: MaybeMatchAcceptHeader = Handler::Res::accepted_types().into();
2020-05-14 23:30:59 +02:00
let path = format!("{}/:id", self.1);
self.0
.delete(&path)
2019-10-20 14:49:53 +00:00
.extend_route_matcher(matcher)
2020-04-06 16:20:08 +00:00
.with_path_extractor::<PathExtractor<Handler::ID>>()
.to(|state| remove_handler::<Handler>(state));
2020-05-14 23:30:59 +02:00
#[cfg(feature = "cors")]
self.0.cors(&path, Method::POST);
2019-09-29 19:19:38 +02:00
}
2019-09-26 17:24:40 +02:00
}
};
2019-09-26 17:24:40 +02:00
}
implDrawResourceRoutes!(RouterBuilder);
implDrawResourceRoutes!(ScopeBuilder);