gettext-rs 0.4.1

use locale_config::{LanguageRange, Locale};

use std::default::Default;
use std::env;
use std::fmt;
use std::fs;
use std::path::PathBuf;

use super::{bind_textdomain_codeset, bindtextdomain, setlocale, textdomain, LocaleCategory};

#[derive(Debug, PartialEq)]
pub enum TextDomainError {
    /// The locale is malformed.
    InvalidLocale(String),
    /// The translation for the requested language could not be found or the search path is empty.
    TranslationNotFound(String),
}

/// A text domain initializer builder which finds the path to bind by searching translations
/// in the system data paths and optionally in user specified paths.
///
/// `TextDomain` takes care of calling the [`setlocale`], [`bindtextdomain`],
/// [`bind_textdomain_codeset`] and [`textdomain`].
///
///
/// # Defaults
///
/// - Current user's locale is selected by default. You can override this behaviour by calling
/// [`locale`].
/// - [`LocaleCategory::LcMessages`] is used when calling [`setlocale`]. Use [`locale_category`]
/// to override.
/// - [`bind_textdomain_codeset`] is not invoked by default. Use [`codeset`] to specify a `codeset`.
/// - System data paths are searched by default (see below for details). Use
/// [`skip_system_data_paths`] to limit the search to user provided paths.
///
/// # Text domain path binding
///
/// A translation file for the text domain is searched in the following paths (in order):
///
/// 1. Paths added using the [`prepend`] function.
/// 1. Paths from the `XDG_DATA_DIRS` environment variable, except if the function
/// [`skip_system_data_paths`] was invoked. If `XDG_DATA_DIRS` is not defined, current path is used.
/// 1. Paths added using the [`push`] function.
///
/// For each `path` in the search paths, the following subdirectories are scanned:
/// `path/locale/lang*/LC_MESSAGES` (where `lang` is the language part of the selected locale).
/// The first `path` containing a file matching `name.mo` is used for the call to
/// [`bindtextdomain`].
///
/// # Examples
///
/// Basic usage:
///
/// ```no_run
/// use gettextrs::TextDomain;
///
/// TextDomain::new("my_textdomain")
///            .init()
///            .unwrap();
/// ```
///
/// Use the translation in current language under the `target` directory if available, otherwise
/// search system defined paths:
///
/// ```no_run
/// use gettextrs::TextDomain;
///
/// TextDomain::new("my_textdomain")
///            .prepend("target")
///            .init()
///            .unwrap();
/// ```
///
/// Scan the `target` directory only, force locale to `fr_FR` and handle errors:
///
/// ```no_run
/// use gettextrs::{TextDomain, TextDomainError};
///
/// let init_msg = match TextDomain::new("my_textdomain")
///     .skip_system_data_paths()
///     .push("target")
///     .locale("fr_FR")
///     .init()
/// {
///     Ok(locale) => {
///         format!("translation found, `setlocale` returned {:?}", locale)
///     }
///     Err(TextDomainError::TranslationNotFound(lang)) => {
///         format!("translation not found for {}", lang)
///     }
///     Err(TextDomainError::InvalidLocale(locale)) => {
///         format!("invalid locale {}", locale)
///     }
/// };
/// println!("Textdomain init result: {}", init_msg);
/// ```
///
/// [`setlocale`]: fn.setlocale.html
/// [`bindtextdomain`]: fn.bindtextdomain.html
/// [`bind_textdomain_codeset`]: fn.bind_textdomain_codeset.html
/// [`textdomain`]: fn.textdomain.html
/// [`LocaleCategory::LcMessages`]: enum.LocaleCategory.html#variant.LcMessages
/// [`locale`]: struct.TextDomain.html#method.locale
/// [`locale_category`]: struct.TextDomain.html#method.locale_category
/// [`codeset`]: struct.TextDomain.html#method.codeset
/// [`skip_system_data_paths`]: struct.TextDomain.html#method.skip_system_data_paths
/// [`prepend`]: struct.TextDomain.html#method.prepend
/// [`push`]: struct.TextDomain.html#method.push
#[derive(Default)]
pub struct TextDomain {
    name: Option<String>,
    locale: Option<String>,
    locale_category: Option<LocaleCategory>,
    codeset: Option<String>,
    pre_paths: Vec<PathBuf>,
    post_paths: Vec<PathBuf>,
    skip_system_data_paths: bool,
}

impl TextDomain {
    /// Creates a new builder instance of `TextDomain` with the specified `name`.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use gettextrs::TextDomain;
    ///
    /// let text_domain = TextDomain::new("my_textdomain");
    /// ```
    pub fn new<S: Into<String>>(name: S) -> TextDomain {
        TextDomain {
            name: Some(name.into()),
            locale_category: Some(LocaleCategory::LcMessages),
            ..TextDomain::default()
        }
    }

