Add more details to the /setup page

Author: RReverser

Cargo.lock

@@ -24,6 +24,7 @@ num_enum = "0.5.9"
 once_cell = { version = "1.17.1", optional = true }
 rand = { version = "0.8.5", optional = true }
 reqwest = { version = "0.11.14", optional = true, default-features = false, features = ["json"] }
+sailfish = { version = "0.6.1", optional = true }
 serde = { version = "1.0.145", features = ["derive", "rc"] }
 serde-ndim = { version = "1.1.0", optional = true, features = ["ndarray"] }
 serde_json = { version = "1.0.86" }
@@ -76,7 +77,7 @@ switch = []
 telescope = []
 
 client = ["dep:reqwest", "dep:bytes", "dep:mime", "dep:rand", "dep:once_cell"]
-server = ["dep:axum", "tokio/macros"]
+server = ["dep:axum", "dep:sailfish", "tokio/macros"]
 
 test = ["client", "server", "camera", "tokio/macros", "tokio/rt-multi-thread"]
 

Cargo.toml

@@ -0,0 +1 @@
+template_dirs = ["src/server"]

sailfish.toml

@@ -28,8 +28,8 @@ use axum::response::IntoResponse;
 use axum::routing::MethodFilter;
 use axum::{BoxError, Router};
 use net_literals::addr;
+use sailfish::TemplateOnce;
 use std::collections::BTreeMap;
-use std::fmt::Write;
 use std::future::Future;
 use std::net::SocketAddr;
 use std::pin::Pin;
@@ -243,74 +243,51 @@ impl Server {
                     })
                 })
             })
