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
use std::borrow::Cow;
use std::fs;
use std::path::Path;
use std::path::PathBuf;
use std::process::Command;
use anyhow::Context;
use anyhow::Result;
use cfg_if::cfg_if;
use lazy_static::lazy_static;
use regex::Captures;
use regex::Regex;
use serde::Deserialize;
use mdbook::book::Book;
use mdbook::book::Chapter;
use mdbook::preprocess::{Preprocessor, PreprocessorContext};
use crate::utils::map_chapter;
pub struct CmdRun;
lazy_static! {
static ref CMDRUN_REG_NEWLINE: Regex = Regex::new(r"<!--[ ]*cmdrun (.*?)-->\r?\n")
.expect("Failed to init regex for finding newline pattern");
static ref CMDRUN_REG_INLINE: Regex = Regex::new(r"<!--[ ]*cmdrun (.*?)-->")
.expect("Failed to init regex for finding inline pattern");
}
cfg_if! {
if #[cfg(target_family = "unix")] {
const LAUNCH_SHELL_COMMAND: &str = "sh";
const LAUNCH_SHELL_FLAG: &str = "-c";
const NEWLINE: &str = "\n";
} else if #[cfg(target_family = "windows")] {
const LAUNCH_SHELL_COMMAND: &str = "cmd";
const LAUNCH_SHELL_FLAG: &str = "/C";
const NEWLINE: &str = "\r\n";
}
}
impl Preprocessor for CmdRun {
fn name(&self) -> &str {
"cmdrun"
}
fn supports_renderer(&self, renderer: &str) -> bool {
renderer == "html"
}
fn run(&self, _ctx: &PreprocessorContext, mut book: Book) -> Result<Book> {
map_chapter(&mut book, &mut CmdRun::run_on_chapter)?;
Ok(book)
}
}
lazy_static! {
static ref SRC_DIR: String = get_src_dir();
}
#[derive(Deserialize)]
struct BookConfig {
book: BookField,
}
#[derive(Deserialize)]
struct BookField {
src: Option<String>,
}
fn get_src_dir() -> String {
fs::read_to_string(Path::new("book.toml"))
.map_err(|_| None::<String>)
.and_then(|fc| toml::from_str::<BookConfig>(fc.as_str()).map_err(|_| None))
.and_then(|bc| bc.book.src.ok_or(None))
.unwrap_or_else(|_| String::from("src"))
}
impl CmdRun {
fn run_on_chapter(chapter: &mut Chapter) -> Result<()> {
let working_dir = &chapter
.path
.to_owned()
.and_then(|p| {
Path::new(SRC_DIR.as_str())
.join(p)
.parent()
.map(PathBuf::from)
})
.and_then(|p| p.to_str().map(String::from))
.unwrap_or_default();
chapter.content = CmdRun::run_on_content(&chapter.content, working_dir)?;
Ok(())
}
// This method is public for regression tests
pub fn run_on_content(content: &str, working_dir: &str) -> Result<String> {
let mut err = None;
let mut result = CMDRUN_REG_NEWLINE
.replace_all(content, |caps: &Captures| {
Self::run_cmdrun(caps[1].to_string(), working_dir, false).unwrap_or_else(|e| {
err = Some(e);
String::new()
})
})
.to_string();
if let Some(e) = err {
return Err(e);
}
result = CMDRUN_REG_INLINE
.replace_all(result.as_str(), |caps: &Captures| {
Self::run_cmdrun(caps[1].to_string(), working_dir, true).unwrap_or_else(|e| {
err = Some(e);
String::new()
})
})
.to_string();
match err {
None => Ok(result),
Some(err) => Err(err),
}
}
// Some progams output linebreaks in UNIX format,
// this can cause problems on Windows if for any reason
// the user is expecting consistent linebreaks,
// e.g. they run the resulting markdown through a validation tool.
//
// So this function simply replaces all linebreaks with Windows linebreaks.
#[cfg(target_family = "windows")]
fn format_whitespace(str: Cow<'_, str>, inline: bool) -> String {
let str = match inline {
// When running inline it is undeseriable to have trailing whitespace
true => str.trim_end(),
false => str.as_ref(),
};
let mut res = str.lines().collect::<Vec<_>>().join("\r\n");
if !inline && !res.is_empty() {
res.push_str("\r\n");
}
return res;
}
#[cfg(target_family = "unix")]
fn format_whitespace(str: Cow<'_, str>, inline: bool) -> String {
match inline {
// Wh;n running inline it is undeseriable to have trailing whitespace
true => str.trim_end().to_string(),
false => str.to_string(),
}
}
fn cmdrun_error_message(message: &str, command: &str) -> String {
format!("**cmdrun error**: {} in 'cmdrun {}'", message, command)
}
// This method is public for unit tests
pub fn run_cmdrun(command: String, working_dir: &str, inline: bool) -> Result<String> {
// unfortunately, we need to manually parse the command string for cmdrun's
// exit status checking flags.
// Some experimentation using clap was done; however, splitting and then re-escaping
// the shellwords was found to be a large barrier to using this other tool.
let (command, correct_exit_code): (String, Option<i32>) =
if let Some(first_word) = command.split_whitespace().next() {
if first_word.starts_with('-') {
if first_word.starts_with("--") {
// double-tick long form
match first_word {
"--strict" => (
command
.split_whitespace()
.skip(1)
.collect::<Vec<&str>>()
.join(" "),
Some(0),
),
"--expect-return-code" => {
if let Some(second_word) = command.split_whitespace().nth(1) {
match second_word.parse::<i32>() {
Ok(return_code) => (
command
.split_whitespace()
.skip(2)
.collect::<Vec<&str>>()
.join(" "),
Some(return_code),
),
Err(_) => {
return Ok(Self::cmdrun_error_message(
"No return code after '--expect-return-code'",
&command,
));
}
}
} else {
// no second word after return code, print error
return Ok(Self::cmdrun_error_message(
"No return code after '--expect-return-code'",
&command,
));
}
}
some_other_word => {
// unrecognized flag, print error
return Ok(Self::cmdrun_error_message(
&format!("Unrecognized cmdrun flag {}", some_other_word),
&command,
));
}
}
} else {
// single-tick short form
let (_, exit_code) = first_word.rsplit_once('-').unwrap_or(("", "0"));
match exit_code.parse::<i32>() {
Ok(return_code) => (
command
.split_whitespace()
.skip(1)
.collect::<Vec<&str>>()
.join(" "),
Some(return_code),
),
Err(_) => {
return Ok(Self::cmdrun_error_message(
&format!(
"Unable to interpret short-form exit code {} as a number",
first_word
),
&command,
));
}
}
}
} else {
(command, None)
}
} else {
(command, None)
};
let output = Command::new(LAUNCH_SHELL_COMMAND)
.args([LAUNCH_SHELL_FLAG, &command])
.current_dir(working_dir)
.output()
.with_context(|| "Fail to run shell")?;
let stdout = Self::format_whitespace(String::from_utf8_lossy(&output.stdout), inline);
match (output.status.code(), correct_exit_code) {
(None, _) => Ok(Self::cmdrun_error_message(
"Command was ended before completing",
&command,
)),
(Some(code), Some(correct_code)) => {
if code != correct_code {
Ok(format!(
"**cmdrun error**: '{command}' returned exit code {code} instead of {correct_code}.{0}{1}{0}{2}",
NEWLINE,
String::from_utf8_lossy(&output.stdout),
String::from_utf8_lossy(&output.stderr)))
} else {
Ok(stdout)
}
}
(Some(_code), None) => {
// no correct code specified, program exited with some code _code
// could put default check requiring code to be zero here but
// that would break current behavior
Ok(stdout)
}
}
}
}