    /// Override the `locale` for the `TextDomain`. Default is to use current locale.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use gettextrs::TextDomain;
    ///
    /// let text_domain = TextDomain::new("my_textdomain")
    ///                              .locale("fr_FR.UTF-8");
    /// ```
    pub fn locale(mut self, locale: &str) -> Self {
        self.locale = Some(locale.to_owned());
        self
    }

    /// Override the `locale_category`. Default is [`LocaleCategory::LcMessages`].
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use gettextrs::{LocaleCategory, TextDomain};
    ///
    /// let text_domain = TextDomain::new("my_textdomain")
    ///                              .locale_category(LocaleCategory::LcAll);
    /// ```
    ///
    /// [`LocaleCategory::LcMessages`]: enum.LocaleCategory.html#variant.LcMessages
    pub fn locale_category(mut self, locale_category: LocaleCategory) -> Self {
        self.locale_category = Some(locale_category);
        self
    }

    /// Define the `codeset` that will be used for calling [`bind_textdomain_codeset`].
    /// The default is to **not** call [`bind_textdomain_codeset`].
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use gettextrs::TextDomain;
    ///
    /// let text_domain = TextDomain::new("my_textdomain")
    ///                              .codeset("UTF-8");
    /// ```
    ///
    /// [`bind_textdomain_codeset`]: fn.bind_textdomain_codeset.html
    pub fn codeset<S: Into<String>>(mut self, codeset: S) -> Self {
        self.codeset = Some(codeset.into());
        self
    }

    /// Prepend the given `path` to the search paths.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use gettextrs::TextDomain;
    ///
    /// let text_domain = TextDomain::new("my_textdomain")
    ///                              .prepend("~/.local/share");
    /// ```
    pub fn prepend<P: Into<PathBuf>>(mut self, path: P) -> Self {
        self.pre_paths.push(path.into());
        self
    }

    /// Push the given `path` to the end of the search paths.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use gettextrs::TextDomain;
    ///
    /// let text_domain = TextDomain::new("my_textdomain")
    ///                              .push("test");
    /// ```
    pub fn push<P: Into<PathBuf>>(mut self, path: P) -> Self {
        self.post_paths.push(path.into());
        self
    }

    /// Don't search translation in the system data paths.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use gettextrs::TextDomain;
    ///
    /// let text_domain = TextDomain::new("my_textdomain")
    ///                              .push("test")
    ///                              .skip_system_data_paths();
    /// ```
    pub fn skip_system_data_paths(mut self) -> Self {
        self.skip_system_data_paths = true;
        self
    }

    /// Search for translations in the search paths and initialize the `locale` and `textdomain`.
    /// Return an `Option` with the locale (i.e. the result from the call to [`setlocale`]) if:
    ///
    /// - a translation of the text domain in the requested language was found,
    /// - the locale is valid.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use gettextrs::TextDomain;
    ///
    /// TextDomain::new("my_textdomain")
    ///            .init()
    ///            .unwrap();
    /// ```
    ///
    /// [`TextDomainError`]: enum.TextDomainError.html
    /// [`setlocale`]: fn.setlocale.html
    pub fn init(mut self) -> Result<Option<String>, TextDomainError> {
        let (req_locale, norm_locale) = match self.locale.take() {
            Some(req_locale) => {
                if req_locale == "C" || req_locale == "POSIX" {
                    return Ok(Some(req_locale));
                }
                match LanguageRange::new(&req_locale) {
                    Ok(lang_range) => (req_locale.clone(), lang_range.into()),
                    Err(_) => {
                        // try again as unix language tag
                        match LanguageRange::from_unix(&req_locale) {
                            Ok(lang_range) => (req_locale.clone(), lang_range.into()),
                            Err(_) => {
                                return Err(TextDomainError::InvalidLocale(req_locale.clone()));
                            }
                        }
                    }
                }
            }
            None => {
                // `setlocale` accepts an empty string for current locale
                ("".to_owned(), Locale::current())
            }
        };

        let lang = norm_locale.as_ref().splitn(2, "-").collect::<Vec<&str>>()[0].to_owned();

        let name = self.name.take().unwrap();
        let locale_category = self.locale_category.take().unwrap();
        let mut codeset = self.codeset.take();

        let mo_rel_path = PathBuf::from("LC_MESSAGES").join(&format!("{}.mo", &name));

        // Get paths from system data dirs if requested so
        let sys_data_paths_str = if !self.skip_system_data_paths {
            env::var("XDG_DATA_DIRS").unwrap_or(".".to_owned())
        } else {
            "".to_owned()
        };
        let sys_data_dirs_iter = env::split_paths(&sys_data_paths_str);

        // Chain search paths and search for the translation mo file
        self.pre_paths
            .into_iter()
            .chain(sys_data_dirs_iter)
            .chain(self.post_paths.into_iter())
            .find(|path| {
                let locale_path = path.join("locale");
                locale_path.is_dir() && {
                    // path contains a `locale` directory
                    // search for sub directories matching `lang*`
                    // and see if we can find a translation file for the `textdomain`
                    // under `path/locale/lang*/LC_MESSAGES/`
                    let locale_path = &locale_path;
                    fs::read_dir(locale_path)
                        .ok()
                        .map_or(false, |mut entry_iter| {
                            entry_iter
                                .by_ref()
                                .find(|entry_res| {
                                    entry_res.as_ref().ok().map_or(false, |entry| {
                                        entry.file_type().ok().map_or(false, |file_type| {
                                            file_type.is_dir()
                                                && entry.file_name().to_str().map_or(
                                                    false,
                                                    |entry_name| {
                                                        entry_name.starts_with(&lang)
                                                            && locale_path
                                                                .join(entry_name)
                                                                .join(&mo_rel_path)
                                                                .exists()
                                                    },
                                                )
                                        })
                                    })
                                })
                                .is_some()
                        })
                }
            })
            .map_or(
                Err(TextDomainError::TranslationNotFound(lang)),
                |path| {
                    let result = setlocale(locale_category, req_locale);
                    bindtextdomain(
                        name.clone(),
                        path.join("locale").to_str().unwrap().to_owned(),
                    );
                    if let Some(codeset) = codeset.take() {
                        bind_textdomain_codeset(name.clone(), codeset);
                    }
                    textdomain(name);
                    Ok(result)
                },
            )
    }
}

