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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
use crate::hashed_regex::HashedRegex;
use anyhow::Error;
use http::header::{HeaderName, HeaderValue};
use log::Level;
use reqwest::Client;
use serde_derive::{Deserialize, Serialize};
use std::{
collections::HashMap,
convert::TryFrom,
fmt::{self, Display, Formatter},
str::FromStr,
time::Duration,
};
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(default, rename_all = "kebab-case")]
pub struct Config {
pub follow_web_links: bool,
pub traverse_parent_directories: bool,
#[serde(default)]
pub exclude: Vec<HashedRegex>,
#[serde(default = "default_user_agent")]
pub user_agent: String,
#[serde(default = "default_cache_timeout")]
pub cache_timeout: u64,
#[serde(default)]
pub warning_policy: WarningPolicy,
#[serde(default)]
pub http_headers: HashMap<HashedRegex, Vec<HttpHeader>>,
}
#[derive(Serialize, Deserialize, Debug, PartialEq, Clone)]
#[serde(try_from = "String", into = "String")]
pub struct HttpHeader {
pub name: HeaderName,
pub value: String,
}
impl HttpHeader {
pub(crate) fn interpolate(&self) -> Result<HeaderValue, Error> {
interpolate_env(&self.value)
}
}
impl Display for HttpHeader {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
write!(f, "{}: {}", self.name, self.value)
}
}
impl Config {
pub const DEFAULT_CACHE_TIMEOUT: Duration =
Duration::from_secs(60 * 60 * 12);
pub const DEFAULT_USER_AGENT: &'static str =
concat!(env!("CARGO_PKG_NAME"), "-", env!("CARGO_PKG_VERSION"));
pub fn should_skip(&self, link: &str) -> bool {
self.exclude.iter().any(|pat| pat.find(link).is_some())
}
pub(crate) fn client(&self) -> Client {
let mut headers = http::HeaderMap::new();
headers
.insert(http::header::USER_AGENT, self.user_agent.parse().unwrap());
Client::builder().default_headers(headers).build().unwrap()
}
pub(crate) fn interpolate_headers(
&self,
warning_policy: WarningPolicy,
) -> Vec<(HashedRegex, Vec<(HeaderName, HeaderValue)>)> {
let mut all_headers = Vec::new();
let log_level = warning_policy.to_log_level();
for (pattern, headers) in &self.http_headers {
let mut interpolated = Vec::new();
for header in headers {
match header.interpolate() {
Ok(value) => {
interpolated.push((header.name.clone(), value))
},
Err(e) => {
log::log!(
log_level,
"Unable to interpolate \"{}\" because {}",
header,
e
);
},
}
}
all_headers.push((pattern.clone(), interpolated));
}
all_headers
}
}
impl Default for Config {
fn default() -> Config {
Config {
follow_web_links: false,
traverse_parent_directories: false,
exclude: Vec::new(),
user_agent: default_user_agent(),
http_headers: HashMap::new(),
warning_policy: WarningPolicy::Warn,
cache_timeout: Config::DEFAULT_CACHE_TIMEOUT.as_secs(),
}
}
}
impl FromStr for HttpHeader {
type Err = Error;
fn from_str(s: &str) -> Result<Self, Self::Err> {
match s.find(": ") {
Some(idx) => {
let name = s[..idx].parse()?;
let value = s[idx + 2..].to_string();
Ok(HttpHeader {
name,
value,
})
},
None => Err(Error::msg(format!(
"The `{}` HTTP header must be in the form `key: value` but it isn't",
s
))),
}
}
}
impl TryFrom<&'_ str> for HttpHeader {
type Error = Error;
fn try_from(s: &'_ str) -> Result<Self, Error> { HttpHeader::from_str(s) }
}
impl TryFrom<String> for HttpHeader {
type Error = Error;
fn try_from(s: String) -> Result<Self, Error> {
HttpHeader::try_from(s.as_str())
}
}
impl Into<String> for HttpHeader {
fn into(self) -> String {
let HttpHeader { name, value, .. } = self;
format!("{}: {}", name, value)
}
}
fn default_cache_timeout() -> u64 { Config::DEFAULT_CACHE_TIMEOUT.as_secs() }
fn default_user_agent() -> String { Config::DEFAULT_USER_AGENT.to_string() }
fn interpolate_env(value: &str) -> Result<HeaderValue, Error> {
use std::{iter::Peekable, str::CharIndices};
fn is_ident(ch: char) -> bool { ch.is_ascii_alphanumeric() || ch == '_' }
fn ident_end(start: usize, iter: &mut Peekable<CharIndices>) -> usize {
let mut end = start;
while let Some(&(i, ch)) = iter.peek() {
if !is_ident(ch) {
return i;
}
end = i + ch.len_utf8();
iter.next();
}
end
}
let mut res = String::with_capacity(value.len());
let mut backslash = false;
let mut iter = value.char_indices().peekable();
while let Some((i, ch)) = iter.next() {
if backslash {
match ch {
'$' | '\\' => res.push(ch),
_ => {
res.push('\\');
res.push(ch);
},
}
backslash = false;
} else {
match ch {
'\\' => backslash = true,
'$' => {
iter.next();
let start = i + 1;
let end = ident_end(start, &mut iter);
let name = &value[start..end];
match std::env::var(name) {
Ok(env) => res.push_str(&env),
Err(e) => {
return Err(Error::msg(format!(
"Failed to retrieve `{}` env var: {}",
name, e
)))
},
}
},
_ => res.push(ch),
}
}
}
if backslash {
res.push('\\');
}
Ok(res.parse()?)
}
#[derive(Debug, Copy, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub enum WarningPolicy {
Ignore,
Warn,
Error,
}
impl WarningPolicy {
pub(crate) fn to_log_level(self) -> Level {
match self {
WarningPolicy::Error => Level::Error,
WarningPolicy::Warn => Level::Warn,
WarningPolicy::Ignore => Level::Debug,
}
}
}
impl Default for WarningPolicy {
fn default() -> WarningPolicy { WarningPolicy::Warn }
}
#[cfg(test)]
mod tests {
use super::*;
use std::{convert::TryInto, iter::FromIterator};
use toml;
const CONFIG: &str = r#"follow-web-links = true
traverse-parent-directories = true
exclude = ["google\\.com"]
user-agent = "Internet Explorer"
cache-timeout = 3600
warning-policy = "error"
[http-headers]
https = ["accept: html/text", "authorization: Basic $TOKEN"]
"#;
#[test]
fn deserialize_a_config() {
std::env::set_var("TOKEN", "QWxhZGRpbjpPcGVuU2VzYW1l");
let should_be = Config {
follow_web_links: true,
warning_policy: WarningPolicy::Error,
traverse_parent_directories: true,
exclude: vec![HashedRegex::new(r"google\.com").unwrap()],
user_agent: String::from("Internet Explorer"),
http_headers: HashMap::from_iter(vec![(
HashedRegex::new("https").unwrap(),
vec![
"Accept: html/text".try_into().unwrap(),
"Authorization: Basic $TOKEN".try_into().unwrap(),
],
)]),
cache_timeout: 3600,
};
let got: Config = toml::from_str(CONFIG).unwrap();
assert_eq!(got, should_be);
}
#[test]
fn round_trip_config() {
std::env::set_var("TOKEN", "QWxhZGRpbjpPcGVuU2VzYW1l");
let deserialized: Config = toml::from_str(CONFIG).unwrap();
let reserialized = toml::to_string(&deserialized).unwrap();
assert_eq!(reserialized, CONFIG);
}
#[test]
fn interpolation() {
std::env::set_var("SUPER_SECRET_TOKEN", "abcdefg123456");
let header = HttpHeader {
name: "Authorization".parse().unwrap(),
value: "Basic $SUPER_SECRET_TOKEN".into(),
};
let should_be: HeaderValue = "Basic abcdefg123456".parse().unwrap();
let got = header.interpolate().unwrap();
assert_eq!(got, should_be);
}
}