inkhaven 1.2.4

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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216

//! Minimal EPUB3 writer.
//!
//! Builds an EPUB3-compliant zip from a markdown source string,
//! using the same `zip` crate already pulled in for backup
//! archives. Single-chapter layout — the markdown becomes one
//! XHTML file, the nav lists it under `title`, and OPF / NCX
//! metadata is generated from `title` + a deterministic UUID
//! derived from the content hash. No epub-specific dependency
//! means we don't bloat the binary just to write this one
//! format, but it also means the converter is on the conservative
//! side: rich features (cover image, multiple chapters,
//! cross-references) are explicitly out of scope.

use std::io::Write;

use anyhow::Result;
use pulldown_cmark::{Event, HeadingLevel, Parser, Tag, TagEnd};
use zip::write::SimpleFileOptions;

/// Write a single-chapter EPUB3 archive. `title` lands in the
/// metadata / nav; `markdown_src` becomes the body XHTML.
pub fn write_epub(markdown_src: &str, title: &str) -> Result<Vec<u8>> {
    let mut buf: Vec<u8> = Vec::new();
    {
        let cursor = std::io::Cursor::new(&mut buf);
        let mut zw = zip::ZipWriter::new(cursor);
        // mimetype MUST be the first entry, stored (not deflated),
        // with no extra fields. EPUB readers reject archives that
        // violate this. The zip crate's "stored" method is the
        // way to skip deflate for a single entry.
        zw.start_file(
            "mimetype",
            SimpleFileOptions::default()
                .compression_method(zip::CompressionMethod::Stored),
        )?;
        zw.write_all(b"application/epub+zip")?;

        let html_body = markdown_to_xhtml_body(markdown_src);
        let chapter_xhtml = format!(
            "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n\
<!DOCTYPE html>\n\
<html xmlns=\"http://www.w3.org/1999/xhtml\" xmlns:epub=\"http://www.idpf.org/2007/ops\">\n\
<head><meta charset=\"utf-8\"/><title>{title_esc}</title></head>\n\
<body>{body}</body>\n\
</html>\n",
            title_esc = xml_escape(title),
            body = html_body,
        );

        let nav_xhtml = format!(
            "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n\
<!DOCTYPE html>\n\
<html xmlns=\"http://www.w3.org/1999/xhtml\" xmlns:epub=\"http://www.idpf.org/2007/ops\">\n\
<head><meta charset=\"utf-8\"/><title>Navigation</title></head>\n\
<body><nav epub:type=\"toc\"><ol><li><a href=\"chapter.xhtml\">{title_esc}</a></li></ol></nav></body>\n\
</html>\n",
            title_esc = xml_escape(title),
        );

        // Stable UUID-ish identifier derived from the title +
        // content length so repeated exports of the same project
        // are byte-stable (ignoring zip metadata timestamps that
        // the zip crate fixes anyway).
        let identifier = format!(
            "urn:inkhaven:{}-{}-{}",
            slug::slugify(title),
            markdown_src.len(),
            crude_hash(markdown_src),
        );
        let opf = format!(
            "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n\
<package version=\"3.0\" xmlns=\"http://www.idpf.org/2007/opf\" unique-identifier=\"book-id\">\n\
  <metadata xmlns:dc=\"http://purl.org/dc/elements/1.1/\">\n\
    <dc:identifier id=\"book-id\">{id_esc}</dc:identifier>\n\
    <dc:title>{title_esc}</dc:title>\n\
    <dc:language>en</dc:language>\n\
    <meta property=\"dcterms:modified\">2025-01-01T00:00:00Z</meta>\n\
  </metadata>\n\
  <manifest>\n\
    <item id=\"nav\" href=\"nav.xhtml\" media-type=\"application/xhtml+xml\" properties=\"nav\"/>\n\
    <item id=\"chap\" href=\"chapter.xhtml\" media-type=\"application/xhtml+xml\"/>\n\
  </manifest>\n\
  <spine>\n\
    <itemref idref=\"chap\"/>\n\
  </spine>\n\
</package>\n",
            id_esc = xml_escape(&identifier),
            title_esc = xml_escape(title),
        );

        let container_xml = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n\
<container version=\"1.0\" xmlns=\"urn:oasis:names:tc:opendocument:xmlns:container\">\n\
  <rootfiles>\n\
    <rootfile full-path=\"OEBPS/content.opf\" media-type=\"application/oebps-package+xml\"/>\n\
  </rootfiles>\n\
</container>\n";

        // Everything else gets deflated.
        let opts = SimpleFileOptions::default()
            .compression_method(zip::CompressionMethod::Deflated);
        zw.start_file("META-INF/container.xml", opts)?;
        zw.write_all(container_xml.as_bytes())?;
        zw.start_file("OEBPS/content.opf", opts)?;
        zw.write_all(opf.as_bytes())?;
        zw.start_file("OEBPS/nav.xhtml", opts)?;
        zw.write_all(nav_xhtml.as_bytes())?;
        zw.start_file("OEBPS/chapter.xhtml", opts)?;
        zw.write_all(chapter_xhtml.as_bytes())?;

        zw.finish()?;
    }
    Ok(buf)
}

