curl/easy/form.rs
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
use std::ffi::CString;
use std::fmt;
use std::path::Path;
use std::ptr;
use crate::easy::{list, List};
use crate::FormError;
/// Multipart/formdata for an HTTP POST request.
///
/// This structure is built up and then passed to the `Easy::httppost` method to
/// be sent off with a request.
pub struct Form {
head: *mut curl_sys::curl_httppost,
tail: *mut curl_sys::curl_httppost,
headers: Vec<List>,
buffers: Vec<Vec<u8>>,
strings: Vec<CString>,
}
/// One part in a multipart upload, added to a `Form`.
pub struct Part<'form, 'data> {
form: &'form mut Form,
name: &'data str,
array: Vec<curl_sys::curl_forms>,
error: Option<FormError>,
}
pub fn raw(form: &Form) -> *mut curl_sys::curl_httppost {
form.head
}
impl Form {
/// Creates a new blank form ready for the addition of new data.
pub fn new() -> Form {
Form {
head: ptr::null_mut(),
tail: ptr::null_mut(),
headers: Vec::new(),
buffers: Vec::new(),
strings: Vec::new(),
}
}
/// Prepares adding a new part to this `Form`
///
/// Note that the part is not actually added to the form until the `add`
/// method is called on `Part`, which may or may not fail.
pub fn part<'a, 'data>(&'a mut self, name: &'data str) -> Part<'a, 'data> {
Part {
error: None,
form: self,
name,
array: vec![curl_sys::curl_forms {
option: curl_sys::CURLFORM_END,
value: ptr::null_mut(),
}],
}
}
}
impl fmt::Debug for Form {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
// TODO: fill this out more
f.debug_struct("Form").field("fields", &"...").finish()
}
}
impl Drop for Form {
fn drop(&mut self) {
unsafe {
curl_sys::curl_formfree(self.head);
}
}
}
impl<'form, 'data> Part<'form, 'data> {
/// A pointer to the contents of this part, the actual data to send away.
pub fn contents(&mut self, contents: &'data [u8]) -> &mut Self {
let pos = self.array.len() - 1;
// curl has an oddity where if the length if 0 it will call strlen
// on the value. This means that if someone wants to add empty form
// contents we need to make sure the buffer contains a null byte.
let ptr = if contents.is_empty() {
b"\x00"
} else {
contents
}
.as_ptr();
self.array.insert(
pos,
curl_sys::curl_forms {
option: curl_sys::CURLFORM_COPYCONTENTS,
value: ptr as *mut _,
},
);
self.array.insert(
pos + 1,
curl_sys::curl_forms {
option: curl_sys::CURLFORM_CONTENTSLENGTH,
value: contents.len() as *mut _,
},
);
self
}
/// Causes this file to be read and its contents used as data in this part
///
/// This part does not automatically become a file upload part simply
/// because its data was read from a file.
///
/// # Errors
///
/// If the filename has any internal nul bytes or if on Windows it does not
/// contain a unicode filename then the `add` function will eventually
/// return an error.
pub fn file_content<P>(&mut self, file: P) -> &mut Self
where
P: AsRef<Path>,
{
self._file_content(file.as_ref())
}
fn _file_content(&mut self, file: &Path) -> &mut Self {
if let Some(bytes) = self.path2cstr(file) {
let pos = self.array.len() - 1;
self.array.insert(
pos,
curl_sys::curl_forms {
option: curl_sys::CURLFORM_FILECONTENT,
value: bytes.as_ptr() as *mut _,
},
);
self.form.strings.push(bytes);
}
self
}
/// Makes this part a file upload part of the given file.
///
/// Sets the filename field to the basename of the provided file name, and
/// it reads the contents of the file and passes them as data and sets the
/// content type if the given file matches one of the internally known file
/// extensions.
///
/// The given upload file must exist entirely on the filesystem before the
/// upload is started because libcurl needs to read the size of it
/// beforehand.
///
/// Multiple files can be uploaded by calling this method multiple times and
/// content types can also be configured for each file (by calling that
/// next).
///
/// # Errors
///
/// If the filename has any internal nul bytes or if on Windows it does not
/// contain a unicode filename then this function will cause `add` to return
/// an error when called.
pub fn file<P: ?Sized>(&mut self, file: &'data P) -> &mut Self
where
P: AsRef<Path>,
{
self._file(file.as_ref())
}
fn _file(&mut self, file: &'data Path) -> &mut Self {
if let Some(bytes) = self.path2cstr(file) {
let pos = self.array.len() - 1;
self.array.insert(
pos,
curl_sys::curl_forms {
option: curl_sys::CURLFORM_FILE,
value: bytes.as_ptr() as *mut _,
},
);
self.form.strings.push(bytes);
}
self
}
/// Used in combination with `Part::file`, provides the content-type for
/// this part, possibly instead of choosing an internal one.
///
/// # Panics
///
/// This function will panic if `content_type` contains an internal nul
/// byte.
pub fn content_type(&mut self, content_type: &'data str) -> &mut Self {
if let Some(bytes) = self.bytes2cstr(content_type.as_bytes()) {
let pos = self.array.len() - 1;
self.array.insert(
pos,
curl_sys::curl_forms {
option: curl_sys::CURLFORM_CONTENTTYPE,
value: bytes.as_ptr() as *mut _,
},
);
self.form.strings.push(bytes);
}
self
}
/// Used in combination with `Part::file`, provides the filename for
/// this part instead of the actual one.
///
/// # Errors
///
/// If `name` contains an internal nul byte, or if on Windows the path is
/// not valid unicode then this function will return an error when `add` is
/// called.
pub fn filename<P: ?Sized>(&mut self, name: &'data P) -> &mut Self
where
P: AsRef<Path>,
{
self._filename(name.as_ref())
}
fn _filename(&mut self, name: &'data Path) -> &mut Self {
if let Some(bytes) = self.path2cstr(name) {
let pos = self.array.len() - 1;
self.array.insert(
pos,
curl_sys::curl_forms {
option: curl_sys::CURLFORM_FILENAME,
value: bytes.as_ptr() as *mut _,
},
);
self.form.strings.push(bytes);
}
self
}
/// This is used to provide a custom file upload part without using the
/// `file` method above.
///
/// The first parameter is for the filename field and the second is the
/// in-memory contents.
///
/// # Errors
///
/// If `name` contains an internal nul byte, or if on Windows the path is
/// not valid unicode then this function will return an error when `add` is
/// called.
pub fn buffer<P: ?Sized>(&mut self, name: &'data P, data: Vec<u8>) -> &mut Self
where
P: AsRef<Path>,
{
self._buffer(name.as_ref(), data)
}
fn _buffer(&mut self, name: &'data Path, mut data: Vec<u8>) -> &mut Self {
if let Some(bytes) = self.path2cstr(name) {
// If `CURLFORM_BUFFERLENGTH` is set to `0`, libcurl will instead do a strlen() on the
// contents to figure out the size so we need to make sure the buffer is actually
// zero terminated.
let length = data.len();
if length == 0 {
data.push(0);
}
let pos = self.array.len() - 1;
self.array.insert(
pos,
curl_sys::curl_forms {
option: curl_sys::CURLFORM_BUFFER,
value: bytes.as_ptr() as *mut _,
},
);
self.form.strings.push(bytes);
self.array.insert(
pos + 1,
curl_sys::curl_forms {
option: curl_sys::CURLFORM_BUFFERPTR,
value: data.as_ptr() as *mut _,
},
);
self.array.insert(
pos + 2,
curl_sys::curl_forms {
option: curl_sys::CURLFORM_BUFFERLENGTH,
value: length as *mut _,
},
);
self.form.buffers.push(data);
}
self
}
/// Specifies extra headers for the form POST section.
///
/// Appends the list of headers to those libcurl automatically generates.
pub fn content_header(&mut self, headers: List) -> &mut Self {
let pos = self.array.len() - 1;
self.array.insert(
pos,
curl_sys::curl_forms {
option: curl_sys::CURLFORM_CONTENTHEADER,
value: list::raw(&headers) as *mut _,
},
);
self.form.headers.push(headers);
self
}
/// Attempts to add this part to the `Form` that it was created from.
///
/// If any error happens while adding, that error is returned, otherwise
/// `Ok(())` is returned.
pub fn add(&mut self) -> Result<(), FormError> {
if let Some(err) = self.error.clone() {
return Err(err);
}
let rc = unsafe {
curl_sys::curl_formadd(
&mut self.form.head,
&mut self.form.tail,
curl_sys::CURLFORM_COPYNAME,
self.name.as_ptr(),
curl_sys::CURLFORM_NAMELENGTH,
self.name.len(),
curl_sys::CURLFORM_ARRAY,
self.array.as_ptr(),
curl_sys::CURLFORM_END,
)
};
if rc == curl_sys::CURL_FORMADD_OK {
Ok(())
} else {
Err(FormError::new(rc))
}
}
#[cfg(unix)]
fn path2cstr(&mut self, p: &Path) -> Option<CString> {
use std::os::unix::prelude::*;
self.bytes2cstr(p.as_os_str().as_bytes())
}
#[cfg(windows)]
fn path2cstr(&mut self, p: &Path) -> Option<CString> {
match p.to_str() {
Some(bytes) => self.bytes2cstr(bytes.as_bytes()),
None if self.error.is_none() => {
// TODO: better error code
self.error = Some(FormError::new(curl_sys::CURL_FORMADD_INCOMPLETE));
None
}
None => None,
}
}
fn bytes2cstr(&mut self, bytes: &[u8]) -> Option<CString> {
match CString::new(bytes) {
Ok(c) => Some(c),
Err(..) if self.error.is_none() => {
// TODO: better error code
self.error = Some(FormError::new(curl_sys::CURL_FORMADD_INCOMPLETE));
None
}
Err(..) => None,
}
}
}
impl<'form, 'data> fmt::Debug for Part<'form, 'data> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
// TODO: fill this out more
f.debug_struct("Part")
.field("name", &self.name)
.field("form", &self.form)
.finish()
}
}