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
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
// (c) 2016 Ivo Wetzel

// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

// STD Dependencies -----------------------------------------------------------
use rand::Rng;
use std::fs::File;
use std::io::Read;


// External Dependencies ------------------------------------------------------
use json;
use rand;
use httparse;
use url::form_urlencoded;
use hyper::mime::{Mime, TopLevel, SubLevel, Attr, Value};
use hyper::header::{Headers, ContentType, ContentDisposition, DispositionParam};


/// An abstraction over HTTP form data.
///
/// Created by the `form!{...}` macro:
///
/// ```rust
/// # #[macro_use] extern crate noir;
/// # #[macro_use] extern crate json;
/// # #[macro_use] extern crate hyper;
/// # use std::fs::File;
/// # use hyper::mime::{Mime, TopLevel, SubLevel};
/// # fn main() {
/// form! {
///     "field" => "value",
///     "array[]" => vec![1, 2, 3, 4, 5],
///     "fs_file" => (
///         "Cargo.toml",
///         Mime(TopLevel::Text, SubLevel::Ext("toml".to_string()), vec![]),
///         File::open("Cargo.toml").unwrap()
///     ),
///     "vec_file" => (
///         "data.bin",
///         Mime(TopLevel::Application, SubLevel::OctetStream, vec![]),
///         vec![1, 2, 3, 4, 5, 6, 7, 8]
///     ),
///     "str_file" => (
///         "readme.txt",
///         Mime(TopLevel::Text, SubLevel::Plain, vec![]),
///         "Hello World"
///     ),
///     "json_file" => (
///         "data.json",
///         Mime(TopLevel::Application, SubLevel::Json, vec![]),
///         object! {
///             "key" => "value"
///         }
///     )
/// };
/// # }
/// ```
///
/// # Test Failure Examples
///
/// [expanded](terminal://provided_response_dump_form)
/// [expanded](terminal://provided_response_with_expected_body_form_mismatch)
/// [collapsed](terminal://with_form_body_error_broken_headers)
/// [collapsed](terminal://with_form_body_error_missing_disposition_header)
/// [collapsed](terminal://with_form_body_error_too_many_headers)
pub struct HttpFormData {
    mime: SubLevel,
    fields: Vec<HttpFormDataField>
}

pub fn http_form_into_fields(form: HttpFormData) -> Vec<HttpFormDataField> {
    form.fields
}

pub fn http_form_into_body_parts(form: HttpFormData) -> (Mime, Vec<u8>) {
    form.into_body_parts()
}


// Internal -------------------------------------------------------------------
#[doc(hidden)]
impl HttpFormData {
    pub fn new(fields: Vec<HttpFormDataField>) -> HttpFormData {

        // Default to non-multipart mime forms
        let mut mime = SubLevel::WwwFormUrlEncoded;

        // Check if any of the fields are files and switch to the corresponding
        // mime type if necessary.
        for field in &fields {
            if let HttpFormDataField::FileVec(_, _, _, _) = *field {
                mime = SubLevel::FormData;
                break;

            } else if let HttpFormDataField::FileFs(_, _, _, _) = *field {
                mime = SubLevel::FormData;
                break;
            }
        }

        HttpFormData {
            mime: mime,
            fields: fields
        }

    }

    fn into_body_parts(self) -> (Mime, Vec<u8>) {

        if self.mime == SubLevel::FormData {

            let mut body = Vec::new();
            let mut rng = rand::thread_rng();
            let parts = form_fields_into_parts(self.fields);

            // Generate form boundary
            // TODO IW: Check for collisions in the data
            let boundary = format!("boundary{}{}", rng.next_u64(), rng.next_u64());
            let full_boundary = format!("\r\n--{}", boundary);
            let boundary_line = full_boundary.as_bytes();

            // Build body payload
            for (mut headers, mut data) in parts {
                body.extend_from_slice(boundary_line);
                body.append(&mut headers);
                body.append(&mut data);
            }

            body.extend_from_slice(format!("\r\n--{}--\r\n", boundary).as_bytes());

            (
                Mime(TopLevel::Application, self.mime, vec![
                    (Attr::Boundary, Value::Ext(boundary.to_string()))
                ]),
                body
            )

        } else {
            let mut serializer = form_urlencoded::Serializer::new(String::new());
            for field in self.fields {
                match field {
                    HttpFormDataField::Field(name, value) => {
                        serializer.append_pair(name.as_str(), value.as_str());
                    },
                    HttpFormDataField::Array(name, values) => {
                        for value in values {
                            serializer.append_pair(name.as_str(), value.as_str());
                        }
                    },
                    _ => unreachable!()
                }
            }
            (
                Mime(TopLevel::Application, self.mime, vec![]),
                serializer.finish().into()
            )
        }

    }

}

