[PATCH proxmox 02/20] rest-server: allow to inject shared state

[Lukas Wagner <l.wagner@proxmox.com>]

Let users of ApiConfig register a shared state registry while setting
up the server and pass it on to API handlers via RestEnvironment.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
---
 proxmox-rest-server/src/api_config.rs  | 14 +++++++++++++-
 proxmox-rest-server/src/environment.rs |  6 +++++-
 2 files changed, 18 insertions(+), 2 deletions(-)

diff --git a/proxmox-rest-server/src/api_config.rs b/proxmox-rest-server/src/api_config.rs
index 3543f8c4..53b1ca97 100644
--- a/proxmox-rest-server/src/api_config.rs
+++ b/proxmox-rest-server/src/api_config.rs
@@ -17,7 +17,7 @@ use proxmox_daemon::command_socket::CommandSocket;
 use proxmox_http::Body;
 use proxmox_log::{FileLogOptions, FileLogger};
 use proxmox_network_types::Cidr;
-use proxmox_router::{Router, RpcEnvironmentType, UserInformation};
+use proxmox_router::{Router, RpcEnvironmentType, SharedStateRegistry, UserInformation};
 use proxmox_sys::fs::{CreateOptions, create_path};
 
 use crate::RestEnvironment;
@@ -33,6 +33,8 @@ pub struct ApiConfig {
     handlers: Vec<Handler>,
     auth_handler: Option<AuthHandler>,
     index_handler: Option<IndexHandler>,
+    /// State that API handlers can request via a `State<T>` parameter.
+    pub(crate) shared_state: Option<SharedStateRegistry>,
     pub(crate) privileged_addr: Option<PrivilegedAddr>,
     // Name of the auth cookie that should be unset on 401 request. If `None` no cookie will be
     // removed.
@@ -92,6 +94,7 @@ impl ApiConfig {
             index_handler: None,
             privileged_addr: None,
             auth_cookie_name: None,
+            shared_state: None,
 
             real_ip_header,
             real_ip_allow_from: None,
@@ -366,6 +369,15 @@ impl ApiConfig {
             .push(Handler::unformatted_router(prefix, router));
         self
     }
+
+    /// Set the [`SharedStateRegistry`] from which API handlers get their `State<T>` parameters.
+    ///
+    /// All types a handler requests must be registered before using
+    /// [`SharedStateRegistry::register`] before, otherwise a call to the API handler will fail.
+    pub fn with_shared_state(mut self, shared_state: SharedStateRegistry) -> Self {
+        self.shared_state = Some(shared_state);
+        self
+    }
 }
 
 #[cfg(feature = "templates")]
diff --git a/proxmox-rest-server/src/environment.rs b/proxmox-rest-server/src/environment.rs
index 47ff5a4f..9133999f 100644
--- a/proxmox-rest-server/src/environment.rs
+++ b/proxmox-rest-server/src/environment.rs
@@ -3,7 +3,7 @@ use std::sync::Arc;
 
 use serde_json::{Value, json};
 
-use proxmox_router::{RpcEnvironment, RpcEnvironmentType};
+use proxmox_router::{RpcEnvironment, RpcEnvironmentType, SharedStateRegistry};
 
 use crate::ApiConfig;
 
@@ -89,4 +89,8 @@ impl RpcEnvironment for RestEnvironment {
     fn get_client_ip(&self) -> Option<SocketAddr> {
         self.client_ip
     }
+
+    fn shared_state(&self) -> Option<&SharedStateRegistry> {
+        self.api.shared_state.as_ref()
+    }
 }
-- 
2.47.3