feature: added index page

Signed-off-by: skoowu <skoowu.fancy@gmail.com>

Author: skoowoo

README.md

@@ -19,8 +19,8 @@ A markdown parsing toolkit
 Usage: medup <COMMAND>
 
 Commands:
-  gen    generate HTML based on Markdown!
-  serve  Provide an http service for markdown parsing!
+  gen    Generate html from markdown
+  serve  Provide an http service for markdown parsing
   help   Print this message or the help of the given subcommand(s)
 
 Options:
@@ -47,4 +47,4 @@ or
 docker run -d -p 8181:8181 --rm skoowoo/medup:20230302-0
 ```
 
-Open `http://localhost:8181/markdown-guide.md` with your browser.
+Open `http://localhost:8181` with your browser.

docs/index.md

@@ -0,0 +1,4 @@
+
+# Welcome to Medup !
+
+* [markdown-guide](./markdown-guide.md)

src/bin/medup/main.rs

@@ -22,14 +22,14 @@ fn cli() -> Command {
         .subcommand_required(true)
         .subcommand(
             Command::new("gen")
-                .about("generate HTML based on Markdown!")
+                .about("Generate html from markdown")
                 .arg(arg!(-c --"config-path" [CONFIG_PATH] "Specify path of the config file, it's optional."))
                 .arg(arg!(-o --output [OUTPUT_HTML_PATH] "Specify a html output path, it's optional."))
                 .arg(arg!(<MARKDOWN_FILE_PATH>)),
         )
         .subcommand(
             Command::new("serve")
-                .about("Provide an http service for markdown parsing!")
+                .about("Provide an http service for markdown parsing")
                 .arg(arg!(-l --"listen-addr" [LISTEN_ADDR] r#"Specify the listening address of the http server, default ":8181"."#))
                 .arg(arg!(-c --"config-path" [CONFIG_PATH] "Specify path of the config file, it's optional."))
                 .arg(arg!(-d --dir [DIR] "Specify the directory where markdown files are stored."))

src/bin/medup/serve.rs

@@ -7,7 +7,8 @@ use medup::markdown::{self, Markdown};
 
 use clap::ArgMatches;
 use warp::filters::BoxedFilter;
-use warp::{http::Response, Filter, Reply};
+use warp::hyper::StatusCode;
+use warp::{Filter, Reply};
 
 #[tokio::main]
 pub async fn proc_serve(matches: &ArgMatches) {
@@ -27,22 +28,13 @@ pub async fn proc_serve(matches: &ArgMatches) {
 
     // All filters are used to match requests
     let filters = static_filter(sdir.to_string())
-        .or(articles_filter(cfg, dir.to_string()))
-        .or(index_filter());
+        .or(articles_filter(cfg.clone(), dir.to_string()))
+        .or(index_filter(cfg.clone(), dir.to_string()));
 
     println!("---> start to listen on address: \"{}:{}\"", addr, port);
     warp::serve(filters).run((addr, port)).await
 }
 
-// TODO:
-fn index_filter() -> BoxedFilter<(impl Reply,)> {
-    warp::get()
-        .and(warp::path::end())
-        .map(|| Response::builder().body("Hello, Medup!").into_response())
-        .with(warp::cors().allow_any_origin())
-        .boxed()
-}
-
 // Get /static/*
 fn static_filter(dir: String) -> BoxedFilter<(impl Reply,)> {
     warp::get()
@@ -62,27 +54,20 @@ fn articles_filter(cfg: Config, dir: String) -> BoxedFilter<(impl Reply,)> {
             if !name.ends_with(".md") {
                 name.push_str(".md");
             }
-            let buf = Path::new(&dir).join(&name);
-            let s = buf.to_str();
-            match s {
-                None => Response::builder()
-                    .header("X-Powered-By", "Medup")
-                    .status(400)
-                    .body(format!(
-                        "failed to join the path: \"{}\", \"{}\"",
-                        dir, name
-                    ))
-                    .into_response(),
+            match Path::new(&dir).join(&name).to_str() {
+                None => error_repsonse(
+                    StatusCode::BAD_REQUEST,
+                    format!(r#"failed to join the path: {}, {}"#, dir, name),
+                ),
                 Some(path) => match Markdown::new()
                     .config(cfg)
                     .path(path)
                     .map_mut(markdown::to_html)
                 {
-                    Err(e) => Response::builder()
-                        .header("X-Powered-By", "Medup")
-                        .status(500)
-                        .body(format!("failed to generate html from markdown: {}", e))
-                        .into_response(),
+                    Err(e) => error_repsonse(
+                        StatusCode::INTERNAL_SERVER_ERROR,
+                        format!("failed to generate html from markdown: {}", e),
+                    ),
                     Ok(v) => warp::reply::html(v).into_response(),
                 },
             }
@@ -91,6 +76,35 @@ fn articles_filter(cfg: Config, dir: String) -> BoxedFilter<(impl Reply,)> {
         .boxed()
 }
 
+// Get /, then read the index.md file
+fn index_filter(cfg: Config, dir: String) -> BoxedFilter<(impl Reply,)> {
+    warp::get()
+        .and(warp::path::end())
+        .and(warp::any().map(move || cfg.clone()))
+        .and(warp::any().map(move || dir.to_string()))
+        .map(
+            |cfg: Config, dir: String| match Path::new(&dir).join("index.md").to_str() {
+                None => error_repsonse(
+                    StatusCode::BAD_REQUEST,
+                    format!(r#"failed to join the path: {}, index.md"#, dir),
+                ),
+                Some(path) => match Markdown::new()
+                    .config(cfg)
+                    .path(path)
+                    .map_mut(markdown::to_html)
+                {
+                    Err(e) => error_repsonse(
+                        StatusCode::INTERNAL_SERVER_ERROR,
+                        format!("failed to generate html from markdown: {}", e),
+                    ),
+                    Ok(v) => warp::reply::html(v).into_response(),
+                },
+            },
+        )
+        .with(warp::cors().allow_any_origin())
+        .boxed()
+}
+
 fn get_dir<'get_dir>(matches: &'get_dir ArgMatches, name: &str) -> &'get_dir str {
     match matches.get_one::<String>(name) {
         None => ".",
@@ -144,3 +158,11 @@ fn parse_ip_port(matches: &ArgMatches) -> Result<(Ipv4Addr, u16), Box<dyn Error>
 
     Ok((ipaddr, port))
 }
+
+fn error_repsonse(status_code: StatusCode, err_msg: String) -> warp::reply::Response {
+    warp::http::Response::builder()
+        .header("X-Powered-By", "Medup")
+        .status(status_code)
+        .body(err_msg)
+        .into_response()
+}