use renderer::html_handlebars::helpers; use preprocess; use renderer::{RenderContext, Renderer}; use book::{Book, BookItem, Chapter}; use config::{Config, HtmlConfig, Playpen}; use {theme, utils}; use theme::{playpen_editor, Theme}; use errors::*; use regex::{Captures, Regex}; #[allow(unused_imports)] use std::ascii::AsciiExt; use std::path::{Path, PathBuf}; use std::fs::{self, File}; use std::io::{self, Read, Write}; use std::collections::BTreeMap; use std::collections::HashMap; use handlebars::Handlebars; use serde_json; #[derive(Default)] pub struct HtmlHandlebars; impl HtmlHandlebars { pub fn new() -> Self { HtmlHandlebars } fn write_file>( &self, build_dir: &Path, filename: P, content: &[u8], ) -> Result<()> { let path = build_dir.join(filename); utils::fs::create_file(&path)? .write_all(content) .map_err(|e| e.into()) } fn render_item( &self, item: &BookItem, mut ctx: RenderItemContext, print_content: &mut String, ) -> Result<()> { // FIXME: This should be made DRY-er and rely less on mutable state match *item { BookItem::Chapter(ref ch) => { let content = ch.content.clone(); let base = ch.path.parent() .map(|dir| ctx.src_dir.join(dir)) .expect("All chapters must have a parent directory"); // Parse and expand links let content = preprocess::links::replace_all(&content, base)?; let content = utils::render_markdown(&content, ctx.html_config.curly_quotes); print_content.push_str(&content); // Update the context with data for this file let path = ch.path.to_str().ok_or_else(|| { io::Error::new(io::ErrorKind::Other, "Could not convert path \ to str") })?; // "print.html" is used for the print page. if ch.path == Path::new("print.md") { bail!(ErrorKind::ReservedFilenameError(ch.path.clone())); }; // Non-lexical lifetimes needed :'( let title: String; { let book_title = ctx.data .get("book_title") .and_then(serde_json::Value::as_str) .unwrap_or(""); title = ch.name.clone() + " - " + book_title; } ctx.data.insert("path".to_owned(), json!(path)); ctx.data.insert("content".to_owned(), json!(content)); ctx.data.insert("chapter_title".to_owned(), json!(ch.name)); ctx.data.insert("title".to_owned(), json!(title)); ctx.data.insert("path_to_root".to_owned(), json!(utils::fs::path_to_root(&ch.path))); // Render the handlebars template with the data debug!("[*]: Render template"); let rendered = ctx.handlebars.render("index", &ctx.data)?; let filepath = Path::new(&ch.path).with_extension("html"); let rendered = self.post_process( rendered, &normalize_path(filepath.to_str().ok_or_else(|| { Error::from(format!("Bad file name: {}", filepath.display())) })?), &ctx.html_config.playpen, ); // Write to file info!("[*] Creating {:?} ✓", filepath.display()); self.write_file(&ctx.destination, filepath, &rendered.into_bytes())?; if ctx.is_index { self.render_index(ch, &ctx.destination)?; } } _ => {} } Ok(()) } /// Create an index.html from the first element in SUMMARY.md fn render_index(&self, ch: &Chapter, destination: &Path) -> Result<()> { debug!("[*]: index.html"); let mut content = String::new(); File::open(destination.join(&ch.path.with_extension("html")))? .read_to_string(&mut content)?; // This could cause a problem when someone displays // code containing // on the front page, however this case should be very very rare... content = content.lines() .filter(|line| !line.contains(" String { let rendered = build_header_links(&rendered, filepath); let rendered = fix_anchor_links(&rendered, filepath); let rendered = fix_code_blocks(&rendered); let rendered = add_playpen_pre(&rendered, playpen_config); rendered } fn copy_static_files( &self, destination: &Path, theme: &Theme, html_config: &HtmlConfig, ) -> Result<()> { self.write_file(destination, "book.js", &theme.js)?; self.write_file(destination, "book.css", &theme.css)?; self.write_file(destination, "favicon.png", &theme.favicon)?; self.write_file(destination, "jquery.js", &theme.jquery)?; self.write_file(destination, "highlight.css", &theme.highlight_css)?; self.write_file(destination, "tomorrow-night.css", &theme.tomorrow_night_css)?; self.write_file(destination, "ayu-highlight.css", &theme.ayu_highlight_css)?; self.write_file(destination, "highlight.js", &theme.highlight_js)?; self.write_file(destination, "clipboard.min.js", &theme.clipboard_js)?; self.write_file(destination, "store.js", &theme.store_js)?; self.write_file( destination, "_FontAwesome/css/font-awesome.css", theme::FONT_AWESOME, )?; self.write_file( destination, "_FontAwesome/fonts/fontawesome-webfont.eot", theme::FONT_AWESOME_EOT, )?; self.write_file( destination, "_FontAwesome/fonts/fontawesome-webfont.svg", theme::FONT_AWESOME_SVG, )?; self.write_file( destination, "_FontAwesome/fonts/fontawesome-webfont.ttf", theme::FONT_AWESOME_TTF, )?; self.write_file( destination, "_FontAwesome/fonts/fontawesome-webfont.woff", theme::FONT_AWESOME_WOFF, )?; self.write_file( destination, "_FontAwesome/fonts/fontawesome-webfont.woff2", theme::FONT_AWESOME_WOFF2, )?; self.write_file( destination, "_FontAwesome/fonts/FontAwesome.ttf", theme::FONT_AWESOME_TTF, )?; let playpen_config = &html_config.playpen; // Ace is a very large dependency, so only load it when requested if playpen_config.editable { // Load the editor let editor = playpen_editor::PlaypenEditor::new(&playpen_config.editor); self.write_file(destination, "editor.js", &editor.js)?; self.write_file(destination, "ace.js", &editor.ace_js)?; self.write_file(destination, "mode-rust.js", &editor.mode_rust_js)?; self.write_file(destination, "theme-dawn.js", &editor.theme_dawn_js)?; self.write_file(destination, "theme-tomorrow_night.js", &editor.theme_tomorrow_night_js, )?; } Ok(()) } /// Update the context with data for this file fn configure_print_version(&self, data: &mut serde_json::Map, print_content: &str) { // Make sure that the Print chapter does not display the title from // the last rendered chapter by removing it from its context data.remove("title"); data.insert("is_print".to_owned(), json!(true)); data.insert("path".to_owned(), json!("print.md")); data.insert("content".to_owned(), json!(print_content)); data.insert("path_to_root".to_owned(), json!(utils::fs::path_to_root(Path::new("print.md")))); } fn register_hbs_helpers(&self, handlebars: &mut Handlebars, html_config: &HtmlConfig) { handlebars.register_helper("toc", Box::new(helpers::toc::RenderToc {no_section_label: html_config.no_section_label})); handlebars.register_helper("previous", Box::new(helpers::navigation::previous)); handlebars.register_helper("next", Box::new(helpers::navigation::next)); } /// Copy across any additional CSS and JavaScript files which the book /// has been configured to use. fn copy_additional_css_and_js(&self, html: &HtmlConfig, destination: &Path) -> Result<()> { let custom_files = html.additional_css.iter().chain(html.additional_js.iter()); debug!("Copying additional CSS and JS"); for custom_file in custom_files { let output_location = destination.join(custom_file); debug!( "Copying {} -> {}", custom_file.display(), output_location.display() ); fs::copy(custom_file, &output_location).chain_err(|| { format!( "Unable to copy {} to {}", custom_file.display(), output_location.display() ) })?; } Ok(()) } } impl Renderer for HtmlHandlebars { fn name(&self) -> &str { "html" } fn render(&self, ctx: &RenderContext) -> Result<()> { let html_config = ctx.config.html_config().unwrap_or_default(); let src_dir = ctx.root.join(&ctx.config.book.src); let destination = &ctx.destination; let book = &ctx.book; debug!("[fn]: render"); let mut handlebars = Handlebars::new(); let theme_dir = match html_config.theme { Some(ref theme) => theme.to_path_buf(), None => src_dir.join("theme"), }; let theme = theme::Theme::new(theme_dir); debug!("[*]: Register the index handlebars template"); handlebars.register_template_string( "index", String::from_utf8(theme.index.clone())?, )?; debug!("[*]: Register the header handlebars template"); handlebars.register_partial( "header", String::from_utf8(theme.header.clone())?, )?; debug!("[*]: Register handlebars helpers"); self.register_hbs_helpers(&mut handlebars, &html_config); let mut data = make_data(&ctx.root, &book, &ctx.config, &html_config)?; // Print version let mut print_content = String::new(); debug!("[*]: Check if destination directory exists"); fs::create_dir_all(&destination) .chain_err(|| "Unexpected error when constructing destination path")?; for (i, item) in book.iter().enumerate() { let ctx = RenderItemContext { handlebars: &handlebars, destination: destination.to_path_buf(), src_dir: src_dir.clone(), data: data.clone(), is_index: i == 0, html_config: html_config.clone(), }; self.render_item(item, ctx, &mut print_content)?; } // Print version self.configure_print_version(&mut data, &print_content); if let Some(ref title) = ctx.config.book.title { data.insert("title".to_owned(), json!(title)); } // Render the handlebars template with the data debug!("[*]: Render template"); let rendered = handlebars.render("index", &data)?; let rendered = self.post_process(rendered, "print.html", &html_config.playpen); self.write_file(&destination, "print.html", &rendered.into_bytes())?; info!("[*] Creating print.html ✓"); debug!("[*] Copy static files"); self.copy_static_files(&destination, &theme, &html_config) .chain_err(|| "Unable to copy across static files")?; self.copy_additional_css_and_js(&html_config, &destination) .chain_err(|| "Unable to copy across additional CSS and JS")?; // Copy all remaining files utils::fs::copy_files_except_ext(&src_dir, &destination, true, &["md"])?; Ok(()) } } fn make_data(root: &Path, book: &Book, config: &Config, html_config: &HtmlConfig) -> Result> { debug!("[fn]: make_data"); let html = config.html_config().unwrap_or_default(); let mut data = serde_json::Map::new(); data.insert("language".to_owned(), json!("en")); data.insert("book_title".to_owned(), json!(config.book.title.clone().unwrap_or_default())); data.insert("description".to_owned(), json!(config.book.description.clone().unwrap_or_default())); data.insert("favicon".to_owned(), json!("favicon.png")); if let Some(ref livereload) = html_config.livereload_url { data.insert("livereload".to_owned(), json!(livereload)); } // Add google analytics tag if let Some(ref ga) = config.html_config().and_then(|html| html.google_analytics) { data.insert("google_analytics".to_owned(), json!(ga)); } if html.mathjax_support { data.insert("mathjax_support".to_owned(), json!(true)); } // Add check to see if there is an additional style if !html.additional_css.is_empty() { let mut css = Vec::new(); for style in &html.additional_css { match style.strip_prefix(root) { Ok(p) => css.push(p.to_str().expect("Could not convert to str")), Err(_) => { css.push(style.file_name() .expect("File has a file name") .to_str() .expect("Could not convert to str")) } } } data.insert("additional_css".to_owned(), json!(css)); } // Add check to see if there is an additional script if !html.additional_js.is_empty() { let mut js = Vec::new(); for script in &html.additional_js { match script.strip_prefix(root) { Ok(p) => js.push(p.to_str().expect("Could not convert to str")), Err(_) => { js.push(script.file_name() .expect("File has a file name") .to_str() .expect("Could not convert to str")) } } } data.insert("additional_js".to_owned(), json!(js)); } if html.playpen.editable { data.insert("playpens_editable".to_owned(), json!(true)); data.insert("editor_js".to_owned(), json!("editor.js")); data.insert("ace_js".to_owned(), json!("ace.js")); data.insert("mode_rust_js".to_owned(), json!("mode-rust.js")); data.insert("theme_dawn_js".to_owned(), json!("theme-dawn.js")); data.insert("theme_tomorrow_night_js".to_owned(), json!("theme-tomorrow_night.js")); } let mut chapters = vec![]; for item in book.iter() { // Create the data to inject in the template let mut chapter = BTreeMap::new(); match *item { BookItem::Chapter(ref ch) => { if let Some(ref section) = ch.number { chapter.insert("section".to_owned(), json!(section.to_string())); } chapter.insert("name".to_owned(), json!(ch.name)); let path = ch.path.to_str().ok_or_else(|| { io::Error::new(io::ErrorKind::Other, "Could not convert path \ to str") })?; chapter.insert("path".to_owned(), json!(path)); } BookItem::Separator => { chapter.insert("spacer".to_owned(), json!("_spacer_")); } } chapters.push(chapter); } data.insert("chapters".to_owned(), json!(chapters)); debug!("[*]: JSON constructed"); Ok(data) } /// Goes through the rendered HTML, making sure all header tags are wrapped in /// an anchor so people can link to sections directly. fn build_header_links(html: &str, filepath: &str) -> String { let regex = Regex::new(r"(.*?)").unwrap(); let mut id_counter = HashMap::new(); regex.replace_all(html, |caps: &Captures| { let level = caps[1].parse() .expect("Regex should ensure we only ever get numbers here"); wrap_header_with_link(level, &caps[2], &mut id_counter, filepath) }) .into_owned() } /// Wraps a single header tag with a link, making sure each tag gets its own /// unique ID by appending an auto-incremented number (if necessary). fn wrap_header_with_link(level: usize, content: &str, id_counter: &mut HashMap, filepath: &str) -> String { let raw_id = id_from_content(content); let id_count = id_counter.entry(raw_id.clone()).or_insert(0); let id = match *id_count { 0 => raw_id, other => format!("{}-{}", raw_id, other), }; *id_count += 1; format!( r##"{text}"##, level = level, id = id, text = content, filepath = filepath ) } /// Generate an id for use with anchors which is derived from a "normalised" /// string. fn id_from_content(content: &str) -> String { let mut content = content.to_string(); // Skip any tags or html-encoded stuff const REPL_SUB: &[&str] = &["", "", "", "", "", "", "<", ">", "&", "'", """]; for sub in REPL_SUB { content = content.replace(sub, ""); } // Remove spaces and hastags indicating a header let trimmed = content.trim().trim_left_matches('#').trim(); normalize_id(trimmed) } // anchors to the same page (href="#anchor") do not work because of // pointing to the root folder. This function *fixes* // that in a very inelegant way fn fix_anchor_links(html: &str, filepath: &str) -> String { let regex = Regex::new(r##"]+)href="#([^"]+)"([^>]*)>"##).unwrap(); regex.replace_all(html, |caps: &Captures| { let before = &caps[1]; let anchor = &caps[2]; let after = &caps[3]; format!("", before = before, filepath = filepath, anchor = anchor, after = after) }) .into_owned() } // The rust book uses annotations for rustdoc to test code snippets, // like the following: // ```rust,should_panic // fn main() { // // Code here // } // ``` // This function replaces all commas by spaces in the code block classes fn fix_code_blocks(html: &str) -> String { let regex = Regex::new(r##"]+)class="([^"]+)"([^>]*)>"##).unwrap(); regex.replace_all(html, |caps: &Captures| { let before = &caps[1]; let classes = &caps[2].replace(",", " "); let after = &caps[3]; format!(r#""#, before = before, classes = classes, after = after) }) .into_owned() } fn add_playpen_pre(html: &str, playpen_config: &Playpen) -> String { let regex = Regex::new(r##"((?s)]?class="([^"]+)".*?>(.*?))"##).unwrap(); regex.replace_all(html, |caps: &Captures| { let text = &caps[1]; let classes = &caps[2]; let code = &caps[3]; if (classes.contains("language-rust") && !classes.contains("ignore")) || classes.contains("mdbook-runnable") { // wrap the contents in an external pre block if playpen_config.editable && classes.contains("editable") || text.contains("fn main") || text.contains("quick_main!") { format!("
{}
", text) } else { // we need to inject our own main let (attrs, code) = partition_source(code); format!("
\n# \
                         #![allow(unused_variables)]\n\
                         {}#fn main() {{\n\
                         {}\
                         #}}
