2020-05-10 10:27:46 +00:00
|
|
|
use crate::{registry, InputValueError, InputValueResult, InputValueType, Type, Value};
|
2020-05-11 09:13:50 +00:00
|
|
|
use async_graphql_parser::UploadValue;
|
|
|
|
use futures::AsyncRead;
|
2020-03-14 03:46:20 +00:00
|
|
|
use std::borrow::Cow;
|
2020-05-11 09:13:50 +00:00
|
|
|
use std::io::Read;
|
2020-04-11 09:36:05 +00:00
|
|
|
use std::path::PathBuf;
|
2020-03-14 03:46:20 +00:00
|
|
|
|
2020-03-30 14:02:43 +00:00
|
|
|
/// Uploaded file
|
2020-03-14 03:46:20 +00:00
|
|
|
///
|
2020-03-30 14:02:43 +00:00
|
|
|
/// **Reference:** <https://github.com/jaydenseric/graphql-multipart-request-spec>
|
|
|
|
///
|
|
|
|
///
|
|
|
|
/// Graphql supports file uploads via `multipart/form-data`.
|
|
|
|
/// Enable this feature by accepting an argument of type `Upload` (single file) or
|
|
|
|
/// `Vec<Upload>` (multiple files) in your mutation like in the example blow.
|
|
|
|
///
|
|
|
|
///
|
|
|
|
/// # Example
|
2020-04-28 07:41:31 +00:00
|
|
|
/// *[Full Example](<https://github.com/async-graphql/examples/blob/master/models/files/src/lib.rs>)*
|
2020-03-30 14:02:43 +00:00
|
|
|
///
|
|
|
|
/// ```
|
|
|
|
/// use async_graphql::Upload;
|
|
|
|
///
|
|
|
|
/// struct MutationRoot;
|
|
|
|
///
|
|
|
|
/// #[async_graphql::Object]
|
|
|
|
/// impl MutationRoot {
|
|
|
|
/// async fn upload(&self, file: Upload) -> bool {
|
2020-04-11 09:40:29 +00:00
|
|
|
/// println!("upload: filename={}", file.filename);
|
2020-03-30 14:02:43 +00:00
|
|
|
/// true
|
|
|
|
/// }
|
|
|
|
/// }
|
|
|
|
///
|
|
|
|
/// ```
|
|
|
|
/// # Example Curl Request
|
2020-03-30 14:36:27 +00:00
|
|
|
/// Assuming you have defined your MutationRoot like in the example above,
|
2020-03-30 14:31:38 +00:00
|
|
|
/// you can now upload a file `myFile.txt` with the below curl command:
|
2020-03-30 14:02:43 +00:00
|
|
|
///
|
|
|
|
/// ```curl
|
2020-03-30 14:47:17 +00:00
|
|
|
/// curl 'localhost:8000' \
|
2020-03-30 14:02:43 +00:00
|
|
|
/// --form 'operations={
|
|
|
|
/// "query": "mutation ($file: Upload!) { upload(file: $file) }",
|
|
|
|
/// "variables": { "file": null }}' \
|
|
|
|
/// --form 'map={ "0": ["variables.file"] }' \
|
|
|
|
/// --form '0=@myFile.txt'
|
|
|
|
/// ```
|
2020-05-11 09:13:50 +00:00
|
|
|
pub struct Upload(UploadValue);
|
|
|
|
|
|
|
|
impl Upload {
|
2020-03-20 03:56:08 +00:00
|
|
|
/// Filename
|
2020-05-11 09:13:50 +00:00
|
|
|
pub fn filename(&self) -> &str {
|
|
|
|
self.0.filename.as_str()
|
|
|
|
}
|
2020-03-20 03:56:08 +00:00
|
|
|
|
|
|
|
/// Content type, such as `application/json`, `image/jpg` ...
|
2020-05-11 09:13:50 +00:00
|
|
|
pub fn content_type(&self) -> Option<&str> {
|
|
|
|
self.0.content_type.as_deref()
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Convert to an asynchronous stream
|
|
|
|
pub fn into_async_read(self) -> impl AsyncRead {}
|
2020-03-20 03:56:08 +00:00
|
|
|
|
2020-05-11 09:13:50 +00:00
|
|
|
/// Convert to a synchronized stream
|
|
|
|
pub fn into_read(self) -> impl Read {}
|
2020-03-14 03:46:20 +00:00
|
|
|
}
|
|
|
|
|
2020-03-19 09:20:12 +00:00
|
|
|
impl<'a> Type for Upload {
|
2020-03-14 03:46:20 +00:00
|
|
|
fn type_name() -> Cow<'static, str> {
|
|
|
|
Cow::Borrowed("Upload")
|
|
|
|
}
|
|
|
|
|
|
|
|
fn create_type_info(registry: &mut registry::Registry) -> String {
|
|
|
|
registry.create_type::<Self, _>(|_| registry::Type::Scalar {
|
|
|
|
name: Self::type_name().to_string(),
|
|
|
|
description: None,
|
|
|
|
is_valid: |value| match value {
|
|
|
|
Value::String(s) => s.starts_with("file:"),
|
|
|
|
_ => false,
|
|
|
|
},
|
|
|
|
})
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-03-19 09:20:12 +00:00
|
|
|
impl<'a> InputValueType for Upload {
|
2020-05-10 10:27:46 +00:00
|
|
|
fn parse(value: &Value) -> InputValueResult<Self> {
|
2020-03-14 03:46:20 +00:00
|
|
|
if let Value::String(s) = value {
|
|
|
|
if s.starts_with("file:") {
|
|
|
|
let s = &s[5..];
|
2020-03-21 01:32:13 +00:00
|
|
|
if let Some(idx) = s.find('|') {
|
2020-03-14 03:46:20 +00:00
|
|
|
let name_and_type = &s[..idx];
|
2020-04-11 09:36:05 +00:00
|
|
|
let path = &s[idx + 1..];
|
2020-03-21 01:32:13 +00:00
|
|
|
if let Some(type_idx) = name_and_type.find(':') {
|
2020-03-14 03:46:20 +00:00
|
|
|
let name = &name_and_type[..type_idx];
|
|
|
|
let mime_type = &name_and_type[type_idx + 1..];
|
2020-05-10 10:27:46 +00:00
|
|
|
return Ok(Self {
|
2020-03-14 03:46:20 +00:00
|
|
|
filename: name.to_string(),
|
|
|
|
content_type: Some(mime_type.to_string()),
|
2020-04-11 09:36:05 +00:00
|
|
|
path: PathBuf::from(path),
|
2020-03-14 03:46:20 +00:00
|
|
|
});
|
|
|
|
} else {
|
2020-05-10 10:27:46 +00:00
|
|
|
return Ok(Self {
|
2020-03-14 03:46:20 +00:00
|
|
|
filename: name_and_type.to_string(),
|
|
|
|
content_type: None,
|
2020-04-11 09:36:05 +00:00
|
|
|
path: PathBuf::from(path),
|
2020-03-14 03:46:20 +00:00
|
|
|
});
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2020-05-10 10:27:46 +00:00
|
|
|
Err(InputValueError::ExpectedType)
|
2020-03-14 03:46:20 +00:00
|
|
|
}
|
|
|
|
}
|