feat: add custom visualization support (custom_static) (#301)

Co-authored-by: Erik Bjäreholt <[email protected]>

Author: LockBlock-dev

aw-server/src/config.rs

@@ -8,7 +8,7 @@ use serde::{Deserialize, Serialize};
 
 use crate::dirs;
 
-/* Far from an optimal way to solve it, but works and is simple */
+// Far from an optimal way to solve it, but works and is simple
 static mut TESTING: bool = true;
 pub fn set_testing(testing: bool) {
     unsafe {
@@ -23,12 +23,20 @@ pub fn is_testing() -> bool {
 pub struct AWConfig {
     #[serde(default = "default_address")]
     pub address: String,
+
     #[serde(default = "default_port")]
     pub port: u16,
+
     #[serde(skip, default = "default_testing")]
     pub testing: bool, // This is not written to the config file (serde(skip))
+
     #[serde(default = "default_cors")]
     pub cors: Vec<String>,
+
+    // A mapping of watcher names to paths where the
+    // custom visualizations are located.
+    #[serde(default = "default_custom_static")]
+    pub custom_static: std::collections::HashMap<String, String>,
 }
 
 impl Default for AWConfig {
@@ -38,6 +46,7 @@ impl Default for AWConfig {
             port: default_port(),
             testing: default_testing(),
             cors: default_cors(),
+            custom_static: default_custom_static(),
         }
     }
 }
@@ -86,6 +95,10 @@ fn default_port() -> u16 {
     }
 }
 
+fn default_custom_static() -> std::collections::HashMap<String, String> {
+    std::collections::HashMap::new()
+}
+
 pub fn create_config(testing: bool) -> AWConfig {
     set_testing(testing);
     let mut config_path = dirs::get_config_dir().unwrap();

aw-server/src/endpoints/mod.rs

@@ -2,11 +2,13 @@ use std::path::PathBuf;
 use std::sync::Mutex;
 
 use gethostname::gethostname;
+use rocket::fs::FileServer;
 use rocket::fs::NamedFile;
 use rocket::serde::json::Json;
 use rocket::State;
 
 use crate::config::AWConfig;
+use crate::dirs;
 
 use aw_datastore::Datastore;
 use aw_models::Info;
@@ -92,7 +94,9 @@ pub fn build_rocket(server_state: ServerState, config: AWConfig) -> rocket::Rock
     );
     let cors = cors::cors(&config);
     let hostcheck = hostcheck::HostCheck::new(&config);
-    rocket::custom(config.to_rocket_config())
+    let custom_static = config.custom_static.clone();
+
+    let mut rocket = rocket::custom(config.to_rocket_config())
         .attach(cors.clone())
         .attach(hostcheck)
         .manage(cors)
@@ -141,5 +145,15 @@ pub fn build_rocket(server_state: ServerState, config: AWConfig) -> rocket::Rock
                 settings::setting_delete
             ],
         )
-        .mount("/", rocket_cors::catch_all_options_routes())
+        .mount("/", rocket_cors::catch_all_options_routes());
+
+    // for each custom static directory, mount it at the given name
+    for (name, dir) in custom_static {
+        info!(
+            "Serving /pages/{} custom static directory from {}",
+            name, dir
+        );
+        rocket = rocket.mount(&format!("/pages/{}", name), FileServer::from(dir));
+    }
+    rocket
 }

aw-server/src/main.rs

@@ -39,6 +39,10 @@ struct Opts {
     #[clap(long)]
     webpath: Option<String>,
 
+    /// Mapping of custom static paths to serve, in the format: watcher1=/path,watcher2=/path2
+    #[clap(long)]
+    custom_static: Option<String>,
+
     /// Device ID override
     #[clap(long)]
     device_id: Option<String>,
@@ -79,6 +83,29 @@ async fn main() -> Result<(), rocket::Error> {
         config.port = port.parse().unwrap();
     }
 
+    // set custom_static if overridden, transform into map
+    if let Some(custom_static_str) = opts.custom_static {
+        let custom_static_map: std::collections::HashMap<String, String> = custom_static_str
+            .split(',')
+            .map(|s| {
+                let mut split = s.split('=');
+                let key = split.next().unwrap().to_string();
+                let value = split.next().unwrap().to_string();
+                (key, value)
+            })
+            .collect();
+        config.custom_static.extend(custom_static_map);
+
+        // validate paths, log error if invalid
+        // remove invalid paths
+        for (name, path) in config.custom_static.clone().iter() {
+            if !std::path::Path::new(path).exists() {
+                error!("custom_static path for {} does not exist ({})", name, path);
+                config.custom_static.remove(name);
+            }
+        }
+    }
+
     // Set db path if overridden
     let db_path: String = if let Some(dbpath) = opts.dbpath.clone() {
         dbpath