", classes, attrs, code) } } else { // not language-rust, so no-op text.to_owned() } }) .into_owned() } fn partition_source(s: &str) -> (String, String) { let mut after_header = false; let mut before = String::new(); let mut after = String::new(); for line in s.lines() { let trimline = line.trim(); let header = trimline.chars().all(|c| c.is_whitespace()) || trimline.starts_with("#!["); if !header || after_header { after_header = true; after.push_str(line); after.push_str("\n"); } else { before.push_str(line); before.push_str("\n"); } } (before, after) } struct RenderItemContext<'a> { handlebars: &'a Handlebars, destination: PathBuf, src_dir: PathBuf, data: serde_json::Map, is_index: bool, html_config: HtmlConfig, } pub fn normalize_path(path: &str) -> String { use std::path::is_separator; path.chars() .map(|ch| if is_separator(ch) { '/' } else { ch }) .collect::() } pub fn normalize_id(content: &str) -> String { content.chars() .filter_map(|ch| if ch.is_alphanumeric() || ch == '_' || ch == '-' { Some(ch.to_ascii_lowercase()) } else if ch.is_whitespace() { Some('-') } else { None }) .collect::() } #[cfg(test)] mod tests { use super::*; #[test] fn original_build_header_links() { let inputs = vec![ ( "blah blah

Foo

", r##"blah blah

Foo

"##, ), ( "

Foo

", r##"

Foo

"##, ), ( "

Foo^bar

", r##"

Foo^bar

"##, ), ( "

", r##"

"##, ), ( "

", r##"

"##, ), ( "

Foo

Foo

", r##"

Foo

Foo

"##, ), ]; for (src, should_be) in inputs { let filepath = "./some_chapter/some_section.html"; let got = build_header_links(&src, filepath); assert_eq!(got, should_be); // This is redundant for most cases let got = fix_anchor_links(&got, filepath); assert_eq!(got, should_be); } } #[test] fn anchor_generation() { assert_eq!(id_from_content("## `--passes`: add more rustdoc passes"), "--passes-add-more-rustdoc-passes"); assert_eq!(id_from_content("## Method-call expressions"), "method-call-expressions"); } }