veloren/voxygen/i18n/src/raw.rs

//! handle the loading of a `Language`
//! Paths:
//!  - `root_path`: repo part, git main folder
//!  - `language_identifier`: `en`, `de_DE`, `fr_FR`, etc..
//!  - `relative_i18n_root_path`: relative path to i18n path which contains
//!    `language_identifier` folders from `root_path`
//!  - `i18n_root_path`: absolute path to `relative_i18n_root_path`
//!  - `i18n_path`: absolute path to `i18n_root_path` + `language_identifier`
//!  - `subfolder`: all folders in `i18n_path`
//!
//! wherever possible we use relative paths only. So expect 1 absolute
//! `root_path` or `i18n_root_path` to be required and all others be relative.
use crate::{Fonts, Language, LanguageMetadata, LANG_EXTENSION, LANG_MANIFEST_FILE};
use deunicode::deunicode;
use hashbrown::hash_map::HashMap;
use ron::de::from_reader;
use serde::{Deserialize, Serialize};
use std::{
    fs,
    path::{Path, PathBuf},
};

/// Raw localization metadata from LANG_MANIFEST_FILE file
/// See `Language` for more info on each attributes
#[derive(Debug, PartialEq, Serialize, Deserialize, Clone)]
pub(crate) struct RawManifest {
    pub(crate) convert_utf8_to_ascii: bool,
    pub(crate) fonts: Fonts,
    pub(crate) metadata: LanguageMetadata,
}

/// Raw localization data from one specific file
/// These structs are meant to be merged into a Language
#[derive(Debug, PartialEq, Serialize, Deserialize, Clone)]
pub(crate) struct RawFragment<T> {
    pub(crate) string_map: HashMap<String, T>,
    pub(crate) vector_map: HashMap<String, Vec<T>>,
}

pub(crate) struct RawLanguage<T> {
    pub(crate) manifest: RawManifest,
    pub(crate) fragments: HashMap</* relative to i18n_path */ PathBuf, RawFragment<T>>,
}

#[derive(Debug)]
pub(crate) enum RawError {
    RonError(ron::Error),
}

/// `i18n_root_path` - absolute path to i18n path which contains `en`, `de_DE`,
/// `fr_FR` folders
pub(crate) fn load_manifest(
    i18n_root_path: &Path,
    language_identifier: &str,
) -> Result<RawManifest, common_assets::Error> {
    let manifest_file = i18n_root_path
        .join(language_identifier)
        .join(format!("{}.{}", LANG_MANIFEST_FILE, LANG_EXTENSION));
    tracing::debug!(?manifest_file, "manifest loaded");
    let f = fs::File::open(&manifest_file)?;
    let manifest: RawManifest = from_reader(f).map_err(RawError::RonError)?;
    // verify that the folder name `de_DE` matches the value inside the metadata!
    assert_eq!(manifest.metadata.language_identifier, language_identifier);
    Ok(manifest)
}

/// `i18n_root_path` - absolute path to i18n path which contains `en`, `de_DE`,
/// `fr_FR` files
pub(crate) fn load_raw_language(
    i18n_root_path: &Path,
    manifest: RawManifest,
) -> Result<RawLanguage<String>, common_assets::Error> {
    let language_identifier = &manifest.metadata.language_identifier;
    let i18n_path = i18n_root_path.join(language_identifier);

    //get List of files
    let files = fragments_pathes_in_language(i18n_root_path, language_identifier)?;

    // Walk through each file in the directory
    let mut fragments = HashMap::new();
    for fragment_file in &files {
        let relative_path = fragment_file.strip_prefix(&i18n_path).unwrap();
        let f = fs::File::open(fragment_file)?;
        let fragment = from_reader(f).map_err(RawError::RonError)?;
        fragments.insert(relative_path.to_path_buf(), fragment);
    }

    Ok(RawLanguage {
        manifest,
        fragments,
    })
}

impl From<RawLanguage<String>> for Language {
    fn from(raw: RawLanguage<String>) -> Self {
        let mut string_map = HashMap::new();
        let mut vector_map = HashMap::new();

        for (_, fragment) in raw.fragments {
            string_map.extend(fragment.string_map);
            vector_map.extend(fragment.vector_map);
        }

        let convert_utf8_to_ascii = raw.manifest.convert_utf8_to_ascii;

        // Update the text if UTF-8 to ASCII conversion is enabled
        if convert_utf8_to_ascii {
            for value in string_map.values_mut() {
                *value = deunicode(value);
            }

            for value in vector_map.values_mut() {
                *value = value.iter().map(|s| deunicode(s)).collect();
            }
        }
        let mut metadata = raw.manifest.metadata;
        metadata.language_name = deunicode(&metadata.language_name);

        Self {
            string_map,
            vector_map,
            convert_utf8_to_ascii,
            fonts: raw.manifest.fonts,
            metadata,
        }
    }
}

pub(crate) fn fragments_pathes_in_language(
    i18n_root_path: &Path,
    language_identifier: &str,
) -> Result<Vec</* relative to i18n_path */ PathBuf>, std::io::Error> {
    let mut result = vec![];
    recursive_fragments_paths_in_language(
        i18n_root_path,
        language_identifier,
        Path::new(""),
        &mut result,
    )?;
    Ok(result)
}

/// i18n_path = i18n_root_path.join(REFERENCE_LANG);
fn recursive_fragments_paths_in_language(
    i18n_root_path: &Path,
    language_identifier: &str,
    subfolder: &Path,
    result: &mut Vec<PathBuf>,
) -> Result<(), std::io::Error> {
    let i18n_path = i18n_root_path.join(language_identifier);
    let search_dir = i18n_path.join(subfolder);
    for fragment_file in search_dir.read_dir().unwrap().flatten() {
        let file_type = fragment_file.file_type()?;
        if file_type.is_dir() {
            let full_path = fragment_file.path();
            let relative_path = full_path.strip_prefix(&i18n_path).unwrap();
            recursive_fragments_paths_in_language(
                i18n_root_path,
                language_identifier,
                relative_path,
                result,
            )?;
        } else if file_type.is_file() {
            let full_path = fragment_file.path();
            let relative_path = full_path.strip_prefix(&i18n_path).unwrap();
            if relative_path != Path::new(&format!("{}.{}", LANG_MANIFEST_FILE, LANG_EXTENSION)) {
                result.push(relative_path.to_path_buf());
            }
        }
    }
    Ok(())
}

impl core::fmt::Display for RawError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            RawError::RonError(e) => write!(f, "{}", e),
        }
    }
}

impl std::error::Error for RawError {}

impl From<RawError> for common_assets::Error {
    fn from(e: RawError) -> Self { Self::Conversion(Box::new(e)) }
}

impl common_assets::Asset for RawManifest {
    type Loader = common_assets::RonLoader;

    const EXTENSION: &'static str = LANG_EXTENSION;
}

impl common_assets::Asset for RawFragment<String> {
    type Loader = common_assets::RonLoader;

    const EXTENSION: &'static str = LANG_EXTENSION;
}