[proxmox-backup.git] / src / server / h2service.rs

use anyhow::{Error};

use std::collections::HashMap;
use std::pin::Pin;
use std::sync::Arc;
use std::task::{Context, Poll};

use futures::*;
use hyper::{Body, Request, Response, StatusCode};

use proxmox::api::{ApiResponseFuture, HttpError, Router, RpcEnvironment};
use proxmox::http_err;

use crate::tools;
use crate::server::formatter::*;
use crate::server::WorkerTask;

/// Hyper Service implementation to handle stateful H2 connections.
///
/// We use this kind of service to handle backup protocol
/// connections. State is stored inside the generic ``rpcenv``. Logs
/// goes into the ``WorkerTask`` log.
pub struct H2Service<E> {
    router: &'static Router,
    rpcenv: E,
    worker: Arc<WorkerTask>,
    debug: bool,
}

impl <E: RpcEnvironment + Clone> H2Service<E> {

    pub fn new(rpcenv: E, worker: Arc<WorkerTask>, router: &'static Router, debug: bool) -> Self {
        Self { rpcenv, worker, router, debug }
    }

    pub fn debug<S: AsRef<str>>(&self, msg: S) {
        if self.debug { self.worker.log(msg); }
    }

    fn handle_request(&self, req: Request<Body>) -> ApiResponseFuture {

        let (parts, body) = req.into_parts();

        let method = parts.method.clone();

        let (path, components) = match tools::normalize_uri_path(parts.uri.path()) {
            Ok((p,c)) => (p, c),
            Err(err) => return future::err(http_err!(BAD_REQUEST, "{}", err)).boxed(),
        };

        self.debug(format!("{} {}", method, path));

        let mut uri_param = HashMap::new();

        let formatter = &JSON_FORMATTER;

        match self.router.find_method(&components, method, &mut uri_param) {
            None => {
                let err = http_err!(NOT_FOUND, "Path '{}' not found.", path);
                future::ok((formatter.format_error)(err)).boxed()
            }
            Some(api_method) => {
                crate::server::rest::handle_api_request(
                    self.rpcenv.clone(), api_method, formatter, parts, body, uri_param).boxed()
            }
        }
    }

    fn log_response(worker: Arc<WorkerTask>, method: hyper::Method, path: &str, resp: &Response<Body>) {

        let status = resp.status();

        if !status.is_success() {
            let reason = status.canonical_reason().unwrap_or("unknown reason");

            let mut message = "request failed";
            if let Some(data) = resp.extensions().get::<ErrorMessageExtension>() {
                message = &data.0;
            }

            worker.log(format!("{} {}: {} {}: {}", method.as_str(), path, status.as_str(), reason, message));
        }
    }
}

impl <E: RpcEnvironment + Clone> tower_service::Service<Request<Body>> for H2Service<E> {
    type Response = Response<Body>;
    type Error = Error;
    #[allow(clippy::type_complexity)]
    type Future = Pin<Box<dyn Future<Output = Result<Self::Response, Self::Error>> + Send>>;

    fn poll_ready(&mut self, _cx: &mut Context) -> Poll<Result<(), Self::Error>> {
        Poll::Ready(Ok(()))
    }

    fn call(&mut self, req: Request<Body>) -> Self::Future {
        let path = req.uri().path().to_owned();
        let method = req.method().clone();
        let worker = self.worker.clone();

        self.handle_request(req)
            .map(move |result| match result {
                Ok(res) => {
                    Self::log_response(worker, method, &path, &res);
                    Ok::<_, Error>(res)
                }
                Err(err) => {
                     if let Some(apierr) = err.downcast_ref::<HttpError>() {
                        let mut resp = Response::new(Body::from(apierr.message.clone()));
                        resp.extensions_mut().insert(ErrorMessageExtension(apierr.message.clone()));
                        *resp.status_mut() = apierr.code;
                        Self::log_response(worker, method, &path, &resp);
                        Ok(resp)
                    } else {
                        let mut resp = Response::new(Body::from(err.to_string()));
                        resp.extensions_mut().insert(ErrorMessageExtension(err.to_string()));
                        *resp.status_mut() = StatusCode::BAD_REQUEST;
                        Self::log_response(worker, method, &path, &resp);
                        Ok(resp)
                    }
                }
            })
            .boxed()
    }
}
Commit	Line	Data
f7d4e4b5	1	use anyhow::{Error};
bd1507c4 DM	2
bd1507c4 DM	3	use std::collections::HashMap;
12e874ce	4	use std::pin::Pin;
bd1507c4	5	use std::sync::Arc;
b9b7f7ec	6	use std::task::{Context, Poll};
bd1507c4 DM	7
	8	use futures::*;
	9	use hyper::{Body, Request, Response, StatusCode};
	10
9ea4bce4 WB	11	use proxmox::api::{ApiResponseFuture, HttpError, Router, RpcEnvironment};
9ea4bce4 WB	12	use proxmox::http_err;
3d482025	13
bd1507c4	14	use crate::tools;
bd1507c4 DM	15	use crate::server::formatter::*;
	16	use crate::server::WorkerTask;
	17
