1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
#![forbid(unsafe_code)]
#![deny(
clippy::dbg_macro,
missing_copy_implementations,
rustdoc::missing_crate_level_docs,
missing_debug_implementations,
missing_docs,
nonstandard_style,
unused_qualifications
)]
/*!
Serves static file assets from memory, as included in the binary at
compile time. Because this includes file system content at compile
time, it requires a macro interface, [`static_compiled`](crate::static_compiled).
If the root is a directory, it will recursively serve any files
relative to the path that this handler is mounted at, or an index file
if one is configured with
[`with_index_file`](crate::StaticCompiledHandler::with_index_file).
If the root is a file, it will serve that file at all request paths.
This crate contains code from [`include_dir`][include_dir], but with
several tweaks to make it more suitable for this specific use case.
[include_dir]:https://docs.rs/include_dir/latest/include_dir/
```
# #[cfg(not(unix))] fn main() {}
# #[cfg(unix)] fn main() {
use trillium_static_compiled::static_compiled;
let handler = static_compiled!("./examples/files")
.with_index_file("index.html");
// given the following directory layout
//
// examples/files
// ├── index.html
// ├── subdir
// │ └── index.html
// └── subdir_with_no_index
// └── plaintext.txt
//
use trillium_testing::prelude::*;
assert_ok!(
get("/").on(&handler),
"<html>\n <head>\n <script src=\"/js.js\"></script>\n </head>\n <body>\n <h1>hello world</h1>\n </body>\n</html>",
"content-type" => "text/html"
);
assert_not_handled!(get("/file_that_does_not_exist.txt").on(&handler));
assert_ok!(get("/index.html").on(&handler));
assert_ok!(
get("/subdir/index.html").on(&handler),
"subdir index.html 🎈",
"content-type" => "text/html; charset=utf-8"
);
assert_ok!(get("/subdir").on(&handler), "subdir index.html 🎈");
assert_not_handled!(get("/subdir_with_no_index").on(&handler));
assert_ok!(
get("/subdir_with_no_index/plaintext.txt").on(&handler),
"plaintext file",
"content-type" => "text/plain"
);
// with a different index file
let plaintext_index = static_compiled!("./examples/files")
.with_index_file("plaintext.txt");
assert_not_handled!(get("/").on(&plaintext_index));
assert_not_handled!(get("/subdir").on(&plaintext_index));
assert_ok!(
get("/subdir_with_no_index").on(&plaintext_index),
"plaintext file",
"content-type" => "text/plain"
);
// with no index file
let no_index = static_compiled!("./examples/files");
assert_not_handled!(get("/").on(&no_index));
assert_not_handled!(get("/subdir").on(&no_index));
assert_not_handled!(get("/subdir_with_no_index").on(&no_index));
# }
```
*/
use trillium::{
async_trait, Conn, Handler,
KnownHeaderName::{ContentType, LastModified},
};
mod dir;
mod dir_entry;
mod file;
mod metadata;
pub(crate) use crate::dir::Dir;
pub(crate) use crate::dir_entry::DirEntry;
pub(crate) use crate::file::File;
pub(crate) use crate::metadata::Metadata;
#[doc(hidden)]
pub mod __macro_internals {
pub use crate::{dir::Dir, dir_entry::DirEntry, file::File, metadata::Metadata};
pub use trillium_static_compiled_macros::{include_dir, include_entry};
}
/**
The static compiled handler which contains the compile-time loaded
assets
*/
#[derive(Debug, Clone, Copy)]
pub struct StaticCompiledHandler {
root: DirEntry,
index_file: Option<&'static str>,
}
impl StaticCompiledHandler {
/// Constructs a new StaticCompiledHandler. This must be used in
/// conjunction with [`root!`](crate::root). See crate-level docs for
/// example usage.
pub fn new(root: DirEntry) -> Self {
Self {
root,
index_file: None,
}
}
/// Configures the optional index file for this
/// StaticCompiledHandler. See the crate-level docs for example
/// usage.
pub fn with_index_file(mut self, file: &'static str) -> Self {
if let Some(file) = self.root.as_file() {
panic!(
"root is a file ({:?}), with_index_file is not meaningful.",
file.path()
);
}
self.index_file = Some(file);
self
}
fn serve_file(&self, mut conn: Conn, file: File) -> Conn {
let mime = mime_guess::from_path(file.path()).first_or_text_plain();
let is_ascii = file.contents().is_ascii();
let is_text = matches!(
(mime.type_(), mime.subtype()),
(mime::APPLICATION, mime::JAVASCRIPT) | (mime::TEXT, _) | (_, mime::HTML)
);
conn.headers_mut().try_insert(
ContentType,
if is_text && !is_ascii {
format!("{mime}; charset=utf-8")
} else {
mime.to_string()
},
);
if let Some(metadata) = file.metadata() {
conn.headers_mut()
.try_insert(LastModified, httpdate::fmt_http_date(metadata.modified()));
}
conn.ok(file.contents())
}
fn get_item(&self, path: &str) -> Option<DirEntry> {
if path.is_empty() || self.root.is_file() {
Some(self.root)
} else {
self.root.as_dir().and_then(|dir| {
dir.get_dir(path)
.copied()
.map(DirEntry::Dir)
.or_else(|| dir.get_file(path).copied().map(DirEntry::File))
})
}
}
}
#[async_trait]
impl Handler for StaticCompiledHandler {
async fn run(&self, conn: Conn) -> Conn {
match (
self.get_item(conn.path().trim_start_matches('/')),
self.index_file,
) {
(None, _) => conn,
(Some(DirEntry::File(file)), _) => self.serve_file(conn, file),
(Some(DirEntry::Dir(_)), None) => conn,
(Some(DirEntry::Dir(dir)), Some(index_file)) => {
if let Some(file) = dir.get_file(dir.path().join(index_file)) {
self.serve_file(conn, *file)
} else {
conn
}
}
}
}
}
/**
The preferred interface to build a StaticCompiledHandler
Macro interface to build a
[`StaticCompiledHandler`]. `static_compiled!("assets")` is
identical to
`StaticCompiledHandler::new(root!("assets"))`.
This takes one argument, which must be a string literal.
## Relative paths
Relative paths are expanded and canonicalized relative to
`$CARGO_MANIFEST_DIR`, which is usually the directory that contains
your Cargo.toml. If compiled within a workspace, this will be the
subcrate's Cargo.toml.
## Environment variable expansion
If the argument to `static_compiled` contains substrings that are
formatted like an environment variable, beginning with a $, they will
be interpreted in the compile time environment.
For example "$OUT_DIR/some_directory" will expand to the directory
`some_directory` within the env variable `$OUT_DIR` set by cargo. See
[this link][env_vars] for further documentation on the environment
variables set by cargo.
[env_vars]:https://doc.rust-lang.org/cargo/reference/environment-variables.html#environment-variables-cargo-sets-for-crates
*/
#[macro_export]
macro_rules! static_compiled {
($path:tt) => {
$crate::StaticCompiledHandler::new($crate::root!($path))
};
}
/**
Include the path as root. To be passed into [`StaticCompiledHandler::new`].
This takes one argument, which must be a string literal.
## Relative paths
Relative paths are expanded and canonicalized relative to
`$CARGO_MANIFEST_DIR`, which is usually the directory that contains
your Cargo.toml. If compiled within a workspace, this will be the
subcrate's Cargo.toml.
## Environment variable expansion
If the argument to `static_compiled` contains substrings that are
formatted like an environment variable, beginning with a $, they will
be interpreted in the compile time environment.
For example "$OUT_DIR/some_directory" will expand to the directory
`some_directory` within the env variable `$OUT_DIR` set by cargo. See
[this link][env_vars] for further documentation on the environment
variables set by cargo.
[env_vars]:https://doc.rust-lang.org/cargo/reference/environment-variables.html#environment-variables-cargo-sets-for-crates
*/
#[macro_export]
macro_rules! root {
($path:tt) => {{
use $crate::__macro_internals::{include_entry, Dir, DirEntry, File, Metadata};
const ENTRY: DirEntry = include_entry!($path);
ENTRY
}};
}