-            .route(
-                "/management/v1/description",
+            .route("/management/v1/description", {
+                let server_info = Arc::clone(&server_info);
+
                 axum::routing::get(move |server_handler: ServerHandler| {
                     server_handler.exec(|_params| async move {
                         ValueResponse::from(Arc::clone(&server_info))
                     })
-                }),
-            )
+                })
+            })
             .route("/setup", {
                 let this = Arc::clone(&devices);
+                let server_info = Arc::clone(&server_info);
 
                 axum::routing::get(|| async move {
-                    let mut grouped_devices = BTreeMap::new();
+                    #[derive(TemplateOnce)]
+                    #[template(path = "setup_template.html")]
+                    struct TemplateContext {
+                        server_info: Arc<ServerInfo>,
+                        grouped_devices: BTreeMap<DeviceType, Vec<(usize, String)>>,
+                    }
+
+                    let mut ctx = TemplateContext {
+                        server_info: Arc::clone(&server_info),
+                        grouped_devices: BTreeMap::new(),
+                    };
+
                     for (device, number) in this.iter_all() {
                         let device = device.to_configured_device(number);
 
-                        grouped_devices
+                        ctx.grouped_devices
                             .entry(device.ty)
                             .or_insert_with(Vec::new)
                             .push((number, device.name));
                     }
 
-                    let mut devices_html = String::new();
-
-                    for (device_type, devices) in grouped_devices {
-                        writeln!(devices_html, "<figure>").unwrap();
-                        writeln!(devices_html, "<figcaption>{}</figcaption>", match device_type {
-                            #[cfg(feature = "camera")]
-                            DeviceType::Camera => "Cameras",
-                            #[cfg(feature = "dome")]
-                            DeviceType::Dome => "Domes",
-                            #[cfg(feature = "filterwheel")]
-                            DeviceType::FilterWheel => "Filter wheels",
-                            #[cfg(feature = "focuser")]
-                            DeviceType::Focuser => "Focusers",
-                            #[cfg(feature = "observingconditions")]
-                            DeviceType::ObservingConditions => "Weather stations",
-                            #[cfg(feature = "rotator")]
-                            DeviceType::Rotator => "Rotators",
-                            #[cfg(feature = "safetymonitor")]
-                            DeviceType::SafetyMonitor => "Safety monitors",
-                            #[cfg(feature = "switch")]
-                            DeviceType::Switch => "Switches",
-                            #[cfg(feature = "telescope")]
-                            DeviceType::Telescope => "Telescopes",
-                            #[cfg(feature = "covercalibrator")]
-                            DeviceType::CoverCalibrator => "Cover calibrators",
-                        }).unwrap();
-                        writeln!(devices_html, "<ul>").unwrap();
-                        for (device_index, device_name) in devices {
-                            writeln!(
-                                devices_html,
-                                r#"<li><a href="/api/v1/{group_path}/{device_index}/setup">{device_name}</a></li>"#,
-                                group_path = DevicePath(device_type),
-                            ).unwrap();
+                    match ctx.render_once() {
+                        Ok(html) => Ok(axum::response::Html(html)),
+                        Err(err) => {
+                            tracing::error!(%err, "Failed to render setup page");
+                            Err((
+                                axum::http::StatusCode::INTERNAL_SERVER_ERROR,
+                                err.to_string(),
+                            ))
                         }
-                        writeln!(devices_html, "</ul>").unwrap();
-                        writeln!(devices_html, "</figure>").unwrap();
                     }
-
-                    axum::response::Html(include_str!("setup_template.html").replace(
-                        "<!-- devices_html -->",
-                        if devices_html.is_empty() {
-                            "<p>No devices are registered on this server.</p>"
-                        } else {
-                            &devices_html
-                        },
-                    ))
                 })
             })
             .route(

src/server/mod.rs

@@ -3,7 +3,7 @@
 <html lang="en">
   <head>
     <meta charset="UTF-8" />
-    <title>Alpaca devices</title>
+    <title><%= server_info.server_name %></title>
     <style>
       body {
         font-family: Arial, sans-serif;
@@ -25,7 +25,7 @@
         box-shadow: 0 1px 2px rgba(0, 0, 0, 0.3), 0 -2px 2px rgba(0, 0, 0, 0.3);
       }
       figcaption,
-      a {
+      li>a {
         margin: 0;
         padding: 0.625em;
       }
@@ -47,20 +47,65 @@
       li {
         border-bottom: 1px solid #ccc;
       }
-      a {
+      li>a {
         color: #333;
         text-decoration: none;
         display: block;
         transition: background-color 0.3s ease;
       }
-      a:hover {
+      li>a:hover {
         background-color: #f5f5f5;
       }
     </style>
   </head>
   <body>
     <h1>Alpaca devices</h1>
 
-    <!-- devices_html -->
+    <% if grouped_devices.is_empty() { %>
+      <p>No devices are registered on this server.</p>
+    <% } %>
+
+    <% for (group_ty, group) in grouped_devices { %>
+    <figure>
+      <figcaption>
+        <%= match group_ty {
+          #[cfg(feature = "camera")]
+          DeviceType::Camera => "Cameras",
+          #[cfg(feature = "dome")]
+          DeviceType::Dome => "Domes",
+          #[cfg(feature = "filterwheel")]
+          DeviceType::FilterWheel => "Filter wheels",
+          #[cfg(feature = "focuser")]
+          DeviceType::Focuser => "Focusers",
+          #[cfg(feature = "observingconditions")]
+          DeviceType::ObservingConditions => "Weather stations",
+          #[cfg(feature = "rotator")]
+          DeviceType::Rotator => "Rotators",
+          #[cfg(feature = "safetymonitor")]
+          DeviceType::SafetyMonitor => "Safety monitors",
+          #[cfg(feature = "switch")]
+          DeviceType::Switch => "Switches",
+          #[cfg(feature = "telescope")]
+          DeviceType::Telescope => "Telescopes",
+          #[cfg(feature = "covercalibrator")]
+          DeviceType::CoverCalibrator => "Cover calibrators",
+        } %>
+      </figcaption>
+      <ul>
+        <% for (number, name) in group { %>
+          <li><a href="/api/v1/<%= DevicePath(group_ty) | disp %>/<%= number %>/setup"><%= name %></a></li>
+        <% } %>
+      </ul>
+    </figure>
+    <% } %>
+
+    <footer>
+      <p>
+        This is an <a href="https://ascom-standards.org/AlpacaDeveloper/Index.htm">ASCOM Alpaca</a> server
+        <%= server_info.server_name %> v<%= server_info.manufacturer_version %>
+        by <%= server_info.manufacturer %>.
+      </p>
+      <p>Built with <a href="https://github.com/RReverser/ascom-alpaca-rs">ascom-alpaca-rs</a>.</p>
+    </footer>
   </body>
 </html>