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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
use crate::error::{Error, Result, Source};
use crate::token::Token;
use crate::misc;
use std::borrow::Cow;
use std::collections::HashMap;
use std::fs;
use std::io::Read;
use std::path::{Path, PathBuf};
use walkdir::WalkDir;
use rust_i18n::t;
/// Resource Handler.
///
/// Its task is to make sure that some resource (image, link) is available
/// for the book and to list images used in Markdown files so they can be used for the book
#[derive(Debug)]
pub struct ResourceHandler {
/// Maps an original url (e.g.) "foo/Readme.md" to a valid link
/// (e.g.) chapter3.html
links: HashMap<String, String>,
map_images: bool,
base64: bool,
/// Maps an original (local) file name to a new file name. Allows to
/// make sure all image files will be included in e.g. the Epub document.
#[doc(hidden)]
pub images: HashMap<String, String>,
}
impl ResourceHandler {
/// Creates a new, empty Resource Handler
pub fn new() -> ResourceHandler {
ResourceHandler {
links: HashMap::new(),
images: HashMap::new(),
map_images: false,
base64: false,
}
}
/// Turns on mapping for image files
///
/// # Argument: an offset (should be book.root)
pub fn set_images_mapping(&mut self, b: bool) -> &mut Self {
self.map_images = b;
self
}
/// Sets base64 mode for image mapping
///
/// If set to true, instead of returning a destination file path,
/// `map_image` will include the image as base64
pub fn set_base64(&mut self, b: bool) {
self.base64 = b;
}
/// Add a local image file and get the resulting transformed
/// file name
pub fn map_image<'a, S: Into<Cow<'a, str>>>(
&'a mut self,
source: &Source,
file: S,
) -> Result<Cow<'a, str>> {
// If image is not local, do nothing much
let file = file.into();
if !Self::is_local(file.as_ref()) {
warn!(
"{}",
t!("resources.non_local",
file = file
)
);
return Ok(file);
}
// Check exisence of the file
if fs::metadata(file.as_ref()).is_err() {
return Err(Error::file_not_found(
source,
t!("format.image"),
format!("{file}"),
));
}
// if image mapping is not activated do nothing else
if !self.map_images {
return Ok(file);
}
// If this image has already been registered, returns it
if self.images.contains_key(file.as_ref()) {
return Ok(Cow::Borrowed(&self.images[file.as_ref()]));
}
// Else, create a new file name that has same extension
// (or a base64 version of the file)
let dest_file = if !(self.base64) {
if let Some(extension) = Path::new(file.as_ref()).extension() {
format!(
"images/image_{}.{}",
self.images.len(),
extension.to_string_lossy()
)
} else {
warn!(
"{}",
t!("resources.no_ext",
file = file
)
);
format!("images/image_{}", self.images.len())
}
} else {
let mut f = match fs::canonicalize(file.as_ref()).and_then(fs::File::open) {
Ok(f) => f,
Err(_) => {
return Err(Error::file_not_found(
source,
t!("format.image"),
format!("{file}"),
));
}
};
let mut content: Vec<u8> = vec![];
if f.read_to_end(&mut content).is_err() {
error!(
"{}",
t!("resources.read_error", file = file)
);
return Ok(file);
}
let base64 = misc::u8_to_base64(&content);
match mime_guess::from_path(file.as_ref()).first() {
None => {
error!(
"{}",
t!("resources.guess",
file = file
)
);
return Ok(file);
}
Some(s) => format!("data:{s};base64,{base64}"),
}
};
self.images.insert(file.into_owned(), dest_file.clone());
Ok(Cow::Owned(dest_file))
}
/// Returns an iterator the the images files mapping
#[doc(hidden)]
pub fn images_mapping(&self) -> &HashMap<String, String> {
&self.images
}
/// Add a match between an original file and a dest file
pub fn add_link<S1: Into<String>, S2: Into<String>>(&mut self, from: S1, to: S2) {
self.links.insert(from.into(), to.into());
}
/// Get a destination link from an original link
pub fn get_link<'a>(&'a self, from: &'a str) -> &'a str {
if let Some(link) = self.links.get(from) {
link
} else {
// Try to get a link by changing the extension
let new_from = format!("{}", Path::new(from).with_extension("md").display()).replace("\\", "/");
if let Some(link) = self.links.get(&new_from) {
link
} else {
warn!(
"{}",
t!("resources.no_match",
file = from,
new_from = new_from
)
);
from
}
}
}
/// Tell whether a file name is a local resource or net
pub fn contains_link(&self, from: &str) -> bool {
if self.links.contains_key(from) {
true
} else {
// Try to get a link by changing the extension and rewriting backlashes
let new_from = format!("{}", Path::new(from).with_extension("md").display()).replace("\\", "/");
self.links.contains_key(&new_from)
}
}
pub fn is_local(path: &str) -> bool {
!path.contains("://") // todo: use better algorithm
}
/// Add a path offset to all linked urls and images src
pub fn add_offset(link_offset: &Path, image_offset: &Path, ast: &mut [Token]) {
if link_offset == Path::new("") && image_offset == Path::new("") {
// nothing do to
return;
}
for token in ast {
match *token {
Token::Link(ref mut url, _, ref mut v) => {
if ResourceHandler::is_local(url) {
let new_url = format!("{}", link_offset.join(&url).display());
*url = new_url;
}
Self::add_offset(link_offset, image_offset, v);
}
Token::Image(ref mut url, _, ref mut v)
| Token::StandaloneImage(ref mut url, _, ref mut v) => {
if ResourceHandler::is_local(url) {
let new_url = format!("{}", image_offset.join(&url).display());
*url = new_url;
}
Self::add_offset(link_offset, image_offset, v);
}
_ => {
if let Some(ref mut inner) = token.inner_mut() {
Self::add_offset(link_offset, image_offset, inner);
}
}
}
}
}
}
impl Default for ResourceHandler {
fn default() -> Self {
Self::new()
}
}
/// Get the list of all files, walking recursively in directories
///
/// # Arguments
/// - list: a list of files
/// - base: the path where to get them
///
/// # Returns
/// A list of files (relative to `base`), or an error.
pub fn get_files(list: &[String], base: &str) -> Result<Vec<String>> {
let mut out: Vec<String> = vec![];
let base = Path::new(base);
for path in list {
let abs_path = base.join(path);
let res = fs::metadata(&abs_path);
match res {
Err(err) => {
return Err(Error::render(
Source::empty(),
t!("resources.read_file",
file = abs_path.display(),
error = err
),
))
}
Ok(metadata) => {
if metadata.is_file() {
out.push(path.clone());
} else if metadata.is_dir() {
let files = WalkDir::new(&abs_path)
.follow_links(true)
.into_iter()
.filter_map(|e| e.ok())
.filter(|e| e.file_type().is_file())
.map(|e| PathBuf::from(e.path().strip_prefix(base).unwrap()));
for file in files {
out.push(file.to_string_lossy().into_owned());
}
} else {
return Err(Error::render(
Source::empty(),
t!("resources.no_path",
path = &path
),
));
}
}
}
}
Ok(out)
}