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
extern crate regex;
#[macro_use]
extern crate lazy_static;
use regex::{Regex, RegexBuilder};
lazy_static! {
static ref ILLEGAL_RE: Regex = Regex::new(r#"[/\?<>\\:\*\|":]"#).unwrap();
static ref CONTROL_RE: Regex = Regex::new(r#"[\x00-\x1f\x80-\x9f]"#).unwrap();
static ref RESERVED_RE: Regex = Regex::new(r#"^\.+$"#).unwrap();
static ref WINDOWS_RESERVED_RE: Regex = RegexBuilder::new(r#"(?i)^(con|prn|aux|nul|com[0-9]|lpt[0-9])(\..*)?$"#)
.case_insensitive(true)
.build()
.unwrap();
static ref WINDOWS_TRAILING_RE: Regex = Regex::new(r#"^\.+$"#).unwrap();
}
#[derive(Clone)]
pub struct Options<'a> {
pub windows: bool,
pub truncate: bool,
pub replacement: &'a str
}
impl<'a> Default for Options<'a> {
fn default() -> Self {
Options {
windows: cfg!(windows),
truncate: true,
replacement: ""
}
}
}
pub fn sanitize<S: AsRef<str>>(name: S) -> String {
sanitize_with_options(name, Options::default())
}
pub fn sanitize_with_options<S: AsRef<str>>(name: S, options: Options) -> String {
let Options { windows, truncate, replacement } = options;
let name = name.as_ref();
let name = ILLEGAL_RE.replace_all(&name, replacement);
let name = CONTROL_RE.replace_all(&name, replacement);
let name = RESERVED_RE.replace(&name, replacement);
let collect = |name: ::std::borrow::Cow<str>| {
if truncate && name.len() > 255 {
let mut end = 255;
loop {
if name.is_char_boundary(end) { break; }
end -= 1;
}
String::from(&name[..end])
} else {
String::from(name)
}
};
if windows {
let name = WINDOWS_RESERVED_RE.replace(&name, replacement);
let name = WINDOWS_TRAILING_RE.replace(&name, replacement);
collect(name)
} else {
collect(name)
}
}
#[cfg(test)]
mod tests {
static NAMES: &'static [&'static str] = &[
"the quick brown fox jumped over the lazy dog",
"résumé",
"hello\u{0000}world",
"hello\nworld",
"semi;colon.js",
";leading-semi.js",
"slash\\.js",
"slash/.js",
"col:on.js",
"star*.js",
"question?.js",
"quote\".js",
"singlequote'.js",
"brack<e>ts.js",
"p|pes.js",
"plus+.js",
"'five and six<seven'.js",
" space at front",
"space at end ",
".period",
"period.",
"relative/path/to/some/dir",
"/abs/path/to/some/dir",
"~/.\u{0000}notssh/authorized_keys",
"",
"h?w",
"h/w",
"h*w",
".",
"..",
"./",
"../",
"/..",
"/../",
"*.|.",
"./",
"./foobar",
"../foobar",
"../../foobar",
"./././foobar",
"|*.what",
"LPT9.asdf"
];
static NAMES_CLEANED: &'static [&'static str] = &[
"the quick brown fox jumped over the lazy dog",
"résumé",
"helloworld",
"helloworld",
"semi;colon.js",
";leading-semi.js",
"slash.js",
"slash.js",
"colon.js",
"star.js",
"question.js",
"quote.js",
"singlequote'.js",
"brackets.js",
"ppes.js",
"plus+.js",
"'five and sixseven'.js",
" space at front",
"space at end ",
".period",
"period.",
"relativepathtosomedir",
"abspathtosomedir",
"~.notsshauthorized_keys",
"",
"hw",
"hw",
"hw",
"",
"",
"",
"",
"",
"",
"",
"",
".foobar",
"..foobar",
"....foobar",
"...foobar",
".what",
""
];
#[test]
fn it_works() {
let options = super::Options {
windows: true,
truncate: true,
replacement: ""
};
for (idx, name) in NAMES.iter().enumerate() {
assert_eq!(super::sanitize_with_options(name, options.clone()), NAMES_CLEANED[idx]);
}
let long = ::std::iter::repeat('a').take(300).collect::<String>();
let shorter = ::std::iter::repeat('a').take(255).collect::<String>();
assert_eq!(super::sanitize_with_options(long, options.clone()), shorter);
}
}