Merge pull request #23 from hnez/directory-listings

http_server: Add directory listings, caching and compression

Author: hnez

Cargo.lock

@@ -27,6 +27,7 @@ futures = "0.3"
 futures-lite = "1.12"
 futures-util = "0.3"
 gpio-cdev = "0.5"
+html-escape = "0.2"
 industrial-io = { version = "0.5", default-features = false }
 log = { version = "0.4", features = ["release_max_level_warn"]}
 mqtt-protocol = "0.11"

Cargo.toml

@@ -19,6 +19,7 @@ use std::env::var_os;
 use std::fs::{read_to_string, write};
 use std::path::Path;
 use std::process::Command;
+use std::time::SystemTime;
 
 use chrono::prelude::Utc;
 
@@ -88,7 +89,19 @@ fn generate_version_string() {
     )
 }
 
+/// Store the build date and time to have a lower bound on HTTP Last-Modified
+/// for files with faked timestamps.
+fn generate_build_date() {
+    let timestamp = SystemTime::now()
+        .duration_since(SystemTime::UNIX_EPOCH)
+        .unwrap()
+        .as_secs();
+
+    println!("cargo:rustc-env=BUILD_TIMESTAMP={}", timestamp);
+}
+
 fn main() {
-    generate_version_string();
     generate_openapi_include();
+    generate_version_string();
+    generate_build_date();
 }

build.rs

@@ -0,0 +1 @@
+Hello!

demo_files/srv/www/index.html renamed to demo_files/srv/www/dir_with_index/index.html

@@ -15,30 +15,31 @@
 // with this program; if not, write to the Free Software Foundation, Inc.,
 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
-use std::convert::AsRef;
 use std::fs::write;
-use std::io::ErrorKind;
 use std::net::TcpListener;
-use std::path::Path;
 
-use log::warn;
 use tide::{Body, Response, Server};
 
+mod serve_dir;
+use serve_dir::serve_dir;
+
 #[cfg(feature = "demo_mode")]
 mod consts {
     pub const WEBUI_DIR: &str = "web/build";
+    pub const EXTRA_DIR: &str = "demo_files/srv/www";
     pub const FS_PREFIX: &str = "demo_files";
     pub const FALLBACK_PORT: &str = "[::]:8080";
 }
 
 #[cfg(not(feature = "demo_mode"))]
 mod consts {
     pub const WEBUI_DIR: &str = "/usr/share/tacd/webui";
+    pub const EXTRA_DIR: &str = "/srv/www";
     pub const FS_PREFIX: &str = "";
     pub const FALLBACK_PORT: &str = "[::]:80";
 }
 
-use consts::{FALLBACK_PORT, FS_PREFIX, WEBUI_DIR};
+use consts::{EXTRA_DIR, FALLBACK_PORT, FS_PREFIX, WEBUI_DIR};
 
 // openapi.json is generated by build.rs from openapi.yaml
 const OPENAPI_JSON: &[u8] = include_bytes!(concat!(env!("OUT_DIR"), "/openapi.json"));
@@ -74,8 +75,8 @@ impl HttpServer {
         );
 
         this.expose_openapi_json();
-        this.expose_dir(WEBUI_DIR, "/");
-        this.expose_dir(FS_PREFIX.to_owned() + "/srv/www", "/srv/");
+        this.expose_dir(WEBUI_DIR, "/", false);
+        this.expose_dir(EXTRA_DIR, "/srv", true);
 
         for (fs_path, web_path) in EXPOSED_FILES_RW {
             let fs_path = FS_PREFIX.to_owned() + *fs_path;
@@ -99,45 +100,12 @@ impl HttpServer {
     }
 
     /// Serve a directory from disk for reading
-    fn expose_dir(&mut self, fs_path: impl AsRef<Path>, web_path: &str) {
-        if let Err(e) = self.server.at(web_path).serve_dir(&fs_path) {
-            // Don't crash if the directory does not exist.
-            // Just print a warning.
-            match e.kind() {
-                ErrorKind::NotFound => {
-                    warn!(
-                        "Can not serve {} at {}: Directory not found",
-                        fs_path.as_ref().display(),
-                        web_path
-                    );
-                }
-                _ => Err(e).unwrap(),
-            }
-        }
+    fn expose_dir(&mut self, fs_path: &'static str, web_path: &str, directory_listings: bool) {
+        let handler = move |req| async move { serve_dir(fs_path, directory_listings, req).await };
 
-        // Serve an index.html if the bare directory path is requested.
-        // This only works for the top level. If we want to serve index.htmls
-        // from sub-directories we would have to modify serve_dir().
-        // Which is something we will likely want anyways as it does not
-        // support compression, caching headers or directory listings.
-        if web_path.ends_with('/') {
-            let index_html = fs_path.as_ref().join("index.html");
-
-            if let Err(e) = self.server.at(web_path).serve_file(&index_html) {
-                // Don't crash if the directory does not exist. Just print a
-                // warning.
-                match e.kind() {
-                    ErrorKind::NotFound => {
-                        warn!(
-                            "Can not serve {} at {}: File not found",
-                            index_html.display(),
-                            web_path
-                        );
-                    }
-                    _ => Err(e).unwrap(),
-                }
-            }
-        }
+        self.server.at(web_path).get(handler);
+        self.server.at(web_path).at("").get(handler);
+        self.server.at(web_path).at("*rel_path").get(handler);
     }
 
     /// Serve a file from disk for reading and writing