-
@ 89391693:ae75dc0d
2025-05-11 23:20:07commit d642ea7b0367ed895e88d10113889a65c17aa4cc Author: randymcmillanShow the contents of an embedded file using a pager + --serve Axum Serve + -p, --port Sets the port number to listen on [default: 8080] + -e, --export Export all embedded files to the current directory + --export-html Export all embedded files to the current directory + --export-path Export all embedded files to the specified path + -u, --usage Show this manual + -h, --help Print help + -V, --version Print version diff --git a/docs/USAGE.html b/docs/USAGE.html new file mode 100644 index 0000000..38fa87d --- /dev/null +++ b/docs/USAGE.html @@ -0,0 +1,20 @@ + nips
+nips
+nips
+nips
+nips
+nips
+nips: a nostr-protocol/nips server
+Usage: nips [OPTIONS]
+Options: +-d, --debug Enable debug logging +-l, --list-embedded List all embedded files +-s, --show
diff --git a/examples/export-all.rs b/examples/export-all.rs deleted file mode 100644 index 0911087..0000000 --- a/examples/export-all.rs +++ /dev/null @@ -1,377 +0,0 @@ -use clap::Parser; -use rust_embed::Embed; -use std::env; -use std::fs; -use std::fs::File; -use std::io; -use std::io::{stdout, Write}; -use std::os::unix::fs::PermissionsExt; -use std::path::{Path, PathBuf}; -use std::process::Command; -use std::process::Stdio; -use termimad::crossterm::{ - cursor::{Hide, Show}, - event::{self, Event, KeyCode::*, KeyEvent}, - queue, - style::Color::*, - terminal::{self, Clear, ClearType, EnterAlternateScreen, LeaveAlternateScreen}, -}; -use termimad::*; -use tracing_subscriber::{fmt, layer::SubscriberExt, EnvFilter, Registry}; - -#[derive(Embed)] -#[folder = "."] -#[include = "*.md"] -#[exclude = "*.DS_Store"] -#[exclude = "target/*"] -#[exclude = "src"] -#[exclude = "src/*"] -#[exclude = ".git"] -#[exclude = ".git/*"] -#[exclude = ".github/*"] -#[exclude = ".gitignore"] -#[exclude = ".justfile"] -#[exclude = ".nojekyll"] -#[exclude = "build.rs"] -#[exclude = "dist-workspace.toml"] -#[exclude = "error.log"] -#[exclude = "output.log"] -#[exclude = "post-commit-history"] -#[exclude = "script.sh"] -#[exclude = "template/Makefile"] -#[exclude = "template/default_config.conf"] -#[exclude = "template/install_script.sh"] -#[exclude = "test_files/tabbed.txtbuild.rs"] -#[exclude = "Cargo.lock"] -#[exclude = "Cargo.toml"] -#[exclude = "LICENSE"] -#[exclude = "Makefile"] -struct Template; - -/// A simple tool to view embedded Markdown files. -#[derive(Parser, Debug)] -#[clap(author, version, about, long_about = None)] -struct Args { - /// Enable debug logging. - #[clap(short, long)] - debug: bool, - - /// List all embedded files. - #[clap(short, long)] - list_embedded: bool, - - /// Show the contents of an embedded file using a pager. - #[clap(short, long, value_name = "NIP")] - show: OptionShow the contents of an embedded file using a pager +--serve Axum Serve +-p, --port Sets the port number to listen on [default: 8080] +-e, --export Export all embedded files to the current directory +--export-html Export all embedded files to the current directory +--export-path Export all embedded files to the specified path +-u, --usage Show this manual +-h, --help Print help +-V, --version Print version , - - /// Export all embedded files to the current directory. - #[clap(long)] - export: bool, -} - -fn make_executable(script_path: &Path) -> io::Result<()> { - let mut permissions = fs::metadata(script_path)?.permissions(); - permissions.set_mode(permissions.mode() | 0o111); - fs::set_permissions(script_path, permissions)?; - tracing::debug!("Made '{}' executable.", script_path.display()); - Ok(()) -} - -fn execute_script(script_path: &Path) -> io::Result<()> { - tracing::debug!("Executing script: {}", script_path.display()); - let log_file = File::create("output.log")?; - let error_file = File::create("error.log")?; - let mut command = Command::new(script_path); - command - .stdout(Stdio::from(log_file)) - .stderr(Stdio::from(error_file)); - let status = command.spawn()?.wait()?; - if status.success() { - tracing::debug!("Script '{}' executed successfully.", script_path.display()); - Ok(()) - } else { - eprintln!( - "Script '{}' failed with exit code: {:?}", - script_path.display(), - status.code() - ); - Err(io::Error::new( - io::ErrorKind::Other, - format!( - "Script execution failed with exit code: {:?}", - status.code() - ), - )) - } -} - -fn canonicalize_path(path: &Path) -> io::Result { - let absolute_path = if path.is_relative() { - let current_dir = env::current_dir()?; - current_dir.join(path) - } else { - path.to_path_buf() - }; - fs::canonicalize(absolute_path) -} - -fn extract(filename: &str, output_dir: &Path) -> io::Result<()> { - match Template::get(filename) { - Some(embedded_file) => { - let output_path = output_dir.join(filename); - if let Some(parent) = output_path.parent() { - fs::create_dir_all(parent)?; - } - let mut outfile = File::create(&output_path)?; - outfile.write_all(embedded_file.data.as_ref())?; - tracing::debug!( - "Successfully exported '{}' to '{}'", - filename, - output_path.display() - ); - Ok(()) - } - None => Err(io::Error::new( - io::ErrorKind::NotFound, - format!("Embedded file '{}' not found!", filename), - )), - } -} - -fn view_area() -> Area { - let mut area = Area::full_screen(); - area.pad_for_max_width(120); - area -} - -fn run_app(skin: MadSkin, nip: String) -> Result<(), Error> { - let mut w = stdout(); - queue!(w, EnterAlternateScreen)?; - terminal::enable_raw_mode()?; - queue!(w, Hide)?; - let mut view = MadView::from(nip.to_owned(), view_area(), skin); - loop { - view.write_on(&mut w)?; - w.flush()?; - match event::read() { - Ok(Event::Key(KeyEvent { code, .. })) => match code { - Up => view.try_scroll_lines(-1), - Down => view.try_scroll_lines(1), - PageUp => view.try_scroll_pages(-1), - PageDown => view.try_scroll_pages(1), - Char('q') | Esc => break, - _ => {} - }, - Ok(Event::Resize(..)) => { - queue!(w, Clear(ClearType::All))?; - view.resize(&view_area()); - } - _ => {} - } - } - terminal::disable_raw_mode()?; - queue!(w, Show)?; - queue!(w, LeaveAlternateScreen)?; - w.flush()?; - Ok(()) -} - -fn make_skin() -> MadSkin { - let mut skin = MadSkin::default(); - skin.table.align = Alignment::Center; - skin.set_headers_fg(AnsiValue(178)); - skin.bold.set_fg(Yellow); - skin.italic.set_fg(Magenta); - skin.scrollbar.thumb.set_fg(AnsiValue(178)); - skin.code_block.align = Alignment::Center; - skin -} - -fn main() -> Result<(), Box > { - let args = Args::parse(); - - let level_filter = if args.debug { - EnvFilter::new("debug") - } else { - EnvFilter::from_default_env() - }; - - let subscriber = Registry::default() - .with(fmt::layer().with_writer(std::io::stdout)) - .with(level_filter); - tracing::subscriber::set_global_default(subscriber) - .expect("Failed to set global default subscriber"); - - tracing::debug!("Parsed arguments: {:?}", args); - - if args.list_embedded { - tracing::debug!("Embedded files:"); - for file in Template::iter() { - println!("{}", file.as_ref()); - } - return Ok(()); - } - - if args.export { - tracing::info!("Exporting all embedded files to the current directory..."); - let current_dir = env::current_dir()?; - let mut export_count = 0; - for file in Template::iter() { - match extract(file.as_ref(), ¤t_dir) { - Ok(_) => { - export_count += 1; - } - Err(e) => { - eprintln!("Error exporting '{}': {}", file.as_ref(), e); - } - } - } - tracing::info!("Successfully exported {} embedded files.", export_count); - return Ok(()); - } - - if let Some(nip_arg) = &args.show { - let filename = if nip_arg.ends_with(".md") { - nip_arg.clone() - } else { - format!("{:02}.md", nip_arg) - }; - - match Template::get(&filename) { - Some(embedded_file) => { - let content = String::from_utf8_lossy(embedded_file.data.as_ref()); - let skin = make_skin(); - let _res = run_app(skin, (&content).to_string()); - return Ok(()); - } - None => { - eprintln!("Error: Embedded NIP file '{}' not found!", filename); - std::process::exit(1); - } - } - } - - tracing::debug!( - "Canonical path of '.': {}", - canonicalize_path(Path::new("."))?.display() - ); - tracing::debug!( - "Canonical path of 'src': {}", - canonicalize_path(Path::new("src"))?.display() - ); - - #[cfg(windows)] - let absolute_path_str = "C:\\Windows\\System32\\cmd.exe"; - #[cfg(not(windows))] - let absolute_path_str = "/bin/ls"; - - tracing::debug!( - "Canonical path of '{}': {}", - absolute_path_str, - canonicalize_path(Path::new(absolute_path_str))?.display() - ); - - Ok(()) -} - -#[cfg(test)] -mod tests { - use super::*; - use rust_embed::RustEmbed; - use std::fs; - use std::path::PathBuf; - use std::thread; - use std::time::Duration; - - fn create_test_file(path: &PathBuf, content: &str) -> io::Result<()> { - fs::create_dir_all(path.parent().unwrap())?; - fs::write(path, content)?; - Ok(()) - } - - #[test] - fn test_make_test_file() -> io::Result<()> { - let test_file_content = "Line with\ttab.\nAnother\t\ttabbed line.\n\tLeading tab.\n\\tThis line starts with a literal backslash-t.\nThis line has a tab in the middle: like this."; - let script_path = Path::new("tabbed.txt"); - let test_files = Path::new("test_files"); - let full_path = test_files.join(script_path); - tracing::debug!("{}", full_path.display()); - create_test_file(&full_path, test_file_content)?; - thread::sleep(Duration::from_secs(1)); - Ok(()) - } - - #[test] - fn test_preserve_tabs() -> io::Result<()> { - test_make_test_file()?; - let test_file_content = "Line with\ttab.\nAnother\t\ttabbed line.\n\tLeading tab.\n\\tThis line starts with a literal backslash-t.\nThis line has a tab in the middle: like this."; - - #[derive(RustEmbed)] - #[folder = "./test_files"] - #[exclude = "*.DS_Store"] - struct EmbeddedAssets; - - for file in EmbeddedAssets::iter() { - println!("Found asset: {}", file.as_ref()); - - match EmbeddedAssets::get(file.as_ref()) { - Some(embedded_file) => { - let content = String::from_utf8_lossy(embedded_file.data.as_ref()); - println!("Contents of {}:\n{}", file.as_ref(), content); - let install_default_conf = Command::new("echo") - .arg(content.as_ref()) - .status() - .expect("Failed to execute install script"); - if install_default_conf.success() { - println!("Installation script executed successfully."); - } else { - eprintln!("Installation script failed."); - } - } - None => { - eprintln!("Error: {} not found in embedded assets!", file.as_ref()); - } - } - } - - if let Some(file) = EmbeddedAssets::get("tabbed.txt") { - let embedded_content = String::from_utf8_lossy(file.data.as_ref()).to_string(); - assert_eq!(embedded_content, test_file_content); - assert!(embedded_content.contains("\t")); - assert!(embedded_content.contains(" ")); - assert!(embedded_content.lines().nth(0).unwrap().contains('\t')); - assert!(embedded_content.lines().nth(0).unwrap().contains(" ")); - assert!(embedded_content.lines().nth(1).unwrap().contains('\t')); - assert!(embedded_content.lines().nth(1).unwrap().contains(" ")); - assert!(embedded_content.lines().nth(1).unwrap().contains("\t\t")); - assert!(embedded_content.lines().nth(1).unwrap().contains(" ")); - assert!(embedded_content.lines().nth(2).unwrap().contains('\t')); - assert!(embedded_content.lines().nth(2).unwrap().contains(" ")); - assert!(!embedded_content.lines().nth(3).unwrap().starts_with('\t')); - assert!(!embedded_content.lines().nth(3).unwrap().starts_with("\t")); - assert!(!embedded_content.lines().nth(3).unwrap().starts_with(" ")); - assert!(embedded_content.lines().nth(0).unwrap().contains("h\t")); - assert!(embedded_content.lines().nth(1).unwrap().contains("r\t")); - assert!(embedded_content.lines().nth(2).unwrap().contains("\tL")); - } else { - println!("Failed to embed 'tabbed.txt'"); - } - Ok(()) - } - - #[test] - fn remove_dir_all_custom() -> io::Result<()> { - let path = Path::new("test_files"); - if path.is_dir() { - fs::remove_dir_all(path)?; - fs::create_dir_all(path)?; - } else if path.is_file() { - fs::remove_file(path)?; - fs::create_dir_all(path)?; - } else { - fs::create_dir_all(path)?; - } - test_make_test_file()?; - Ok(()) - } -} diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..4ca46ec --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,342 @@ +//! run this example with +//! cargo run --example scrollable +//! +use clap::Parser; +use pulldown_cmark::Options; +use pulldown_cmark::{html, Parser as HTMLParser}; +use rust_embed::Embed; + +use sha2::Digest; +use sha2::Sha256; +use std::io; +use std::io::{stdout, Write}; +use std::path::{Path, PathBuf}; + +use termimad::crossterm::{ + cursor::{Hide, Show}, + event::{self, Event, KeyCode::*, KeyEvent}, + queue, + style::Color::*, + terminal::{self, Clear, ClearType, EnterAlternateScreen, LeaveAlternateScreen}, +}; +use termimad::*; +use tokio::fs; +use tokio::fs::File; +use tokio::io::AsyncWriteExt; + +pub mod path; + +#[derive(Embed)] +#[folder = "."] +#[include = "*.md"] +#[exclude = "*.DS_Store"] +#[exclude = "target/*"] +#[exclude = "src"] +#[exclude = "src/*"] +#[exclude = ".git"] +#[exclude = ".git/*"] +#[exclude = ".github/*"] +#[exclude = ".gitignore"] +#[exclude = ".justfile"] +#[exclude = ".nojekyll"] +#[exclude = "build.rs"] +#[exclude = "dist-workspace.toml"] +#[exclude = "error.log"] +#[exclude = "output.log"] +#[exclude = "post-commit-history"] +#[exclude = "script.sh"] +#[exclude = "template/Makefile"] +#[exclude = "template/default_config.conf"] +#[exclude = "template/install_script.sh"] +#[exclude = "test_files/tabbed.txtbuild.rs"] +#[exclude = "Cargo.lock"] +#[exclude = "Cargo.toml"] +#[exclude = "LICENSE"] +#[exclude = "Makefile"] +pub struct Template; + +/// a simple nostr-protocol/nips server +#[derive(Parser, Debug)] +#[clap(author, version, about, long_about = None)] +pub struct Args { + /// Enable debug logging. + #[clap(short, long)] + pub debug: bool, + + /// List all embedded files. + #[clap(short, long)] + pub list_embedded: bool, + + /// Show the contents of an embedded file using a pager. + //#[clap(short, long, value_name = "NIP", default_value = "README.md")] + #[clap(short, long, value_name = "NIP")] + pub show: Option , + + /// Axum Serve. + //#[clap(long, default_value = "false")] + #[clap(long, default_value = "false")] + pub serve: bool, + + /// Sets the port number to listen on + #[arg(short, long, value_parser = clap::value_parser!(u16), default_value_t = 8080)] + pub port: u16, + + /// Export all embedded files to the current directory. + #[clap(short, long)] + pub export: bool, + + /// Export all embedded files to the current directory. + #[clap(long)] + pub export_html: bool, + + /// Export all embedded files to the specified path. + #[clap(long, value_name = "PATH")] + pub export_path: Option , + + #[arg(short, long, help = "Show USAGE.md")] + pub usage: bool, +} + +pub fn calculate_sha256(data: &[u8]) -> String { + let mut hasher = Sha256::new(); + hasher.update(data); + format!("{:x}", hasher.finalize()) +} + +pub async fn extract(filename: &str, output_dir: &Path) -> io::Result<()> { + match Template::get(filename) { + Some(embedded_file) => { + let output_path = output_dir.join(filename); + if let Some(parent) = output_path.parent() { + fs::create_dir_all(parent).await.expect(""); + } + let mut outfile = File::create(&output_path).await?; + outfile.write_all(embedded_file.data.as_ref()).await?; + tracing::trace!( + "Successfully exported '{}' to '{}'", + filename, + output_path.display() + ); + Ok(()) + } + None => Err(io::Error::new( + io::ErrorKind::NotFound, + format!("Embedded file '{}' not found!", filename), + )), + } +} + +pub async fn extract_html(filename: &str, output_dir: &Path) -> io::Result<()> { + match Template::get(filename) { + Some(embedded_file) => { + let output_path = output_dir + .join("docs") + .join(remove_md_extension(filename).to_owned() + ".html"); + if let Some(parent) = output_path.parent() { + fs::create_dir_all(parent).await.expect(""); + } + let mut outfile = File::create(&output_path).await?; + // let embedded_file_data: &'static [u8] = embedded_file.data.as_ref(); + let embedded_file_data: Vec = embedded_file.data.as_ref().to_vec(); // Create an owned Vec + + //std::str::from_utf8(embedded_file_data) + //outfile.write_all(markdown_to_html(&std::str::from_utf8(embedded_file_data).expect("")).as_bytes())?; + outfile + .write_all( + markdown_to_html(&std::str::from_utf8(&embedded_file_data).expect("")) + .as_bytes(), + ) + .await?; + + //outfile.write_all(markdown_to_html(embedded_file_data[0..5])); + tracing::trace!( + "Successfully exported '{}' to '{}'", + filename, + output_path.display() + ); + Ok(()) + } + None => Err(io::Error::new( + io::ErrorKind::NotFound, + format!("Embedded file '{}' not found!", filename), + )), + } +} + +pub fn view_area() -> Area { + let mut area = Area::full_screen(); + area.pad_for_max_width(120); // we don't want a too wide text column + area +} + +pub async fn run_app(skin: MadSkin, nip: String) -> Result<(), Error> { + let mut w = stdout(); // we could also have used stderr + queue!(w, EnterAlternateScreen)?; + terminal::enable_raw_mode()?; + queue!(w, Hide)?; // hiding the cursor + // get nip here + let mut view = MadView::from(nip.to_owned(), view_area(), skin); + loop { + view.write_on(&mut w)?; + w.flush()?; + match event::read() { + Ok(Event::Key(KeyEvent { code, .. })) => match code { + Up => view.try_scroll_lines(-1), + Down => view.try_scroll_lines(1), + PageUp => view.try_scroll_pages(-1), + PageDown => view.try_scroll_pages(1), + _ => break, + }, + Ok(Event::Resize(..)) => { + queue!(w, Clear(ClearType::All))?; + view.resize(&view_area()); + } + _ => {} + } + } + terminal::disable_raw_mode()?; + queue!(w, Show)?; // we must restore the cursor + queue!(w, LeaveAlternateScreen)?; + w.flush()?; + Ok(()) +} + +pub fn make_skin() -> MadSkin { + let mut skin = MadSkin::default(); + skin.table.align = Alignment::Center; + skin.set_headers_fg(AnsiValue(178)); + skin.bold.set_fg(Yellow); + skin.italic.set_fg(Magenta); + skin.scrollbar.thumb.set_fg(AnsiValue(178)); + skin.code_block.align = Alignment::Center; + skin +} + +pub fn markdown_to_html(markdown_input: &str) -> String { + let mut options = Options::empty(); + //options.insert(Options::all()); + options.insert(Options::ENABLE_TABLES); + options.insert(Options::ENABLE_FOOTNOTES); + options.insert(Options::ENABLE_STRIKETHROUGH); + options.insert(Options::ENABLE_TASKLISTS); + //options.insert(Options::ENABLE_SMART_PUNCTUATION); + options.insert(Options::ENABLE_HEADING_ATTRIBUTES); + options.insert(Options::ENABLE_YAML_STYLE_METADATA_BLOCKS); + options.insert(Options::ENABLE_PLUSES_DELIMITED_METADATA_BLOCKS); + options.insert(Options::ENABLE_OLD_FOOTNOTES); + options.insert(Options::ENABLE_MATH); + options.insert(Options::ENABLE_GFM); + options.insert(Options::ENABLE_DEFINITION_LIST); + options.insert(Options::ENABLE_SUPERSCRIPT); + options.insert(Options::ENABLE_SUBSCRIPT); + options.insert(Options::ENABLE_WIKILINKS); + + let parser = HTMLParser::new_ext(markdown_input, options); + let mut html_output = String::new(); + html::push_html(&mut html_output, parser); + html_output +} + +//pub fn scrollable() -> Result<(), Error> { +// let skin = make_skin(); +// run_app(skin, /* std::string::String */) +//} + +pub fn remove_md_extension(filename: &str) -> &str { + filename.strip_suffix(".md").unwrap_or(filename) +} + +static MD: &str = r#"# Scrollable Markdown in Termimad + +Use the **↓** and **↑** arrow keys to scroll this page. +Use any other key to quit the application. + +*Now I'll describe this example with more words than necessary, in order to be sure to demonstrate scrolling (and **wrapping**, too, thanks to long sentences).* + +## What's shown + +* an **area** fitting the screen (with a max width of 120, to be prettier) +* a markdown text + * **parsed**, + * **skinned**, + * and **wrapped** to fit the width +* a **scrollable** view in *raw terminal mode* + +## Area + +The area specifies the part of the screen where we'll display our markdown. + + let mut area = Area::full_screen(); + area.pad_for_max_width(120); // we don't want a too wide text column + +*(yes the code block centering in this example is a little too much, it's just here to show what's possible)* + +## Parsed Markdown + +The text is parsed from a string. In this example we directly wrap it for the width of the area: + + let text = skin.area_wrapped_text(markdown, &area); + +If we wanted to modify the parsed representation, or modify the area width, we could also have kept the parsed text (*but parsing is cheap*). + +## The TextView + +It's just a text put in an area, tracking your **scroll** position (and whether you want the scrollbar to be displayed). + + let mut text_view = TextView::from(&area, &text); + +## Really Scrolling + +Not two applications handle events in the same way. **Termimad** doesn't try to handle this but lets you write it yourself, which is fairly easily done with **Crossterm** for example: + +``` +let mut events = TerminalInput::new().read_sync(); +loop { + text_view.write()?; + if let Some(Keyboard(key)) = events.next() { + match key { + Up => text_view.try_scroll_lines(-1), + Down => text_view.try_scroll_lines(1), + PageUp => text_view.try_scroll_pages(-1), + PageDown => text_view.try_scroll_pages(1), + _ => break, + } + } +} +``` + +## Skin + +We want *shiny **colors*** (and unreasonnable centering): + + let mut skin = MadSkin::default(); + skin.set_headers_fg(rgb(255, 187, 0)); + skin.bold.set_fg(Yellow); + skin.italic.set_fgbg(Magenta, rgb(30, 30, 40)); + skin.scrollbar.track.set_fg(Rgb{r:30, g:30, b:40}); + skin.scrollbar.thumb.set_fg(Rgb{r:67, g:51, b:0}); + skin.code_block.align = Alignment::Center; + +The scrollbar's colors were also adjusted to be consistent. + +## Usage + +* **↓** and **↑** arrow keys : scroll this page +* any other key : quit + +## And let's just finish by a table + +It's a little out of context but it shows how a wide table can be wrapped in a thin terminal. + +|feature|supported|details| +|-|:-:|- +| tables | yes | pipe based only, alignement not yet supported +| italic, bold | yes | star based only| +| inline code | yes | +| code bloc | yes |with tabs. Fences not supported +| crossed text | ~~not yet~~ | wait... now it works! +| phpbb like links | no | (because it's preferable to show an URL in a terminal) + +(resize your terminal if it's too wide for wrapping to occur) + +"#; diff --git a/src/main.rs b/src/main.rs index 3c13d89..688392c 100644 --- a/src/main.rs +++ b/src/main.rs @@ -1,18 +1,22 @@ use axum::response::Redirect; - +use nips::extract; +use nips::extract_html; +use nips::markdown_to_html; +use nips::path::canonicalize_path; +use nips::run_app; +use nips::*; +use nips::{Args, Template}; //use tower_http::services::Redirect; - use axum::{ - extract::Request, /*handler::HandlerWithoutStateExt, http::StatusCode, */routing::get, Router, + extract::Request, /*handler::HandlerWithoutStateExt, http::StatusCode, */ routing::get, + Router, }; use clap::Parser; use pulldown_cmark::Options; use pulldown_cmark::{html, Parser as HTMLParser}; -use rust_embed::Embed; +use std::env; //use rust_embed::RustEmbed; use sha2::{Digest, Sha256}; -use std::env; -use std::fs; use std::fs::File; use std::io; use std::io::{stdout, Write}; @@ -29,277 +33,93 @@ use termimad::crossterm::{ terminal::{self, Clear, ClearType, EnterAlternateScreen, LeaveAlternateScreen}, }; use termimad::*; +use tokio::fs; use tower::ServiceExt; use tower_http::{ services::{ServeDir, ServeFile}, trace::TraceLayer, }; use tracing_subscriber::{fmt, layer::SubscriberExt, EnvFilter, Registry}; - -#[derive(Embed)] -#[folder = "."] -#[include = "*.md"] -#[exclude = "*.DS_Store"] -#[exclude = "target/*"] -#[exclude = "src"] -#[exclude = "src/*"] -#[exclude = ".git"] -#[exclude = ".git/*"] -#[exclude = ".github/*"] -#[exclude = ".gitignore"] -#[exclude = ".justfile"] -#[exclude = ".nojekyll"] -#[exclude = "build.rs"] -#[exclude = "dist-workspace.toml"] -#[exclude = "error.log"] -#[exclude = "output.log"] -#[exclude = "post-commit-history"] -#[exclude = "script.sh"] -#[exclude = "template/Makefile"] -#[exclude = "template/default_config.conf"] -#[exclude = "template/install_script.sh"] -#[exclude = "test_files/tabbed.txtbuild.rs"] -#[exclude = "Cargo.lock"] -#[exclude = "Cargo.toml"] -#[exclude = "LICENSE"] -#[exclude = "Makefile"] -struct Template; - -/// a simple nostr-protocol/nips server -#[derive(Parser, Debug)] -#[clap(author, version, about, long_about = None)] -struct Args { - /// Enable debug logging. - #[clap(short, long)] - debug: bool, - - /// List all embedded files. - #[clap(short, long)] - list_embedded: bool, - - /// Show the contents of an embedded file using a pager. - //#[clap(short, long, value_name = "NIP", default_value = "README.md")] - #[clap(short, long, value_name = "NIP")] - show: Option , - - /// Axum Serve. - //#[clap(long, default_value = "false")] - #[clap(long, default_value = "false")] - serve: bool, - - /// Sets the port number to listen on - #[arg(short, long, value_parser = clap::value_parser!(u16), default_value_t = 8080)] - port: u16, - - /// Export all embedded files to the current directory. - #[clap(short, long)] - export: bool, - - /// Export all embedded files to the current directory. - #[clap(long)] - export_html: bool, - - /// Export all embedded files to the specified path. - #[clap(long, value_name = "PATH")] - export_path: Option , -} - -fn _make_executable(script_path: &Path) -> io::Result<()> { - let mut permissions = fs::metadata(script_path)?.permissions(); - permissions.set_mode(permissions.mode() | 0o111); - fs::set_permissions(script_path, permissions)?; - tracing::debug!("Made '{}' executable.", script_path.display()); - Ok(()) -} - -fn _execute_script(script_path: &Path) -> io::Result<()> { - tracing::debug!("Executing script: {}", script_path.display()); - let log_file = File::create("output.log")?; - let error_file = File::create("error.log")?; - let mut command = Command::new(script_path); - command - .stdout(Stdio::from(log_file)) - .stderr(Stdio::from(error_file)); - let status = command.spawn()?.wait()?; - if status.success() { - tracing::debug!("Script '{}' executed successfully.", script_path.display()); - Ok(()) - } else { - eprintln!( - "Script '{}' failed with exit code: {:?}", - script_path.display(), - status.code() - ); - Err(io::Error::new( - io::ErrorKind::Other, - format!( - "Script execution failed with exit code: {:?}", - status.code() - ), - )) - } -} - -fn canonicalize_path(path: &Path) -> io::Result { - let absolute_path = if path.is_relative() { - let current_dir = env::current_dir()?; - current_dir.join(path) - } else { - path.to_path_buf() - }; - fs::canonicalize(absolute_path) -} - -fn extract(filename: &str, output_dir: &Path) -> io::Result<()> { - match Template::get(filename) { - Some(embedded_file) => { - let output_path = output_dir.join(filename); - if let Some(parent) = output_path.parent() { - fs::create_dir_all(parent)?; - } - let mut outfile = File::create(&output_path)?; - outfile.write_all(embedded_file.data.as_ref())?; - tracing::debug!( - "Successfully exported '{}' to '{}'", - filename, - output_path.display() +//fn _make_executable(script_path: &Path) -> io::Result<()> { +// let mut permissions = fs::metadata(script_path)?.permissions(); +// permissions.set_mode(permissions.mode() | 0o111); +// fs::set_permissions(script_path, permissions)?; +// tracing::debug!("Made '{}' executable.", script_path.display()); +// Ok(()) +//} +// +//fn _execute_script(script_path: &Path) -> io::Result<()> { +// tracing::debug!("Executing script: {}", script_path.display()); +// let log_file = File::create("output.log")?; +// let error_file = File::create("error.log")?; +// let mut command = Command::new(script_path); +// command +// .stdout(Stdio::from(log_file)) +// .stderr(Stdio::from(error_file)); +// let status = command.spawn()?.wait()?; +// if status.success() { +// tracing::debug!("Script '{}' executed successfully.", script_path.display()); +// Ok(()) +// } else { +// eprintln!( +// "Script '{}' failed with exit code: {:?}", +// script_path.display(), +// status.code() +// ); +// Err(io::Error::new( +// io::ErrorKind::Other, +// format!( +// "Script execution failed with exit code: {:?}", +// status.code() +// ), +// )) +// } +//} + +//async fn print_list() -> Result<(), Box > { +async fn print_list() -> i32 { + let args = Args::parse(); + tracing::trace!("Embedded files:"); + for file in Template::iter() { + let _level_filter = if args.debug { + let this_file = Template::get(&file).unwrap(); + //match output of shasum -a 256 + //$ shasum -a 256 README.md + //b238c63f0e937a2b3a3982ecd8328ee03be26584d10723575802e9c6f098f361 README.md + println!( + "{} {}", + calculate_sha256(this_file.data.as_ref()), + file.as_ref() ); - Ok(()) - } - None => Err(io::Error::new( - io::ErrorKind::NotFound, - format!("Embedded file '{}' not found!", filename), - )), + } else { + println!("{}", file.as_ref()); + }; } + 0 as i32 } - -fn remove_md_extension(filename: &str) -> &str { - filename.strip_suffix(".md").unwrap_or(filename) -} - -fn extract_html(filename: &str, output_dir: &Path) -> io::Result<()> { - match Template::get(filename) { +async fn usage() -> i32 { + match Template::get(&"USAGE.md") { Some(embedded_file) => { - let output_path = output_dir - .join("docs") - .join(remove_md_extension(filename).to_owned() + ".html"); - if let Some(parent) = output_path.parent() { - fs::create_dir_all(parent)?; - } - let mut outfile = File::create(&output_path)?; - // let embedded_file_data: &'static [u8] = embedded_file.data.as_ref(); - let embedded_file_data: Vec = embedded_file.data.as_ref().to_vec(); // Create an owned Vec - - //std::str::from_utf8(embedded_file_data) - //outfile.write_all(markdown_to_html(&std::str::from_utf8(embedded_file_data).expect("")).as_bytes())?; - outfile.write_all( - markdown_to_html(&std::str::from_utf8(&embedded_file_data).expect("")).as_bytes(), - )?; - - //outfile.write_all(markdown_to_html(embedded_file_data[0..5])); - tracing::debug!( - "Successfully exported '{}' to '{}'", - filename, - output_path.display() - ); - Ok(()) + let content = String::from_utf8_lossy(embedded_file.data.as_ref()); + let res = markdown_to_html(&content); + tracing::debug!("{}", res); + //print!("{}", res); + //std::process::exit(0); + //#[allow(unreachable_code)] + let skin = make_skin(); + let _res = run_app(skin, (&content).to_string()).await; } - None => Err(io::Error::new( - io::ErrorKind::NotFound, - format!("Embedded file '{}' not found!", filename), - )), - } -} - -fn view_area() -> Area { - let mut area = Area::full_screen(); - area.pad_for_max_width(120); - area -} - -#[allow(unused_variables)] -fn run_app(skin: MadSkin, nip: String) -> Result<(), Error> { - let res = markdown_to_html(&nip); - tracing::debug!("{}", res); - print!("{}", res); - //std::process::exit(0); - //#[allow(unreachable_code)] - let mut w = stdout(); - queue!(w, EnterAlternateScreen)?; - terminal::enable_raw_mode()?; - queue!(w, Hide)?; - let mut view = MadView::from(nip.to_owned(), view_area(), skin); - loop { - view.write_on(&mut w)?; - w.flush()?; - match event::read() { - Ok(Event::Key(KeyEvent { code, .. })) => match code { - Up => view.try_scroll_lines(-1), - Down => view.try_scroll_lines(1), - PageUp => view.try_scroll_pages(-1), - PageDown => view.try_scroll_pages(1), - Char('q') | Esc => break, - _ => {} - }, - Ok(Event::Resize(..)) => { - queue!(w, Clear(ClearType::All))?; - view.resize(&view_area()); - } - _ => {} + None => { + tracing::trace!("Error: {}' not found!", &"USAGE.md"); + print_list().await; } } - terminal::disable_raw_mode()?; - queue!(w, Show)?; - queue!(w, LeaveAlternateScreen)?; - w.flush()?; - Ok(()) -} - -fn make_skin() -> MadSkin { - let mut skin = MadSkin::default(); - skin.table.align = Alignment::Center; - skin.set_headers_fg(AnsiValue(178)); - skin.bold.set_fg(Yellow); - skin.italic.set_fg(Magenta); - skin.scrollbar.thumb.set_fg(AnsiValue(178)); - skin.code_block.align = Alignment::Center; - skin -} - -fn markdown_to_html(markdown_input: &str) -> String { - let mut options = Options::empty(); - //options.insert(Options::all()); - options.insert(Options::ENABLE_TABLES); - options.insert(Options::ENABLE_FOOTNOTES); - options.insert(Options::ENABLE_STRIKETHROUGH); - options.insert(Options::ENABLE_TASKLISTS); - //options.insert(Options::ENABLE_SMART_PUNCTUATION); - options.insert(Options::ENABLE_HEADING_ATTRIBUTES); - options.insert(Options::ENABLE_YAML_STYLE_METADATA_BLOCKS); - options.insert(Options::ENABLE_PLUSES_DELIMITED_METADATA_BLOCKS); - options.insert(Options::ENABLE_OLD_FOOTNOTES); - options.insert(Options::ENABLE_MATH); - options.insert(Options::ENABLE_GFM); - options.insert(Options::ENABLE_DEFINITION_LIST); - options.insert(Options::ENABLE_SUPERSCRIPT); - options.insert(Options::ENABLE_SUBSCRIPT); - options.insert(Options::ENABLE_WIKILINKS); - - let parser = HTMLParser::new_ext(markdown_input, options); - let mut html_output = String::new(); - html::push_html(&mut html_output, parser); - html_output -} - -fn calculate_sha256(data: &[u8]) -> String { - let mut hasher = Sha256::new(); - hasher.update(data); - format!("{:x}", hasher.finalize()) + 0 as i32 } #[tokio::main] async fn main() -> Result<(), Box > { - let args = Args::parse(); + let mut args = Args::parse(); let level_filter = if args.debug { EnvFilter::new("debug") @@ -313,36 +133,34 @@ async fn main() -> Result<(), Box > { tracing::subscriber::set_global_default(subscriber) .expect("Failed to set global default subscriber"); - tracing::debug!("Parsed arguments: {:?}", args); + tracing::trace!("Parsed arguments: {:?}", args); + + if args.usage { + std::process::exit(usage().await) + } else { + 0 + }; + //both cases we assume the server may already + //be running + //nips -s --serve + if args.show.is_none() && args.serve.clone() { + args.serve = false; + //std::process::exit(print_list().await); + std::process::exit(usage().await); + } else if args.show.is_none() { + args.serve = false; + } if args.list_embedded && !args.serve { - tracing::debug!("Embedded files:"); - for file in Template::iter() { - let _level_filter = if args.debug { - let this_file = Template::get(&file).unwrap(); - //match output of shasum -a 256 - //$ shasum -a 256 README.md - //b238c63f0e937a2b3a3982ecd8328ee03be26584d10723575802e9c6f098f361 README.md - println!( - "{} {}", - calculate_sha256(this_file.data.as_ref()), - file.as_ref() - ); - } else { - println!("{}", file.as_ref()); - }; - } - if !args.serve && args.list_embedded { - return Ok(()); - } + let _ = print_list().await; } if args.export && !args.serve { - tracing::info!("Exporting all embedded files to the current directory..."); + tracing::trace!("Exporting all embedded files to the current directory..."); let current_dir = env::current_dir()?; let mut export_count = 0; for file in Template::iter() { - match extract(file.as_ref(), ¤t_dir) { + match extract(file.as_ref(), ¤t_dir).await { Ok(_) => { export_count += 1; } @@ -351,17 +169,17 @@ async fn main() -> Result<(), Box > { } } } - tracing::info!("Successfully exported {} embedded files.", export_count); + tracing::trace!("Successfully exported {} embedded files.", export_count); if !args.serve && args.export { return Ok(()); } } //if args.export_html && !args.serve { - tracing::info!("Exporting all embedded files to the current directory..."); + tracing::trace!("Exporting all embedded files to the current directory..."); let current_dir = env::current_dir()?; let mut export_count = 0; for file in Template::iter() { - match extract_html(file.as_ref(), ¤t_dir) { + match extract_html(file.as_ref(), ¤t_dir).await { Ok(_) => { export_count += 1; } @@ -370,19 +188,19 @@ async fn main() -> Result<(), Box > { } } } - tracing::info!("Successfully exported {} embedded files.", export_count); + tracing::trace!("Successfully exported {} embedded files.", export_count); if !args.serve && args.export_html { return Ok(()); } //} if let Some(export_path) = &args.export_path { - tracing::info!( + tracing::trace!( "Exporting all embedded files to '{}'...", export_path.display() ); let mut export_count = 0; for file in Template::iter() { - match extract(file.as_ref(), export_path) { + match extract(file.as_ref(), export_path).await { Ok(_) => { export_count += 1; } @@ -391,7 +209,7 @@ async fn main() -> Result<(), Box > { } } } - tracing::info!( + tracing::trace!( "Successfully exported {} embedded files to '{}'.", export_count, export_path.display() @@ -413,29 +231,29 @@ async fn main() -> Result<(), Box > { let content = String::from_utf8_lossy(embedded_file.data.as_ref()); let res = markdown_to_html(&content); tracing::debug!("{}", res); - print!("{}", res); - std::process::exit(0); - #[allow(unreachable_code)] + //print!("{}", res); + //std::process::exit(0); + //#[allow(unreachable_code)] let skin = make_skin(); - let _res = run_app(skin, (&content).to_string()); + let _res = run_app(skin, (&content).to_string()).await; if !args.serve && args.show.is_some() { return Ok(()); } } None => { - eprintln!("Error: Embedded NIP file '{}' not found!", filename); - std::process::exit(1); + tracing::trace!("Error: Embedded NIP file '{}' not found!", filename); + print_list().await; } } } - tracing::debug!( + tracing::trace!( "Canonical path of '.': {}", - canonicalize_path(Path::new("."))?.display() + canonicalize_path(Path::new(".")).await?.display() ); - tracing::debug!( + tracing::trace!( "Canonical path of 'docs': {}", - canonicalize_path(Path::new("docs"))?.display() + canonicalize_path(Path::new("docs")).await?.display() ); #[cfg(windows)] @@ -443,14 +261,17 @@ async fn main() -> Result<(), Box > { #[cfg(not(windows))] let absolute_path_str = "/bin/ls"; - tracing::debug!( + tracing::trace!( "Canonical path of '{}': {}", absolute_path_str, - canonicalize_path(Path::new(absolute_path_str))?.display() + canonicalize_path(Path::new(absolute_path_str)) + .await? + .display() ); if args.serve { //MUST be true + tokio::join!(run_app(make_skin(), String::from("01"))); tokio::join!(serve(using_serve_dir_with_assets_fallback(), args.port),); } diff --git a/src/path.rs b/src/path.rs new file mode 100644 index 0000000..ac21457 --- /dev/null +++ b/src/path.rs @@ -0,0 +1,14 @@ +use std::env; +use std::fs; +use std::io; +use std::path::Path; +use std::path::PathBuf; +pub async fn canonicalize_path(path: &Path) -> io::Result { + let absolute_path = if path.is_relative() { + let current_dir = env::current_dir()?; + current_dir.join(path) + } else { + path.to_path_buf() + }; + fs::canonicalize(absolute_path) +}