pub fn parse_form_data(body: &[u8], boundary: Option<String>) -> Result<HttpFormData, String> {

    let mut fields = Vec::new();

    // FormData
    if let Some(boundary) = boundary {

        // Boundary
        let mut b = String::from("--");
        b.push_str(boundary.as_str());
        let boundary = b.as_bytes();

        // Split the body along the form boundaries
        let mut previous_index = 0;
        for (i, w) in body.windows(boundary.len()).enumerate() {
            if w == boundary {

                // Skip the split before the first actual field
                if previous_index != 0 {

                    // We'll use httparse so we need to pretend to be a http request
                    let mut part = b"POST / HTTP/1.1\r\n".to_vec();

                    part.extend_from_slice(
                        // Strip out boundary and padding
                        &body[previous_index + boundary.len() + 2..i - 2]
                    );

                    try!(parse_form_data_part(&mut fields, part));

                }

                previous_index = i;

            }
        }

    // WwwFormUrlEncoded
    } else {
        for (name, value) in form_urlencoded::parse(body) {
            parse_form_field(&mut fields, name.to_string(), value.to_string());
        }
    };

    // Convert Array fields with a single value back to Value fields
    let fields = fields.into_iter().map(|field| {
        if let HttpFormDataField::Array(name, mut values) = field {
            if values.len() == 1 {
                HttpFormDataField::Field(name, values.remove(0))

            } else {
                HttpFormDataField::Array(name, values)
            }

        } else {
            field
        }

    }).collect::<Vec<HttpFormDataField>>();

    Ok(HttpFormData::new(fields))

}

fn form_fields_into_parts(fields: Vec<HttpFormDataField>) -> Vec<(Vec<u8>, Vec<u8>)> {

    // Convert form fields into multiparts
    let mut parts = Vec::new();
    for field in fields {
        match field {
            HttpFormDataField::Field(name, value) => {
                parts.push((
                    format!(
                        "\r\nContent-Disposition: form-data; name=\"{}\"\r\n\r\n",
                        name

                    ).as_bytes().to_vec(),
                    value.as_bytes().to_vec()
                ));
            },
            HttpFormDataField::Array(name, values) => {
                for value in values {
                    parts.push((
                        format!(
                            "\r\nContent-Disposition: form-data; name=\"{}\"\r\n\r\n",
                            name

                        ).as_bytes().to_vec(),
                        value.as_bytes().to_vec()
                    ));
                }
            },
            HttpFormDataField::FileVec(name, filename, mime, data) => {
                parts.push((
                    format!(
                        "\r\nContent-Disposition: form-data; name=\"{}\"; filename=\"{}\"\r\nContent-Type: {}\r\n\r\n",
                        name,
                        filename,
                        mime

                    ).as_bytes().to_vec(),
                    data
                ));
            },
            HttpFormDataField::FileFs(name, filename, mime, mut file) => {
                let mut data = Vec::new();
                file.read_to_end(&mut data).expect("Failed to read file.");
                parts.push((
                    format!(
                        "\r\nContent-Disposition: form-data; name=\"{}\"; filename=\"{}\"\r\nContent-Type: {}\r\n\r\n",
                        name,
                        filename,
                        mime

                    ).as_bytes().to_vec(),
                    data
                ));
            }
        }
    };

    parts

}

fn parse_form_field(fields: &mut Vec<HttpFormDataField>, name: String, value: String) {

    // If the field name matches the previous field, push the
    // value into the array instead of adding a new field
    if let Some(&mut HttpFormDataField::Array(ref field_name, ref mut values)) = fields.last_mut() {
        if field_name == &name {
            values.push(value);
            return;
        }
    }

    // Add a new field if the field names did not match
    fields.push(HttpFormDataField::Array(name, vec![value]));

}

fn parse_form_data_part(fields: &mut Vec<HttpFormDataField>, data: Vec<u8>) -> Result<(), String> {

    // We let httparse do the gruntwork for us
    let mut headers = [httparse::EMPTY_HEADER; 2];
    let mut req = httparse::Request::new(&mut headers);

    match req.parse(&data[..]) {
        Ok(httparse::Status::Complete(size)) => {

            // Parse field metadata
            let headers = Headers::from_raw(req.headers).unwrap();

            let mut part = try!(ParsedFormDataField::from_headers(headers));

            // File fields
            if part.filename.is_some() {
                fields.push(HttpFormDataField::FileVec(
                    part.name,
                    part.filename.take().unwrap(),
                    part.mime.take().unwrap(),
                    (&data[size..]).to_vec()
                ));

            // Text fields
            } else {
                parse_form_field(
                    fields,
                    part.name,
                    String::from_utf8((&data[size..]).to_vec()).unwrap()
                )
            }

        },
        Err(err) => return Err(match err {
            httparse::Error::HeaderName => "Invalid byte in header name of multi part field.".to_string(),
            httparse::Error::HeaderValue => "Invalid byte in header value of multi part field.".to_string(),
            httparse::Error::TooManyHeaders => "Unexpected headers in multi part field.".to_string(),
            _ => unreachable!()
        }),
        _ => unreachable!()
    }

    Ok(())

}

