From a5468e81e00fc513f14132360cdf65a7346839b9 Mon Sep 17 00:00:00 2001 From: Manuel Cillero Date: Sat, 7 Nov 2026 17:39:42 +0100 Subject: [PATCH] =?UTF-8?q?=E2=99=BB=EF=B8=8F=20Mount=20the=20books=20with?= =?UTF-8?q?=20their=20access?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Cargo.lock | 63 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 6 +++--- src/lib.rs | 39 ++++++++++++++++++--------------- 3 files changed, 88 insertions(+), 20 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 351358c..97bb9ec 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -160,6 +160,7 @@ dependencies = [ "matchit", "memchr", "mime", + "multer", "percent-encoding", "pin-project-lite", "serde_core", @@ -357,6 +358,12 @@ version = "0.8.7" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "773648b94d0e5d620f64f280777445740e61fe701025087ec8b57f45c791888b" +[[package]] +name = "core_detect" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7f8f80099a98041a3d1622845c271458a2d73e688351bf3cb999266764b81d48" + [[package]] name = "crc32fast" version = "1.5.0" @@ -420,6 +427,20 @@ dependencies = [ "syn 2.0.104", ] +[[package]] +name = "encoding_rs" +version = "0.8.44" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "89253175e704ab869b04f9db224d38630e0211a53841a79181deae0889e169f5" +dependencies = [ + "cfg-if", + "core_detect", + "multiversion_no_op", + "rustversion", + "scopeguard", + "simdutf8", +] + [[package]] name = "equivalent" version = "1.0.2" @@ -975,6 +996,29 @@ dependencies = [ "windows-sys 0.59.0", ] +[[package]] +name = "multer" +version = "3.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "83e87776546dc87511aa5ee218730c92b666d7264ab6ed41f9d215af9cd5224b" +dependencies = [ + "bytes", + "encoding_rs", + "futures-util", + "http", + "httparse", + "memchr", + "mime", + "spin", + "version_check", +] + +[[package]] +name = "multiversion_no_op" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "743fb55ba31b18fb1ecef6bdc9aa2743314978ac084044301a7eee33fb99a20d" + [[package]] name = "nu-ansi-term" version = "0.46.0" @@ -1048,6 +1092,7 @@ dependencies = [ "pagetop-statics", "parking_lot", "serde", + "serde_qs", "terminal_size", "thiserror 2.0.21", "tokio", @@ -1495,6 +1540,18 @@ dependencies = [ "serde_core", ] +[[package]] +name = "serde_qs" +version = "1.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "475b9310e272827d34113bf8679b6dfb7fa0023ee049764ba003f8f984e8b5d1" +dependencies = [ + "itoa", + "percent-encoding", + "ryu", + "serde", +] + [[package]] name = "serde_spanned" version = "1.0.0" @@ -1540,6 +1597,12 @@ dependencies = [ "libc", ] +[[package]] +name = "simdutf8" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e3a9fe34e3e7a50316060351f37187a3f546bce95496156754b601a5fa71b76e" + [[package]] name = "siphasher" version = "1.0.1" diff --git a/README.md b/README.md index 2f28679..853d609 100644 --- a/README.md +++ b/README.md @@ -91,9 +91,9 @@ impl Extension for MyApp { vec![&pagetop_mdbook::MdBook] } - fn configure_router(&self, router: Router) -> Router { - pagetop_mdbook::serve_mdbook!(router, [doc] => "/doc"); - router + fn configure_router(&self, routes: Routes) -> Routes { + pagetop_mdbook::serve_mdbook!(routes, [doc] => "/doc", Access::Public); + routes } } ``` diff --git a/src/lib.rs b/src/lib.rs index 64cff13..efd0da1 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -92,9 +92,9 @@ impl Extension for MyApp { vec![&pagetop_mdbook::MdBook] } - fn configure_router(&self, router: Router) -> Router { - pagetop_mdbook::serve_mdbook!(router, [doc] => "/doc"); - router + fn configure_router(&self, routes: Routes) -> Routes { + pagetop_mdbook::serve_mdbook!(routes, [doc] => "/doc", Access::Public); + routes } } ``` @@ -151,9 +151,9 @@ impl Extension for MdBook { Lc::t("extension_description", &LOCALES_MDBOOK) } - fn configure_static_files(&self, router: Router) -> Router { - serve_static_files!(router, [mdbook] => "/mdbook"); - router + fn configure_static_files(&self, files: StaticFiles) -> StaticFiles { + serve_static_files!(files, [mdbook] => "/mdbook"); + files } } @@ -164,7 +164,10 @@ impl Extension for MdBook { /// page rendered inside the active theme; the rest of the files (images, scripts, search index...) /// are served as static files. /// -/// Like [`serve_static_files!`](pagetop::serve_static_files), the macro shadows `router`, so the +/// Every route of the books is mounted with the given [`Access`]: `Access::Public` for public +/// documentation, or a permission for an internal manual. +/// +/// Like [`serve_static_files!`](pagetop::serve_static_files), the macro shadows `routes`, so the /// parameter does not need `mut`, but it must be returned at the end. /// /// ```rust,ignore @@ -174,24 +177,24 @@ impl Extension for MdBook { /// /// #[async_trait] /// impl Extension for MyApp { -/// fn configure_router(&self, router: Router) -> Router { +/// fn configure_router(&self, routes: Routes) -> Routes { /// // Chapters are served at /doc//.html. -/// pagetop_mdbook::serve_mdbook!(router, [doc] => "/doc"); -/// router +/// pagetop_mdbook::serve_mdbook!(routes, [doc] => "/doc", Access::Public); +/// routes /// } /// } /// ``` #[macro_export] macro_rules! serve_mdbook { - ( $router:ident, [$bundle:ident] => $path:expr $(,)? ) => { - let $router = { + ( $routes:ident, [$bundle:ident] => $path:expr, $access:expr $(,)? ) => { + let $routes = { let _span = $crate::pagetop::trace::debug_span!("serve_mdbook", route = $path).entered(); $crate::pagetop::util::paste! { mod [] { include!(concat!(env!("OUT_DIR"), "/", stringify!($bundle), ".rs")); } - $crate::route_books($router, $path, []::$bundle()) + $crate::route_books($routes, $path, $access, []::$bundle()) } }; }; @@ -272,10 +275,11 @@ fn metadata(name: &str, html: &'static str) -> Option<&'static str> { #[doc(hidden)] pub fn route_books( - mut router: Router, + mut routes: Routes, path: &'static str, + access: Access, files: HashMap<&'static str, pagetop::StaticFile>, -) -> Router { +) -> Routes { let path = path.trim_end_matches('/'); let (chapters, resources): (HashMap<_, _>, HashMap<_, _>) = files .into_iter() @@ -287,13 +291,14 @@ pub fn route_books( continue; }; let chapter = Arc::new(Chapter::parse(html)); - router = router.route( + routes = routes.route( &util::join!(path, "/", name), + access, web::get(move |request: HttpRequest| { let chapter = Arc::clone(&chapter); async move { chapter.render(request).await } }), ); } - router.nest_service(path, web::ServeEmbedded::new(resources)) + routes.nest_service(path, access, web::ServeEmbedded::new(resources)) }