mdBook/src/renderer/html_handlebars/hbs_renderer.rs

use renderer::html_handlebars::helpers;
use renderer::Renderer;
use book::MDBook;
use book::bookitem::BookItem;
use {utils, theme};

use std::path::{Path, PathBuf};
use std::fs::{self, File};
use std::error::Error;
use std::io::{self, Read, Write};
use std::collections::BTreeMap;

use handlebars::Handlebars;

use serde_json;
use serde_json::value::ToJson;


pub struct HtmlHandlebars;

impl HtmlHandlebars {
    pub fn new() -> Self {
        HtmlHandlebars
    }
}

impl Renderer for HtmlHandlebars {
    fn render(&self, book: &MDBook) -> Result<(), Box<Error>> {
        debug!("[fn]: render");
        let mut handlebars = Handlebars::new();

        // Load theme
        let theme = theme::Theme::new(book.get_theme_path());

        // Register template
        debug!("[*]: Register handlebars template");
        try!(handlebars.register_template_string("index", try!(String::from_utf8(theme.index))));

        // Register helpers
        debug!("[*]: Register handlebars helpers");
        handlebars.register_helper("toc", Box::new(helpers::toc::RenderToc));
        handlebars.register_helper("previous", Box::new(helpers::navigation::previous));
        handlebars.register_helper("next", Box::new(helpers::navigation::next));

        let mut data = try!(make_data(book));

        // Print version
        let mut print_content: String = String::new();

        // Check if dest directory exists
        debug!("[*]: Check if destination directory exists");
        if let Err(_) = fs::create_dir_all(book.get_dest()) {
            return Err(Box::new(io::Error::new(io::ErrorKind::Other,
                                               "Unexpected error when constructing destination path")));
        }

        // Render a file for every entry in the book
        let mut index = true;
        for item in book.iter() {

            match *item {
                BookItem::Chapter(_, ref ch) |
                BookItem::Affix(ref ch) => {
                    if ch.path != PathBuf::new() {

                        let path = book.get_src().join(&ch.path);

                        debug!("[*]: Opening file: {:?}", path);
                        let mut f = try!(File::open(&path));
                        let mut content: String = String::new();

                        debug!("[*]: Reading file");
                        try!(f.read_to_string(&mut content));

                        // Parse for playpen links
                        if let Some(p) = path.parent() {
                            content = helpers::playpen::render_playpen(&content, p);
                        }

                        // Render markdown using the pulldown-cmark crate
                        content = utils::render_markdown(&content);
                        print_content.push_str(&content);

                        // Remove content from previous file and render content for this one
                        data.remove("path");
                        match ch.path.to_str() {
                            Some(p) => {
                                data.insert("path".to_owned(), p.to_json());
                            },
                            None => {
                                return Err(Box::new(io::Error::new(io::ErrorKind::Other,
                                                                   "Could not convert path to str")))
                            },
                        }

                        // Remove content from previous file and render content for this one
                        data.remove("content");
                        data.insert("content".to_owned(), content.to_json());

                        // Remove chapter title from previous file and add title for this one
                        data.remove("chapter_title");
                        data.insert("chapter_title".to_owned(), ch.name.to_json());

                        // Remove path to root from previous file and render content for this one
                        data.remove("path_to_root");
                        data.insert("path_to_root".to_owned(), utils::fs::path_to_root(&ch.path).to_json());

                        // Rendere the handlebars template with the data
                        debug!("[*]: Render template");
                        let rendered = try!(handlebars.render("index", &data));

                        debug!("[*]: Create file {:?}", &book.get_dest().join(&ch.path).with_extension("html"));
                        // Write to file
                        let mut file =
                            try!(utils::fs::create_file(&book.get_dest().join(&ch.path).with_extension("html")));
                        info!("[*] Creating {:?} ✓", &book.get_dest().join(&ch.path).with_extension("html"));

                        try!(file.write_all(&rendered.into_bytes()));

                        // Create an index.html from the first element in SUMMARY.md
                        if index {
                            debug!("[*]: index.html");

                            let mut index_file = try!(File::create(book.get_dest().join("index.html")));
                            let mut content = String::new();
                            let _source = try!(File::open(book.get_dest().join(&ch.path.with_extension("html"))))
                                .read_to_string(&mut content);

                            // This could cause a problem when someone displays code containing <base href=...>
                            // on the front page, however this case should be very very rare...
                            content = content.lines()
                                .filter(|line| !line.contains("<base href="))
                                .collect::<Vec<&str>>()
                                .join("\n");

                            try!(index_file.write_all(content.as_bytes()));

                            info!("[*] Creating index.html from {:?} ✓",
                                  book.get_dest().join(&ch.path.with_extension("html")));
                            index = false;
                        }
                    }
                },
                _ => {},
            }
        }

        // Print version

        // Remove content from previous file and render content for this one
        data.remove("path");
        data.insert("path".to_owned(), "print.md".to_json());

        // Remove content from previous file and render content for this one
        data.remove("content");
        data.insert("content".to_owned(), print_content.to_json());

        // Remove path to root from previous file and render content for this one
        data.remove("path_to_root");
        data.insert("path_to_root".to_owned(), utils::fs::path_to_root(Path::new("print.md")).to_json());

        // Rendere the handlebars template with the data
        debug!("[*]: Render template");
        let rendered = try!(handlebars.render("index", &data));
        let mut file = try!(utils::fs::create_file(&book.get_dest().join("print").with_extension("html")));
        try!(file.write_all(&rendered.into_bytes()));
        info!("[*] Creating print.html ✓");

        // Copy static files (js, css, images, ...)

        debug!("[*] Copy static files");
        // JavaScript
        let mut js_file = if let Ok(f) = File::create(book.get_dest().join("book.js")) {
            f
        } else {
            return Err(Box::new(io::Error::new(io::ErrorKind::Other, "Could not create book.js")));
        };
        try!(js_file.write_all(&theme.js));

        // Css
        let mut css_file = if let Ok(f) = File::create(book.get_dest().join("book.css")) {
            f
        } else {
            return Err(Box::new(io::Error::new(io::ErrorKind::Other, "Could not create book.css")));
        };
        try!(css_file.write_all(&theme.css));

        // Favicon
        let mut favicon_file = if let Ok(f) = File::create(book.get_dest().join("favicon.png")) {
            f
        } else {
            return Err(Box::new(io::Error::new(io::ErrorKind::Other, "Could not create favicon.png")));
        };
        try!(favicon_file.write_all(&theme.favicon));

        // JQuery local fallback
        let mut jquery = if let Ok(f) = File::create(book.get_dest().join("jquery.js")) {
            f
        } else {
            return Err(Box::new(io::Error::new(io::ErrorKind::Other, "Could not create jquery.js")));
        };
        try!(jquery.write_all(&theme.jquery));

        // syntax highlighting
        let mut highlight_css = if let Ok(f) = File::create(book.get_dest().join("highlight.css")) {
            f
        } else {
            return Err(Box::new(io::Error::new(io::ErrorKind::Other, "Could not create highlight.css")));
        };
        try!(highlight_css.write_all(&theme.highlight_css));

        let mut tomorrow_night_css = if let Ok(f) = File::create(book.get_dest().join("tomorrow-night.css")) {
            f
        } else {
            return Err(Box::new(io::Error::new(io::ErrorKind::Other, "Could not create tomorrow-night.css")));
        };
        try!(tomorrow_night_css.write_all(&theme.tomorrow_night_css));

        let mut highlight_js = if let Ok(f) = File::create(book.get_dest().join("highlight.js")) {
            f
        } else {
            return Err(Box::new(io::Error::new(io::ErrorKind::Other, "Could not create highlight.js")));
        };
        try!(highlight_js.write_all(&theme.highlight_js));

        // Font Awesome local fallback
        let mut font_awesome = if let Ok(f) = utils::fs::create_file(&book.get_dest()
            .join("_FontAwesome/css/font-awesome.css")) {
            f
        } else {
            return Err(Box::new(io::Error::new(io::ErrorKind::Other, "Could not create font-awesome.css")));
        };
        try!(font_awesome.write_all(theme::FONT_AWESOME));
        let mut font_awesome = if let Ok(f) = utils::fs::create_file(&book.get_dest()
            .join("_FontAwesome/fonts/fontawesome-webfont.eot")) {
            f
        } else {
            return Err(Box::new(io::Error::new(io::ErrorKind::Other, "Could not create fontawesome-webfont.eot")));
        };
        try!(font_awesome.write_all(theme::FONT_AWESOME_EOT));
        let mut font_awesome = if let Ok(f) = utils::fs::create_file(&book.get_dest()
            .join("_FontAwesome/fonts/fontawesome-webfont.svg")) {
            f
        } else {
            return Err(Box::new(io::Error::new(io::ErrorKind::Other, "Could not create fontawesome-webfont.svg")));
        };
        try!(font_awesome.write_all(theme::FONT_AWESOME_SVG));
        let mut font_awesome = if let Ok(f) = utils::fs::create_file(&book.get_dest()
            .join("_FontAwesome/fonts/fontawesome-webfont.ttf")) {
            f
        } else {
            return Err(Box::new(io::Error::new(io::ErrorKind::Other, "Could not create fontawesome-webfont.ttf")));
        };
        try!(font_awesome.write_all(theme::FONT_AWESOME_TTF));
        let mut font_awesome = if let Ok(f) = utils::fs::create_file(&book.get_dest()
            .join("_FontAwesome/fonts/fontawesome-webfont.woff")) {
            f
        } else {
            return Err(Box::new(io::Error::new(io::ErrorKind::Other, "Could not create fontawesome-webfont.woff")));
        };
        try!(font_awesome.write_all(theme::FONT_AWESOME_WOFF));
        let mut font_awesome = if let Ok(f) = utils::fs::create_file(&book.get_dest()
            .join("_FontAwesome/fonts/fontawesome-webfont.woff2")) {
            f
        } else {
            return Err(Box::new(io::Error::new(io::ErrorKind::Other, "Could not create fontawesome-webfont.woff2")));
        };
        try!(font_awesome.write_all(theme::FONT_AWESOME_WOFF2));
        let mut font_awesome = if let Ok(f) = utils::fs::create_file(&book.get_dest()
            .join("_FontAwesome/fonts/FontAwesome.ttf")) {
            f
        } else {
            return Err(Box::new(io::Error::new(io::ErrorKind::Other, "Could not create FontAwesome.ttf")));
        };
        try!(font_awesome.write_all(theme::FONT_AWESOME_TTF));

        // Copy all remaining files
        try!(utils::fs::copy_files_except_ext(book.get_src(), book.get_dest(), true, &["md"]));

        Ok(())
    }
}