impl fmt::Debug for TextDomain {
    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
        let mut debug_struct = fmt.debug_struct("TextDomain");
        debug_struct
            .field("name", &self.name.as_ref().unwrap())
            .field(
                "locale",
                &match self.locale.as_ref() {
                    Some(locale) => locale.to_owned(),
                    None => {
                        let cur_locale = Locale::current();
                        cur_locale.as_ref().to_owned()
                    }
                },
            )
            .field("locale_category", &self.locale_category.as_ref().unwrap())
            .field("codeset", &self.codeset)
            .field("pre_paths", &self.pre_paths);

        if !self.skip_system_data_paths {
            debug_struct.field(
                "using system data paths",
                &env::var("XDG_DATA_DIRS").unwrap_or("".to_owned()),
            );
        }

        debug_struct.field("post_paths", &self.post_paths).finish()
    }
}

#[cfg(test)]
mod tests {
    use super::{LocaleCategory, TextDomain, TextDomainError};

    #[test]
    fn errors() {
        assert_eq!(
            Some(TextDomainError::InvalidLocale("(°_°)".to_owned())),
            TextDomain::new("test").locale("(°_°)").init().err()
        );

        assert_eq!(
            Some(TextDomainError::TranslationNotFound("en".to_owned())),
            TextDomain::new("0_0").locale("en_US").init().err()
        );
    }

    #[test]
    fn attributes() {
        let text_domain = TextDomain::new("test");
        assert_eq!(Some("test".to_owned()), text_domain.name);
        assert!(text_domain.locale.is_none());
        assert_eq!(Some(LocaleCategory::LcMessages), text_domain.locale_category);
        assert!(text_domain.codeset.is_none());
        assert!(text_domain.pre_paths.is_empty());
        assert!(text_domain.post_paths.is_empty());
        assert!(!text_domain.skip_system_data_paths);

        let text_domain = text_domain.locale_category(LocaleCategory::LcAll);
        assert_eq!(
            Some(LocaleCategory::LcAll),
            text_domain.locale_category
        );

        let text_domain = text_domain.codeset("UTF-8");
        assert_eq!(Some("UTF-8".to_owned()), text_domain.codeset);

        let text_domain = text_domain.prepend("pre");
        assert!(!text_domain.pre_paths.is_empty());

        let text_domain = text_domain.push("post");
        assert!(!text_domain.post_paths.is_empty());

        let text_domain = text_domain.skip_system_data_paths();
        assert!(text_domain.skip_system_data_paths);

        let text_domain = TextDomain::new("test").locale("en_US");
        assert_eq!(Some("en_US".to_owned()), text_domain.locale);

        assert_eq!(
            Some(TextDomainError::TranslationNotFound("en".to_owned())),
            TextDomain::new("0_0").locale("en_US").init().err()
        ); // accept locale, but fail to find translation
    }
}