inkhaven 1.8.3

Inkhaven — TUI literary work editor for Typst books
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

//! Fetch open WordNet data on demand and build a local index.
//!
//! Mirrors the research layer's public-data fetch pattern: download the open
//! WN-LMF distribution for a language, decompress it, parse it
//! ([`parse_lmf`](super::parse_lmf)), and persist the built index under the user
//! data directory. English (Open English WordNet, a plain `.xml.gz`) is
//! supported here; the OMW languages ship as `.tar.xz` and arrive in a later
//! release. Data is never bundled or redistributed — each user fetches it under
//! its own licence.

use super::{parse_lmf, WordNet};

/// A downloadable wordnet.
pub struct Source {
    pub lang: &'static str,
    pub name: &'static str,
    pub url: &'static str,
    pub format: Format,
    pub license: &'static str,
}

#[derive(PartialEq)]
pub enum Format {
    /// A single gzipped WN-LMF document (Open English WordNet).
    XmlGz,
    /// A `.tar.xz` archive containing a WN-LMF document (OMW languages).
    TarXz,
}

/// The curated source list. English is fetchable today; the `.tar.xz` languages
/// are listed so `wordnet list` shows the roadmap and their licences.
pub const SOURCES: &[Source] = &[
    Source {
        lang: "en",
        name: "Open English WordNet 2025",
        url: "https://en-word.net/static/english-wordnet-2025-plus.xml.gz",
        format: Format::XmlGz,
        license: "CC BY 4.0",
    },
    Source {
        lang: "fr",
        name: "WOLF — WordNet Libre du Français",
        url: "https://github.com/omwn/omw-data/releases/download/v2.0/omw-fr-2.0.tar.xz",
        format: Format::TarXz,
        license: "CeCILL-C",
    },
    Source {
        lang: "de",
        name: "Open German WordNet (ODeNet)",
        url: "https://github.com/hdaSprachtechnologie/odenet/releases/download/v1.4/odenet-1.4.tar.xz",
        format: Format::TarXz,
        license: "CC BY-SA 4.0",
    },
    Source {
        lang: "es",
        name: "Spanish WordNet (OMW)",
        url: "https://github.com/omwn/omw-data/releases/download/v2.0/omw-es-2.0.tar.xz",
        format: Format::TarXz,
        license: "CC BY 3.0",
    },
];

/// The source record for a language code, if any.
pub fn source(lang: &str) -> Option<&'static Source> {
    SOURCES.iter().find(|s| s.lang.eq_ignore_ascii_case(lang))
}

/// Download and build the wordnet for `lang`. Returns the parsed index (the
/// caller persists it). Async, using the shared reqwest stack.
pub async fn fetch(lang: &str) -> Result<WordNet, String> {
    let src = source(lang).ok_or_else(|| {
        let known = SOURCES.iter().map(|s| s.lang).collect::<Vec<_>>().join(", ");
        format!("no wordnet source for `{lang}` — known languages: {known}")
    })?;

    if src.format == Format::TarXz {
        return Err(format!(
            "`{lang}` ({}) ships as a .tar.xz archive; only English (`en`) is fetchable in this \
             release — the OMW languages arrive next",
            src.name
        ));
    }

    let client = reqwest::Client::builder()
        .user_agent(concat!("inkhaven/", env!("CARGO_PKG_VERSION")))
        .build()
        .map_err(|e| format!("http client: {e}"))?;
    let resp = client
        .get(src.url)
        .send()
        .await
        .map_err(|e| format!("download {}: {e}", src.url))?
        .error_for_status()
        .map_err(|e| format!("download {}: {e}", src.url))?;
    let bytes = resp.bytes().await.map_err(|e| format!("read body: {e}"))?;

    let xml = gunzip(&bytes)?;
    parse_lmf(&xml)
}

fn gunzip(bytes: &[u8]) -> Result<String, String> {
    use std::io::Read;
    let mut decoder = flate2::read::GzDecoder::new(bytes);
    let mut out = String::new();
    decoder.read_to_string(&mut out).map_err(|e| format!("gunzip: {e}"))?;
    Ok(out)
}