/// Render the supplied markdown source to an XHTML body fragment
/// (`<h1>` / `<p>` / etc — no wrapping `<html>` or `<body>`).
/// Uses `pulldown-cmark` which is already pulled in for the AI
/// pane's markdown rendering, so no extra dep.
fn markdown_to_xhtml_body(src: &str) -> String {
    let parser = Parser::new(src);
    let mut out = String::with_capacity(src.len() + 64);
    let mut in_code = false;
    for ev in parser {
        match ev {
            Event::Start(Tag::Heading { level, .. }) => {
                out.push_str(&format!("<{}>", heading_tag(level)));
            }
            Event::End(TagEnd::Heading(level)) => {
                out.push_str(&format!("</{}>", heading_tag(level)));
            }
            Event::Start(Tag::Paragraph) => out.push_str("<p>"),
            Event::End(TagEnd::Paragraph) => out.push_str("</p>"),
            Event::Start(Tag::BlockQuote(_)) => out.push_str("<blockquote>"),
            Event::End(TagEnd::BlockQuote(_)) => out.push_str("</blockquote>"),
            Event::Start(Tag::Emphasis) => out.push_str("<em>"),
            Event::End(TagEnd::Emphasis) => out.push_str("</em>"),
            Event::Start(Tag::Strong) => out.push_str("<strong>"),
            Event::End(TagEnd::Strong) => out.push_str("</strong>"),
            Event::Start(Tag::List(None)) => out.push_str("<ul>"),
            Event::Start(Tag::List(Some(_))) => out.push_str("<ol>"),
            Event::End(TagEnd::List(false)) => out.push_str("</ul>"),
            Event::End(TagEnd::List(true)) => out.push_str("</ol>"),
            Event::Start(Tag::Item) => out.push_str("<li>"),
            Event::End(TagEnd::Item) => out.push_str("</li>"),
            Event::Start(Tag::CodeBlock(_)) => {
                in_code = true;
                out.push_str("<pre><code>");
            }
            Event::End(TagEnd::CodeBlock) => {
                in_code = false;
                out.push_str("</code></pre>");
            }
            Event::Start(Tag::Image { dest_url, title, .. }) => {
                out.push_str(&format!(
                    "<img src=\"{}\" alt=\"{}\"/>",
                    xml_escape(&dest_url),
                    xml_escape(&title)
                ));
            }
            Event::Text(t) => {
                if in_code {
                    out.push_str(&xml_escape(&t));
                } else {
                    out.push_str(&xml_escape(&t));
                }
            }
            Event::Code(t) => {
                out.push_str("<code>");
                out.push_str(&xml_escape(&t));
                out.push_str("</code>");
            }
            Event::SoftBreak | Event::HardBreak => out.push('\n'),
            Event::Rule => out.push_str("<hr/>"),
            _ => {} // Drop everything we don't model — links, footnotes, tables stay textual.
        }
    }
    out
}

fn heading_tag(level: HeadingLevel) -> &'static str {
    match level {
        HeadingLevel::H1 => "h1",
        HeadingLevel::H2 => "h2",
        HeadingLevel::H3 => "h3",
        HeadingLevel::H4 => "h4",
        HeadingLevel::H5 => "h5",
        HeadingLevel::H6 => "h6",
    }
}

fn xml_escape(s: &str) -> String {
    let mut out = String::with_capacity(s.len());
    for c in s.chars() {
        match c {
            '&' => out.push_str("&amp;"),
            '<' => out.push_str("&lt;"),
            '>' => out.push_str("&gt;"),
            '"' => out.push_str("&quot;"),
            '\'' => out.push_str("&apos;"),
            other => out.push(other),
        }
    }
    out
}

/// Lightweight content-hash used to make the EPUB identifier
/// stable across repeated exports of the same project. Not
/// cryptographic — fxhash-ish via XOR + rotate.
fn crude_hash(s: &str) -> u64 {
    let mut h: u64 = 0xcbf29ce484222325; // FNV-1a offset
    for b in s.bytes() {
        h ^= b as u64;
        h = h.wrapping_mul(0x100000001b3);
    }
    h
}