42a87f7b DM	18	/// Hyper Service implementation to handle stateful H2 connections.
	19	///
	20	/// We use this kind of service to handle backup protocol
	21	/// connections. State is stored inside the generic ``rpcenv``. Logs
	22	/// goes into the ``WorkerTask`` log.
	23	pub struct H2Service<E> {
	24	router: &'static Router,
	25	rpcenv: E,
bd1507c4	26	worker: Arc<WorkerTask>,
a42d1f55	27	debug: bool,
bd1507c4 DM	28	}
bd1507c4 DM	29
42a87f7b	30	impl <E: RpcEnvironment + Clone> H2Service<E> {
bd1507c4	31
42a87f7b DM	32	pub fn new(rpcenv: E, worker: Arc<WorkerTask>, router: &'static Router, debug: bool) -> Self {
42a87f7b DM	33	Self { rpcenv, worker, router, debug }
a42d1f55 DM	34	}
	35
	36	pub fn debug<S: AsRef<str>>(&self, msg: S) {
	37	if self.debug { self.worker.log(msg); }
bd1507c4 DM	38	}
bd1507c4 DM	39
bb084b9c	40	fn handle_request(&self, req: Request<Body>) -> ApiResponseFuture {
bd1507c4 DM	41
	42	let (parts, body) = req.into_parts();
	43
	44	let method = parts.method.clone();
	45
	46	let (path, components) = match tools::normalize_uri_path(parts.uri.path()) {
	47	Ok((p,c)) => (p, c),
8aa67ee7	48	Err(err) => return future::err(http_err!(BAD_REQUEST, "{}", err)).boxed(),
bd1507c4 DM	49	};
bd1507c4 DM	50
39e60bd6	51	self.debug(format!("{} {}", method, path));
bd1507c4 DM	52
	53	let mut uri_param = HashMap::new();
	54
42a87f7b DM	55	let formatter = &JSON_FORMATTER;
	56
	57	match self.router.find_method(&components, method, &mut uri_param) {
255f378a	58	None => {
8aa67ee7	59	let err = http_err!(NOT_FOUND, "Path '{}' not found.", path);
ad51d02a	60	future::ok((formatter.format_error)(err)).boxed()
bd1507c4	61	}
255f378a	62	Some(api_method) => {
70fbac84 DM	63	crate::server::rest::handle_api_request(
70fbac84 DM	64	self.rpcenv.clone(), api_method, formatter, parts, body, uri_param).boxed()
bd1507c4 DM	65	}
	66	}
	67	}
	68
	69	fn log_response(worker: Arc<WorkerTask>, method: hyper::Method, path: &str, resp: &Response<Body>) {
	70
	71	let status = resp.status();
	72
	73	if !status.is_success() {
	74	let reason = status.canonical_reason().unwrap_or("unknown reason");
	75
	76	let mut message = "request failed";
	77	if let Some(data) = resp.extensions().get::<ErrorMessageExtension>() {
	78	message = &data.0;
	79	}
	80
	81	worker.log(format!("{} {}: {} {}: {}", method.as_str(), path, status.as_str(), reason, message));
	82	}
	83	}
	84	}
	85
b9b7f7ec WB	86	impl <E: RpcEnvironment + Clone> tower_service::Service<Request<Body>> for H2Service<E> {
b9b7f7ec WB	87	type Response = Response<Body>;
642322b4	88	type Error = Error;
12e874ce FG	89	#[allow(clippy::type_complexity)]
12e874ce FG	90	type Future = Pin<Box<dyn Future<Output = Result<Self::Response, Self::Error>> + Send>>;
bd1507c4	91
b9b7f7ec WB	92	fn poll_ready(&mut self, _cx: &mut Context) -> Poll<Result<(), Self::Error>> {
	93	Poll::Ready(Ok(()))
	94	}
	95
	96	fn call(&mut self, req: Request<Body>) -> Self::Future {
bd1507c4 DM	97	let path = req.uri().path().to_owned();
	98	let method = req.method().clone();
	99	let worker = self.worker.clone();
	100
44288184	101	self.handle_request(req)
b9b7f7ec	102	.map(move \|result\| match result {
bd1507c4 DM	103	Ok(res) => {
bd1507c4 DM	104	Self::log_response(worker, method, &path, &res);
642322b4	105	Ok::<_, Error>(res)
bd1507c4 DM	106	}
bd1507c4 DM	107	Err(err) => {
642322b4	108	if let Some(apierr) = err.downcast_ref::<HttpError>() {
bd1507c4	109	let mut resp = Response::new(Body::from(apierr.message.clone()));
907f5bb0	110	resp.extensions_mut().insert(ErrorMessageExtension(apierr.message.clone()));
bd1507c4 DM	111	*resp.status_mut() = apierr.code;
	112	Self::log_response(worker, method, &path, &resp);
	113	Ok(resp)
	114	} else {
	115	let mut resp = Response::new(Body::from(err.to_string()));
907f5bb0	116	resp.extensions_mut().insert(ErrorMessageExtension(err.to_string()));
bd1507c4 DM	117	*resp.status_mut() = StatusCode::BAD_REQUEST;
	118	Self::log_response(worker, method, &path, &resp);
	119	Ok(resp)
	120	}
	121	}
b9b7f7ec WB	122	})
b9b7f7ec WB	123	.boxed()
bd1507c4 DM	124	}
bd1507c4 DM	125	}