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
//! Form parse module.
use std::ffi::OsStr;
use std::io::{Cursor, Write};
use std::path::{Path, PathBuf};
use base64::engine::Engine;
use base64::engine::general_purpose::URL_SAFE_NO_PAD;
use bytes::{Bytes, BytesMut};
use futures_util::stream::{Stream, TryStreamExt};
use mime::Mime;
use multimap::MultiMap;
use multra::{Field, Multipart};
use rand::TryRng;
use rand::rngs::SysRng;
use tempfile::Builder;
use tokio::fs::File;
use tokio::io::AsyncWriteExt;
use crate::http::ParseError;
use crate::http::header::{CONTENT_TYPE, HeaderMap};
/// The extracted text fields and uploaded files from a `multipart/form-data` request.
#[derive(Debug)]
#[non_exhaustive]
pub struct FormData {
/// Name-value pairs for plain text fields. Technically, these are form data parts with no
/// filename specified in the part's `Content-Disposition`.
pub fields: MultiMap<String, String>,
/// Name-value pairs for temporary files. Technically, these are form data parts with a
/// filename specified in the part's `Content-Disposition`.
pub files: MultiMap<String, FilePart>,
}
impl FormData {
/// Create new `FormData`.
#[inline]
#[must_use]
pub fn new() -> Self {
Self {
fields: MultiMap::new(),
files: MultiMap::new(),
}
}
/// Parse MIME `multipart/*` information from a stream as a `FormData`.
pub(crate) async fn read<S, O, E>(headers: &HeaderMap, body: S) -> Result<Self, ParseError>
where
S: Stream<Item = Result<O, E>> + Send,
O: Into<Bytes> + 'static,
E: Into<Box<dyn std::error::Error + Send + Sync>>,
{
let ctype: Option<Mime> = headers
.get(CONTENT_TYPE)
.and_then(|h| h.to_str().ok())
.and_then(|v| v.parse().ok());
match ctype {
Some(ctype) if ctype.subtype() == mime::WWW_FORM_URLENCODED => {
futures_util::pin_mut!(body);
let mut data = BytesMut::new();
while let Some(chunk) = body.try_next().await.map_err(|e| {
let err = e.into();
if err.is::<http_body_util::LengthLimitError>() {
ParseError::PayloadTooLarge
} else {
ParseError::other(err)
}
})? {
data.extend_from_slice(&chunk.into());
}
let mut form_data = Self::new();
form_data.fields = form_urlencoded::parse(&data).into_owned().collect();
Ok(form_data)
}
Some(ctype) if ctype.type_() == mime::MULTIPART => {
let mut form_data = Self::new();
if let Some(boundary) = headers
.get(CONTENT_TYPE)
.and_then(|ct| ct.to_str().ok())
.and_then(|ct| multra::parse_boundary(ct).ok())
{
let mut multipart = Multipart::new(body, boundary);
while let Some(mut field) = multipart.next_field().await.map_err(|e| {
// Check if the multra error contains a LengthLimitError
let mut source = std::error::Error::source(&e);
while let Some(err) = source {
if err.is::<http_body_util::LengthLimitError>() {
return ParseError::PayloadTooLarge;
}
source = std::error::Error::source(err);
}
ParseError::Multer(e)
})? {
if let Some(name) = field.name().map(|s| s.to_owned()) {
if field.headers().get(CONTENT_TYPE).is_some() {
form_data
.files
.insert(name, FilePart::create(&mut field).await?);
} else {
form_data.fields.insert(name, field.text().await?);
}
}
}
}
Ok(form_data)
}
_ => Err(ParseError::InvalidContentType),
}
}
}
impl Default for FormData {
#[inline]
fn default() -> Self {
Self::new()
}
}
/// A file that is to be inserted into a `multipart/*` or alternatively an uploaded file that
/// was received as part of `multipart/*` parsing.
#[derive(Clone, Debug)]
pub struct FilePart {
name: Option<String>,
/// The headers of the part
headers: HeaderMap,
/// A temporary file containing the file content
path: PathBuf,
/// Optionally, the size of the file. This is filled when multiparts are parsed, but is
/// not necessary when they are generated.
size: u64,
// The temporary directory the upload was put into, saved for the Drop trait
temp_dir: Option<PathBuf>,
}
impl FilePart {
/// Get file name.
#[inline]
#[must_use]
pub fn name(&self) -> Option<&str> {
self.name.as_deref()
}
/// Get file name mutable reference.
#[inline]
pub fn name_mut(&mut self) -> Option<&mut String> {
self.name.as_mut()
}
/// Get headers.
#[inline]
#[must_use]
pub fn headers(&self) -> &HeaderMap {
&self.headers
}
/// Get headers mutable reference.
pub fn headers_mut(&mut self) -> &mut HeaderMap {
&mut self.headers
}
/// Get content type.
#[inline]
pub fn content_type(&self) -> Option<Mime> {
self.headers
.get(CONTENT_TYPE)
.and_then(|h| h.to_str().ok())
.and_then(|v| v.parse().ok())
}
/// Get file path.
#[inline]
#[must_use]
pub fn path(&self) -> &PathBuf {
&self.path
}
/// Get file size.
#[inline]
#[must_use]
pub fn size(&self) -> u64 {
self.size
}
/// If you do not want the file on disk to be deleted when Self drops, call this
/// function. It will become your responsibility to clean up.
#[inline]
pub fn do_not_delete_on_drop(&mut self) {
self.temp_dir = None;
}
/// Create a new temporary FilePart (when created this way, the file will be
/// deleted once the FilePart object goes out of scope).
pub async fn create(field: &mut Field<'_>) -> Result<Self, ParseError> {
// Setup a file to capture the contents.
let mut path =
tokio::task::spawn_blocking(|| Builder::new().prefix("salvo_http_multipart").tempdir())
.await
.expect("Runtime spawn blocking poll error")?
.keep();
let temp_dir = Some(path.clone());
let name = field.file_name().map(|s| {
// Sanitize filename by removing invalid characters
s.chars()
.filter(|c| {
!matches!(
c,
'/' | '\\' | '\0' | '<' | '>' | ':' | '"' | '|' | '?' | '*'
)
})
.collect::<String>()
});
path.push(format!(
"{}.{}",
text_nonce(),
name.as_deref()
.and_then(|name| { Path::new(name).extension().and_then(OsStr::to_str) })
.unwrap_or("unknown")
));
let mut file = File::create(&path).await?;
let mut size = 0;
while let Some(chunk) = field.chunk().await? {
size += chunk.len() as u64;
file.write_all(&chunk).await?;
}
file.sync_all().await?;
Ok(Self {
name,
headers: field.headers().to_owned(),
path,
size,
temp_dir,
})
}
}
impl Drop for FilePart {
fn drop(&mut self) {
if let Some(temp_dir) = &self.temp_dir {
let path = self.path.clone();
let temp_dir = temp_dir.to_owned();
tokio::task::spawn_blocking(move || {
// Log warnings if cleanup fails to help identify potential disk space issues
if let Err(e) = std::fs::remove_file(&path) {
// Only log if the file still exists (ENOENT is expected if already cleaned up)
if e.kind() != std::io::ErrorKind::NotFound {
tracing::warn!(
error = %e,
path = %path.display(),
"failed to remove temporary upload file"
);
}
}
if let Err(e) = std::fs::remove_dir(&temp_dir) {
// Only log if directory still exists and is not empty
if e.kind() != std::io::ErrorKind::NotFound {
tracing::debug!(
error = %e,
path = %temp_dir.display(),
"failed to remove temporary upload directory"
);
}
}
});
}
}
}
// Port from https://github.com/mikedilger/textnonce/blob/master/src/lib.rs
fn text_nonce() -> String {
const BYTE_LEN: usize = 24;
let mut raw: Vec<u8> = vec![0; BYTE_LEN];
// Get the first 12 bytes from the current time
if let Ok(now) = std::time::SystemTime::now().duration_since(std::time::UNIX_EPOCH) {
let secs: u64 = now.as_secs();
let nsecs: u32 = now.subsec_nanos();
let mut cursor = Cursor::new(&mut *raw);
Write::write_all(&mut cursor, &nsecs.to_le_bytes()).expect("write_all failed");
Write::write_all(&mut cursor, &secs.to_le_bytes()).expect("write_all failed");
// Get the last bytes from random data
SysRng
.try_fill_bytes(&mut raw[12..BYTE_LEN])
.expect("SysRng.try_fill_bytes failed");
} else {
SysRng
.try_fill_bytes(&mut raw[..])
.expect("SysRng.try_fill_bytes failed");
}
// base64 encode
URL_SAFE_NO_PAD.encode(&raw)
}