use std::collections::HashMap; use std::fs::File; use std::io::prelude::*; use std::path::{Path, PathBuf}; use chrono::Utc; use globset::{Glob, GlobSet, GlobSetBuilder}; use syntect::parsing::{SyntaxSet, SyntaxSetBuilder}; use toml; use toml::Value as Toml; use errors::{Result, ResultExt}; use highlighting::THEME_SET; use theme::Theme; // We want a default base url for tests static DEFAULT_BASE_URL: &'static str = "http://a-website.com"; #[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] #[serde(default)] pub struct Language { /// The language code pub code: String, /// Whether to generate a RSS feed for that language, defaults to `false` pub rss: bool, } impl Default for Language { fn default() -> Language { Language { code: String::new(), rss: false } } } #[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] #[serde(default)] pub struct Taxonomy { /// The name used in the URL, usually the plural pub name: String, /// If this is set, the list of individual taxonomy term page will be paginated /// by this much pub paginate_by: Option, pub paginate_path: Option, /// Whether to generate a RSS feed only for each taxonomy term, defaults to false pub rss: bool, } impl Taxonomy { pub fn is_paginated(&self) -> bool { if let Some(paginate_by) = self.paginate_by { paginate_by > 0 } else { false } } pub fn paginate_path(&self) -> &str { if let Some(ref path) = self.paginate_path { path } else { "page" } } } impl Default for Taxonomy { fn default() -> Taxonomy { Taxonomy { name: String::new(), paginate_by: None, paginate_path: None, rss: false } } } #[derive(Clone, Debug, Serialize, Deserialize)] #[serde(default)] pub struct Config { /// Base URL of the site, the only required config argument pub base_url: String, /// Theme to use pub theme: Option, /// Title of the site. Defaults to None pub title: Option, /// Description of the site pub description: Option, /// The language used in the site. Defaults to "en" pub default_language: String, /// The list of supported languages outside of the default one pub languages: Vec, /// Languages list and translated strings pub translations: HashMap, /// Whether to highlight all code blocks found in markdown files. Defaults to false pub highlight_code: bool, /// Which themes to use for code highlighting. See Readme for supported themes /// Defaults to "base16-ocean-dark" pub highlight_theme: String, /// Whether to generate RSS. Defaults to false pub generate_rss: bool, /// The number of articles to include in the RSS feed. Defaults to including all items. pub rss_limit: Option, pub taxonomies: Vec, /// Whether to compile the `sass` directory and output the css files into the static folder pub compile_sass: bool, /// Whether to build the search index for the content pub build_search_index: bool, /// A list of file glob patterns to ignore when processing the content folder. Defaults to none. /// Had to remove the PartialEq derive because GlobSet does not implement it. No impact /// because it's unused anyway (who wants to sort Configs?). pub ignored_content: Vec, #[serde(skip_serializing, skip_deserializing)] // not a typo, 2 are needed pub ignored_content_globset: Option, /// Whether to check all external links for validity pub check_external_links: bool, /// A list of directories to search for additional `.sublime-syntax` files in. pub extra_syntaxes: Vec, /// The compiled extra syntaxes into a syntax set #[serde(skip_serializing, skip_deserializing)] // not a typo, 2 are need pub extra_syntax_set: Option, /// All user params set in [extra] in the config pub extra: HashMap, /// Set automatically when instantiating the config. Used for cachebusting pub build_timestamp: Option, } impl Config { /// Parses a string containing TOML to our Config struct /// Any extra parameter will end up in the extra field pub fn parse(content: &str) -> Result { let mut config: Config = match toml::from_str(content) { Ok(c) => c, Err(e) => bail!(e), }; if config.base_url.is_empty() || config.base_url == DEFAULT_BASE_URL { bail!("A base URL is required in config.toml with key `base_url`"); } if !THEME_SET.themes.contains_key(&config.highlight_theme) { bail!("Highlight theme {} not available", config.highlight_theme) } config.build_timestamp = Some(Utc::now().timestamp()); if !config.ignored_content.is_empty() { // Convert the file glob strings into a compiled glob set matcher. We want to do this once, // at program initialization, rather than for every page, for example. We arrange for the // globset matcher to always exist (even though it has to be an inside an Option at the // moment because of the TOML serializer); if the glob set is empty the `is_match` function // of the globber always returns false. let mut glob_set_builder = GlobSetBuilder::new(); for pat in &config.ignored_content { let glob = match Glob::new(pat) { Ok(g) => g, Err(e) => bail!("Invalid ignored_content glob pattern: {}, error = {}", pat, e), }; glob_set_builder.add(glob); } config.ignored_content_globset = Some(glob_set_builder.build().expect("Bad ignored_content in config file.")); } Ok(config) } /// Parses a config file from the given path pub fn from_file>(path: P) -> Result { let mut content = String::new(); let path = path.as_ref(); let file_name = path.file_name().unwrap(); File::open(path) .chain_err(|| { format!("No `{:?}` file found. Are you in the right directory?", file_name) })? .read_to_string(&mut content)?; Config::parse(&content) } /// Attempt to load any extra syntax found in the extra syntaxes of the config pub fn load_extra_syntaxes(&mut self, base_path: &Path) -> Result<()> { if self.extra_syntaxes.is_empty() { return Ok(()); } let mut ss = SyntaxSetBuilder::new(); for dir in &self.extra_syntaxes { ss.add_from_folder(base_path.join(dir), true)?; } self.extra_syntax_set = Some(ss.build()); Ok(()) } /// Makes a url, taking into account that the base url might have a trailing slash pub fn make_permalink(&self, path: &str) -> String { let trailing_bit = if path.ends_with('/') || path.ends_with("rss.xml") || path.is_empty() { "" } else { "/" }; // Index section with a base url that has a trailing slash if self.base_url.ends_with('/') && path == "/" { self.base_url.clone() } else if path == "/" { // index section with a base url that doesn't have a trailing slash format!("{}/", self.base_url) } else if self.base_url.ends_with('/') && path.starts_with('/') { format!("{}{}{}", self.base_url, &path[1..], trailing_bit) } else if self.base_url.ends_with('/') || path.starts_with('/') { format!("{}{}{}", self.base_url, path, trailing_bit) } else { format!("{}/{}{}", self.base_url, path, trailing_bit) } } /// Merges the extra data from the theme with the config extra data fn add_theme_extra(&mut self, theme: &Theme) -> Result<()> { // 3 pass merging // 1. save config to preserve user let original = self.extra.clone(); // 2. inject theme extra values for (key, val) in &theme.extra { self.extra.entry(key.to_string()).or_insert_with(|| val.clone()); } // 3. overwrite with original config for (key, val) in &original { self.extra.entry(key.to_string()).or_insert_with(|| val.clone()); } Ok(()) } /// Parse the theme.toml file and merges the extra data from the theme /// with the config extra data pub fn merge_with_theme(&mut self, path: &PathBuf) -> Result<()> { let theme = Theme::from_file(path)?; self.add_theme_extra(&theme) } /// Is this site using i18n? pub fn is_multilingual(&self) -> bool { !self.languages.is_empty() } /// Returns the codes of all additional languages pub fn languages_codes(&self) -> Vec<&str> { self.languages.iter().map(|l| l.code.as_ref()).collect() } } impl Default for Config { fn default() -> Config { Config { base_url: DEFAULT_BASE_URL.to_string(), title: None, description: None, theme: None, highlight_code: false, highlight_theme: "base16-ocean-dark".to_string(), default_language: "en".to_string(), languages: Vec::new(), generate_rss: false, rss_limit: None, taxonomies: Vec::new(), compile_sass: false, check_external_links: false, build_search_index: false, ignored_content: Vec::new(), ignored_content_globset: None, translations: HashMap::new(), extra_syntaxes: Vec::new(), extra_syntax_set: None, extra: HashMap::new(), build_timestamp: Some(1), } } } #[cfg(test)] mod tests { use super::{Config, Theme}; #[test] fn can_import_valid_config() { let config = r#" title = "My site" base_url = "https://replace-this-with-your-url.com" "#; let config = Config::parse(config).unwrap(); assert_eq!(config.title.unwrap(), "My site".to_string()); } #[test] fn errors_when_invalid_type() { let config = r#" title = 1 base_url = "https://replace-this-with-your-url.com" "#; let config = Config::parse(config); assert!(config.is_err()); } #[test] fn errors_when_missing_required_field() { // base_url is required let config = r#" title = "" "#; let config = Config::parse(config); assert!(config.is_err()); } #[test] fn can_add_extra_values() { let config = r#" title = "My site" base_url = "https://replace-this-with-your-url.com" [extra] hello = "world" "#; let config = Config::parse(config); assert!(config.is_ok()); assert_eq!(config.unwrap().extra.get("hello").unwrap().as_str().unwrap(), "world"); } #[test] fn can_make_url_index_page_with_non_trailing_slash_url() { let mut config = Config::default(); config.base_url = "http://vincent.is".to_string(); assert_eq!(config.make_permalink(""), "http://vincent.is/"); } #[test] fn can_make_url_index_page_with_railing_slash_url() { let mut config = Config::default(); config.base_url = "http://vincent.is/".to_string(); assert_eq!(config.make_permalink(""), "http://vincent.is/"); } #[test] fn can_make_url_with_non_trailing_slash_base_url() { let mut config = Config::default(); config.base_url = "http://vincent.is".to_string(); assert_eq!(config.make_permalink("hello"), "http://vincent.is/hello/"); } #[test] fn can_make_url_with_trailing_slash_path() { let mut config = Config::default(); config.base_url = "http://vincent.is/".to_string(); assert_eq!(config.make_permalink("/hello"), "http://vincent.is/hello/"); } #[test] fn can_make_url_with_localhost() { let mut config = Config::default(); config.base_url = "http://127.0.0.1:1111".to_string(); assert_eq!(config.make_permalink("/tags/rust"), "http://127.0.0.1:1111/tags/rust/"); } // https://github.com/Keats/gutenberg/issues/486 #[test] fn doesnt_add_trailing_slash_to_rss() { let mut config = Config::default(); config.base_url = "http://vincent.is/".to_string(); assert_eq!(config.make_permalink("rss.xml"), "http://vincent.is/rss.xml"); } #[test] fn can_merge_with_theme_data_and_preserve_config_value() { let config_str = r#" title = "My site" base_url = "https://replace-this-with-your-url.com" [extra] hello = "world" "#; let mut config = Config::parse(config_str).unwrap(); let theme_str = r#" [extra] hello = "foo" a_value = 10 "#; let theme = Theme::parse(theme_str).unwrap(); assert!(config.add_theme_extra(&theme).is_ok()); let extra = config.extra; assert_eq!(extra["hello"].as_str().unwrap(), "world".to_string()); assert_eq!(extra["a_value"].as_integer().unwrap(), 10); } #[test] fn can_use_language_configuration() { let config = r#" base_url = "https://remplace-par-ton-url.fr" default_language = "fr" [translations] [translations.fr] title = "Un titre" [translations.en] title = "A title" "#; let config = Config::parse(config); assert!(config.is_ok()); let translations = config.unwrap().translations; assert_eq!(translations["fr"]["title"].as_str().unwrap(), "Un titre"); assert_eq!(translations["en"]["title"].as_str().unwrap(), "A title"); } #[test] fn missing_ignored_content_results_in_empty_vector_and_empty_globset() { let config_str = r#" title = "My site" base_url = "example.com" "#; let config = Config::parse(config_str).unwrap(); let v = config.ignored_content; assert_eq!(v.len(), 0); assert!(config.ignored_content_globset.is_none()); } #[test] fn empty_ignored_content_results_in_empty_vector_and_empty_globset() { let config_str = r#" title = "My site" base_url = "example.com" ignored_content = [] "#; let config = Config::parse(config_str).unwrap(); assert_eq!(config.ignored_content.len(), 0); assert!(config.ignored_content_globset.is_none()); } #[test] fn non_empty_ignored_content_results_in_vector_of_patterns_and_configured_globset() { let config_str = r#" title = "My site" base_url = "example.com" ignored_content = ["*.{graphml,iso}", "*.py?"] "#; let config = Config::parse(config_str).unwrap(); let v = config.ignored_content; assert_eq!(v, vec!["*.{graphml,iso}", "*.py?"]); let g = config.ignored_content_globset.unwrap(); assert_eq!(g.len(), 2); assert!(g.is_match("foo.graphml")); assert!(g.is_match("foo.iso")); assert!(!g.is_match("foo.png")); assert!(g.is_match("foo.py2")); assert!(g.is_match("foo.py3")); assert!(!g.is_match("foo.py")); } }