mirror of
https://gitlab.com/msrd0/gotham-restful.git
synced 2025-04-19 22:44:38 +00:00
430 lines
12 KiB
Rust
430 lines
12 KiB
Rust
#[cfg(feature = "openapi")]
|
|
use crate::openapi::{
|
|
builder::{OpenapiBuilder, OpenapiInfo},
|
|
router::OpenapiRouter
|
|
};
|
|
#[cfg(feature = "cors")]
|
|
use crate::CorsRoute;
|
|
use crate::{
|
|
resource::*,
|
|
result::{ResourceError, ResourceResult},
|
|
RequestBody, Response, StatusCode
|
|
};
|
|
|
|
use futures_util::{future, future::FutureExt};
|
|
use gotham::{
|
|
handler::{HandlerError, HandlerFuture},
|
|
helpers::http::response::{create_empty_response, create_response},
|
|
hyper::{body::to_bytes, header::CONTENT_TYPE, Body, HeaderMap, Method},
|
|
pipeline::chain::PipelineHandleChain,
|
|
router::{
|
|
builder::*,
|
|
non_match::RouteNonMatch,
|
|
route::matcher::{AcceptHeaderRouteMatcher, ContentTypeHeaderRouteMatcher, RouteMatcher}
|
|
},
|
|
state::{FromState, State}
|
|
};
|
|
use mime::{Mime, APPLICATION_JSON};
|
|
use std::{future::Future, panic::RefUnwindSafe, pin::Pin};
|
|
|
|
/// Allow us to extract an id from a path.
|
|
#[derive(Deserialize, StateData, StaticResponseExtender)]
|
|
struct PathExtractor<ID: RefUnwindSafe + Send + 'static> {
|
|
id: ID
|
|
}
|
|
|
|
/// 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)
|
|
where
|
|
F: FnOnce(OpenapiRouter<'_, D>);
|
|
}
|
|
|
|
/// This trait adds the `resource` method to gotham's routing. It allows you to register
|
|
/// any RESTful `Resource` with a path.
|
|
pub trait DrawResources {
|
|
fn resource<R: Resource>(&mut self, path: &str);
|
|
}
|
|
|
|
/// This trait allows to draw routes within an resource. Use this only inside the
|
|
/// `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)
|
|
where
|
|
Handler::Res: 'static,
|
|
Handler::Body: 'static;
|
|
|
|
fn change_all<Handler: ResourceChangeAll>(&mut self)
|
|
where
|
|
Handler::Res: 'static,
|
|
Handler::Body: 'static;
|
|
|
|
fn change<Handler: ResourceChange>(&mut self)
|
|
where
|
|
Handler::Res: 'static,
|
|
Handler::Body: 'static;
|
|
|
|
fn remove_all<Handler: ResourceRemoveAll>(&mut self);
|
|
|
|
fn remove<Handler: ResourceRemove>(&mut self);
|
|
}
|
|
|
|
fn response_from(res: Response, state: &State) -> gotham::hyper::Response<Body> {
|
|
let mut r = create_empty_response(state, res.status);
|
|
if let Some(mime) = res.mime {
|
|
r.headers_mut().insert(CONTENT_TYPE, mime.as_ref().parse().unwrap());
|
|
}
|
|
|
|
let method = Method::borrow_from(state);
|
|
if method != Method::HEAD {
|
|
*r.body_mut() = res.body;
|
|
}
|
|
|
|
#[cfg(feature = "cors")]
|
|
crate::cors::handle_cors(state, &mut r);
|
|
|
|
r
|
|
}
|
|
|
|
async fn to_handler_future<F, R>(
|
|
state: State,
|
|
get_result: F
|
|
) -> Result<(State, gotham::hyper::Response<Body>), (State, HandlerError)>
|
|
where
|
|
F: FnOnce(State) -> Pin<Box<dyn Future<Output = (State, R)> + Send>>,
|
|
R: ResourceResult
|
|
{
|
|
let (state, res) = get_result(state).await;
|
|
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()))
|
|
}
|
|
}
|
|
|
|
async fn body_to_res<B, F, R>(
|
|
mut state: State,
|
|
get_result: F
|
|
) -> (State, Result<gotham::hyper::Response<Body>, HandlerError>)
|
|
where
|
|
B: RequestBody,
|
|
F: FnOnce(State, B) -> Pin<Box<dyn Future<Output = (State, R)> + Send>>,
|
|
R: ResourceResult
|
|
{
|
|
let body = to_bytes(Body::take_from(&mut state)).await;
|
|
|
|
let body = match body {
|
|
Ok(body) => body,
|
|
Err(e) => return (state, Err(e.into()))
|
|
};
|
|
|
|
let content_type: Mime = match HeaderMap::borrow_from(&state).get(CONTENT_TYPE) {
|
|
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));
|
|
}
|
|
};
|
|
|
|
let res = {
|
|
let body = match B::from_body(body, content_type) {
|
|
Ok(body) => body,
|
|
Err(e) => {
|
|
let error: ResourceError = e.into();
|
|
let res = match serde_json::to_string(&error) {
|
|
Ok(json) => {
|
|
let res = create_response(&state, StatusCode::BAD_REQUEST, APPLICATION_JSON, json);
|
|
Ok(res)
|
|
},
|
|
Err(e) => Err(e.into())
|
|
};
|
|
return (state, res);
|
|
}
|
|
};
|
|
get_result(state, body)
|
|
};
|
|
|
|
let (state, res) = res.await;
|
|
let res = res.into_response().await;
|
|
|
|
let res = match res {
|
|
Ok(res) => {
|
|
let r = response_from(res, &state);
|
|
Ok(r)
|
|
},
|
|
Err(e) => Err(e.into())
|
|
};
|
|
(state, res)
|
|
}
|
|
|
|
fn handle_with_body<B, F, R>(state: State, get_result: F) -> Pin<Box<HandlerFuture>>
|
|
where
|
|
B: RequestBody + 'static,
|
|
F: FnOnce(State, B) -> Pin<Box<dyn Future<Output = (State, R)> + Send>> + Send + 'static,
|
|
R: ResourceResult + Send + 'static
|
|
{
|
|
body_to_res(state, get_result)
|
|
.then(|(state, res)| match res {
|
|
Ok(ok) => future::ok((state, ok)),
|
|
Err(err) => future::err((state, err))
|
|
})
|
|
.boxed()
|
|
}
|
|
|
|
fn read_all_handler<Handler: ResourceReadAll>(state: State) -> Pin<Box<HandlerFuture>> {
|
|
to_handler_future(state, |state| Handler::read_all(state)).boxed()
|
|
}
|
|
|
|
fn read_handler<Handler: ResourceRead>(state: State) -> Pin<Box<HandlerFuture>> {
|
|
let id = {
|
|
let path: &PathExtractor<Handler::ID> = PathExtractor::borrow_from(&state);
|
|
path.id.clone()
|
|
};
|
|
to_handler_future(state, |state| Handler::read(state, id)).boxed()
|
|
}
|
|
|
|
fn search_handler<Handler: ResourceSearch>(mut state: State) -> Pin<Box<HandlerFuture>> {
|
|
let query = Handler::Query::take_from(&mut state);
|
|
to_handler_future(state, |state| Handler::search(state, query)).boxed()
|
|
}
|
|
|
|
fn create_handler<Handler: ResourceCreate>(state: State) -> Pin<Box<HandlerFuture>>
|
|
where
|
|
Handler::Res: 'static,
|
|
Handler::Body: 'static
|
|
{
|
|
handle_with_body::<Handler::Body, _, _>(state, |state, body| Handler::create(state, body))
|
|
}
|
|
|
|
fn change_all_handler<Handler: ResourceChangeAll>(state: State) -> Pin<Box<HandlerFuture>>
|
|
where
|
|
Handler::Res: 'static,
|
|
Handler::Body: 'static
|
|
{
|
|
handle_with_body::<Handler::Body, _, _>(state, |state, body| Handler::change_all(state, body))
|
|
}
|
|
|
|
fn change_handler<Handler: ResourceChange>(state: State) -> Pin<Box<HandlerFuture>>
|
|
where
|
|
Handler::Res: 'static,
|
|
Handler::Body: 'static
|
|
{
|
|
let id = {
|
|
let path: &PathExtractor<Handler::ID> = PathExtractor::borrow_from(&state);
|
|
path.id.clone()
|
|
};
|
|
handle_with_body::<Handler::Body, _, _>(state, |state, body| Handler::change(state, id, body))
|
|
}
|
|
|
|
fn remove_all_handler<Handler: ResourceRemoveAll>(state: State) -> Pin<Box<HandlerFuture>> {
|
|
to_handler_future(state, |state| Handler::remove_all(state)).boxed()
|
|
}
|
|
|
|
fn remove_handler<Handler: ResourceRemove>(state: State) -> Pin<Box<HandlerFuture>> {
|
|
let id = {
|
|
let path: &PathExtractor<Handler::ID> = PathExtractor::borrow_from(&state);
|
|
path.id.clone()
|
|
};
|
|
to_handler_future(state, |state| Handler::remove(state, id)).boxed()
|
|
}
|
|
|
|
#[derive(Clone)]
|
|
struct MaybeMatchAcceptHeader {
|
|
matcher: Option<AcceptHeaderRouteMatcher>
|
|
}
|
|
|
|
impl RouteMatcher for MaybeMatchAcceptHeader {
|
|
fn is_match(&self, state: &State) -> Result<(), RouteNonMatch> {
|
|
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
|
|
};
|
|
Self {
|
|
matcher: types.map(AcceptHeaderRouteMatcher::new)
|
|
}
|
|
}
|
|
}
|
|
|
|
#[derive(Clone)]
|
|
struct MaybeMatchContentTypeHeader {
|
|
matcher: Option<ContentTypeHeaderRouteMatcher>
|
|
}
|
|
|
|
impl RouteMatcher for MaybeMatchContentTypeHeader {
|
|
fn is_match(&self, state: &State) -> Result<(), RouteNonMatch> {
|
|
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 {
|
|
Self {
|
|
matcher: types.map(|types| ContentTypeHeaderRouteMatcher::new(types).allow_no_type())
|
|
}
|
|
}
|
|
}
|
|
|
|
macro_rules! implDrawResourceRoutes {
|
|
($implType:ident) => {
|
|
#[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
|
|
{
|
|
fn with_openapi<F>(&mut self, info: OpenapiInfo, block: F)
|
|
where
|
|
F: FnOnce(OpenapiRouter<'_, $implType<'a, C, P>>)
|
|
{
|
|
let router = OpenapiRouter {
|
|
router: self,
|
|
scope: None,
|
|
openapi_builder: &mut OpenapiBuilder::new(info)
|
|
};
|
|
block(router);
|
|
}
|
|
}
|
|
|
|
impl<'a, C, P> DrawResources for $implType<'a, C, P>
|
|
where
|
|
C: PipelineHandleChain<P> + Copy + Send + Sync + 'static,
|
|
P: RefUnwindSafe + Send + Sync + 'static
|
|
{
|
|
fn resource<R: Resource>(&mut self, path: &str) {
|
|
R::setup((self, path));
|
|
}
|
|
}
|
|
|
|
#[allow(clippy::redundant_closure)] // doesn't work because of type parameters
|
|
impl<'a, C, P> DrawResourceRoutes for (&mut $implType<'a, C, P>, &str)
|
|
where
|
|
C: PipelineHandleChain<P> + Copy + Send + Sync + 'static,
|
|
P: RefUnwindSafe + Send + Sync + 'static
|
|
{
|
|
fn read_all<Handler: ResourceReadAll>(&mut self) {
|
|
let matcher: MaybeMatchAcceptHeader = Handler::Res::accepted_types().into();
|
|
self.0
|
|
.get(&self.1)
|
|
.extend_route_matcher(matcher)
|
|
.to(|state| read_all_handler::<Handler>(state));
|
|
}
|
|
|
|
fn read<Handler: ResourceRead>(&mut self) {
|
|
let matcher: MaybeMatchAcceptHeader = Handler::Res::accepted_types().into();
|
|
self.0
|
|
.get(&format!("{}/:id", self.1))
|
|
.extend_route_matcher(matcher)
|
|
.with_path_extractor::<PathExtractor<Handler::ID>>()
|
|
.to(|state| read_handler::<Handler>(state));
|
|
}
|
|
|
|
fn search<Handler: ResourceSearch>(&mut self) {
|
|
let matcher: MaybeMatchAcceptHeader = Handler::Res::accepted_types().into();
|
|
self.0
|
|
.get(&format!("{}/search", self.1))
|
|
.extend_route_matcher(matcher)
|
|
.with_query_string_extractor::<Handler::Query>()
|
|
.to(|state| search_handler::<Handler>(state));
|
|
}
|
|
|
|
fn create<Handler: ResourceCreate>(&mut self)
|
|
where
|
|
Handler::Res: Send + 'static,
|
|
Handler::Body: 'static
|
|
{
|
|
let accept_matcher: MaybeMatchAcceptHeader = Handler::Res::accepted_types().into();
|
|
let content_matcher: MaybeMatchContentTypeHeader = Handler::Body::supported_types().into();
|
|
self.0
|
|
.post(&self.1)
|
|
.extend_route_matcher(accept_matcher)
|
|
.extend_route_matcher(content_matcher)
|
|
.to(|state| create_handler::<Handler>(state));
|
|
#[cfg(feature = "cors")]
|
|
self.0.cors(&self.1, Method::POST);
|
|
}
|
|
|
|
fn change_all<Handler: ResourceChangeAll>(&mut self)
|
|
where
|
|
Handler::Res: Send + 'static,
|
|
Handler::Body: 'static
|
|
{
|
|
let accept_matcher: MaybeMatchAcceptHeader = Handler::Res::accepted_types().into();
|
|
let content_matcher: MaybeMatchContentTypeHeader = Handler::Body::supported_types().into();
|
|
self.0
|
|
.put(&self.1)
|
|
.extend_route_matcher(accept_matcher)
|
|
.extend_route_matcher(content_matcher)
|
|
.to(|state| change_all_handler::<Handler>(state));
|
|
#[cfg(feature = "cors")]
|
|
self.0.cors(&self.1, Method::PUT);
|
|
}
|
|
|
|
fn change<Handler: ResourceChange>(&mut self)
|
|
where
|
|
Handler::Res: Send + 'static,
|
|
Handler::Body: 'static
|
|
{
|
|
let accept_matcher: MaybeMatchAcceptHeader = Handler::Res::accepted_types().into();
|
|
let content_matcher: MaybeMatchContentTypeHeader = Handler::Body::supported_types().into();
|
|
let path = format!("{}/:id", self.1);
|
|
self.0
|
|
.put(&path)
|
|
.extend_route_matcher(accept_matcher)
|
|
.extend_route_matcher(content_matcher)
|
|
.with_path_extractor::<PathExtractor<Handler::ID>>()
|
|
.to(|state| change_handler::<Handler>(state));
|
|
#[cfg(feature = "cors")]
|
|
self.0.cors(&path, Method::PUT);
|
|
}
|
|
|
|
fn remove_all<Handler: ResourceRemoveAll>(&mut self) {
|
|
let matcher: MaybeMatchAcceptHeader = Handler::Res::accepted_types().into();
|
|
self.0
|
|
.delete(&self.1)
|
|
.extend_route_matcher(matcher)
|
|
.to(|state| remove_all_handler::<Handler>(state));
|
|
#[cfg(feature = "cors")]
|
|
self.0.cors(&self.1, Method::DELETE);
|
|
}
|
|
|
|
fn remove<Handler: ResourceRemove>(&mut self) {
|
|
let matcher: MaybeMatchAcceptHeader = Handler::Res::accepted_types().into();
|
|
let path = format!("{}/:id", self.1);
|
|
self.0
|
|
.delete(&path)
|
|
.extend_route_matcher(matcher)
|
|
.with_path_extractor::<PathExtractor<Handler::ID>>()
|
|
.to(|state| remove_handler::<Handler>(state));
|
|
#[cfg(feature = "cors")]
|
|
self.0.cors(&path, Method::POST);
|
|
}
|
|
}
|
|
};
|
|
}
|
|
|
|
implDrawResourceRoutes!(RouterBuilder);
|
|
implDrawResourceRoutes!(ScopeBuilder);
|