#[derive(Debug)]
struct ParsedFormDataField {
    name: String,
    mime: Option<Mime>,
    filename: Option<String>
}

impl ParsedFormDataField {

    fn from_headers(headers: Headers) -> Result<ParsedFormDataField, String> {

        let mut name = String::new();
        let mut mime = None;
        let mut filename = None;

        if let Some(&ContentType(ref m)) = headers.get::<ContentType>() {
            mime = Some(m.clone());
        }

        let disposition = match headers.get::<ContentDisposition>() {
            Some(disposition) => disposition,
            None => return Err(
                "Content-Disposition header is missing from multi part field.".to_string()
            )
        };

        for p in &disposition.parameters {
            match *p {
                DispositionParam::Ext(ref key, ref value) => {
                    if key == "name" {
                        name = value.clone();
                    }
                },
                DispositionParam::Filename(_, _, ref buf) => {
                    filename = Some(String::from_utf8(buf.clone()).unwrap());
                }
            }
        }

        Ok(ParsedFormDataField {
            name: name,
            mime: mime,
            filename: filename,
        })

    }

}

#[doc(hidden)]
pub enum HttpFormDataField {
    Field(String, String),
    Array(String, Vec<String>),
    FileVec(String, String, Mime, Vec<u8>),
    FileFs(String, String, Mime, File)
}

macro_rules! impl_form_data_field_type {
    ($T:ty) => (

        impl From<(&'static str, $T)> for HttpFormDataField {
            fn from(item: (&'static str, $T)) -> HttpFormDataField {
                HttpFormDataField::Field(
                    item.0.to_string(),
                    item.1.to_string()
                )
            }
        }

        impl From<(&'static str, Vec<$T>)> for HttpFormDataField {
            fn from(item: (&'static str, Vec<$T>)) -> HttpFormDataField {
                HttpFormDataField::Array(
                    item.0.to_string(),
                    item.1.iter().map(|s| s.to_string()).collect()
                )
            }
        }

    )
}

impl From<(&'static str, (&'static str, Mime, File))> for HttpFormDataField {
    fn from(item: (&'static str, (&'static str, Mime, File))) -> HttpFormDataField {
        HttpFormDataField::FileFs(
            item.0.to_string(),
            (item.1).0.to_string(),
            (item.1).1,
            (item.1).2
        )
    }
}

impl From<(&'static str, (&'static str, Mime, &'static str))> for HttpFormDataField {
    fn from(item: (&'static str, (&'static str, Mime, &'static str))) -> HttpFormDataField {
        HttpFormDataField::FileVec(
            item.0.to_string(),
            (item.1).0.to_string(),
            (item.1).1,
            (item.1).2.into()
        )
    }
}

impl From<(&'static str, (&'static str, Mime, String))> for HttpFormDataField {
    fn from(item: (&'static str, (&'static str, Mime, String))) -> HttpFormDataField {
        HttpFormDataField::FileVec(
            item.0.to_string(),
            (item.1).0.to_string(),
            (item.1).1,
            (item.1).2.into()
        )
    }
}

impl From<(&'static str, (&'static str, Mime, Vec<u8>))> for HttpFormDataField {
    fn from(item: (&'static str, (&'static str, Mime, Vec<u8>))) -> HttpFormDataField {
        HttpFormDataField::FileVec(
            item.0.to_string(),
            (item.1).0.to_string(),
            (item.1).1,
            (item.1).2
        )
    }
}

impl From<(&'static str, (&'static str, Mime, json::JsonValue))> for HttpFormDataField {
    fn from(item: (&'static str, (&'static str, Mime, json::JsonValue))) -> HttpFormDataField {
        HttpFormDataField::FileVec(
            item.0.to_string(),
            (item.1).0.to_string(),
            (item.1).1,
            json::stringify((item.1).2).into()
        )
    }
}

// TODO IW: Clean up, once impl specialization is stable
impl_form_data_field_type!(&'static str);
impl_form_data_field_type!(String);
impl_form_data_field_type!(bool);
impl_form_data_field_type!(f64);
impl_form_data_field_type!(i64);
impl_form_data_field_type!(u64);
impl_form_data_field_type!(i32);
impl_form_data_field_type!(u32);