fn make_data(book: &MDBook) -> Result<serde_json::Map<String, serde_json::Value>, Box<Error>> {
    debug!("[fn]: make_data");

    let mut data = serde_json::Map::new();
    data.insert("language".to_owned(), "en".to_json());
    data.insert("title".to_owned(), book.get_title().to_json());
    data.insert("description".to_owned(), book.get_description().to_json());
    data.insert("favicon".to_owned(), "favicon.png".to_json());
    if let Some(livereload) = book.get_livereload() {
        data.insert("livereload".to_owned(), livereload.to_json());
    }

    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::Affix(ref ch) => {
                chapter.insert("name".to_owned(), ch.name.to_json());
                match ch.path.to_str() {
                    Some(p) => {
                        chapter.insert("path".to_owned(), p.to_json());
                    },
                    None => return Err(Box::new(io::Error::new(io::ErrorKind::Other, "Could not convert path to str"))),
                }
            },
            BookItem::Chapter(ref s, ref ch) => {
                chapter.insert("section".to_owned(), s.to_json());
                chapter.insert("name".to_owned(), ch.name.to_json());
                match ch.path.to_str() {
                    Some(p) => {
                        chapter.insert("path".to_owned(), p.to_json());
                    },
                    None => return Err(Box::new(io::Error::new(io::ErrorKind::Other, "Could not convert path to str"))),
                }
            },
            BookItem::Spacer => {
                chapter.insert("spacer".to_owned(), "_spacer_".to_json());
            },

        }

        chapters.push(chapter);
    }

    data.insert("chapters".to_owned(), chapters.to_json());

    debug!("[*]: JSON constructed");
    Ok(data)
}