133 lines
3.8 KiB
Rust
133 lines
3.8 KiB
Rust
use std::borrow::Cow;
|
|
use std::fs::File;
|
|
use std::io::Read;
|
|
|
|
#[cfg(feature = "unblock")]
|
|
use futures_util::io::AsyncRead;
|
|
|
|
use crate::{registry, Context, InputType, InputValueError, InputValueResult, Type, Value};
|
|
|
|
/// A file upload value.
|
|
pub struct UploadValue {
|
|
/// The name of the file.
|
|
pub filename: String,
|
|
/// The content type of the file.
|
|
pub content_type: Option<String>,
|
|
/// The file data.
|
|
pub content: File,
|
|
}
|
|
|
|
impl UploadValue {
|
|
/// Attempt to clone the upload value. This type's `Clone` implementation simply calls this and
|
|
/// panics on failure.
|
|
///
|
|
/// # Errors
|
|
///
|
|
/// Fails if cloning the inner `File` fails.
|
|
pub fn try_clone(&self) -> std::io::Result<Self> {
|
|
Ok(Self {
|
|
filename: self.filename.clone(),
|
|
content_type: self.content_type.clone(),
|
|
content: self.content.try_clone()?,
|
|
})
|
|
}
|
|
|
|
/// Convert to a `Read`.
|
|
///
|
|
/// **Note**: this is a *synchronous/blocking* reader.
|
|
pub fn into_read(self) -> impl Read + Sync + Send + 'static {
|
|
self.content
|
|
}
|
|
|
|
#[cfg(feature = "unblock")]
|
|
#[cfg_attr(feature = "nightly", doc(cfg(feature = "unblock")))]
|
|
/// Convert to a `AsyncRead`.
|
|
pub fn into_async_read(self) -> impl AsyncRead + Sync + Send + 'static {
|
|
blocking::Unblock::new(self.content)
|
|
}
|
|
|
|
/// Returns the size of the file, in bytes.
|
|
pub fn size(&self) -> std::io::Result<u64> {
|
|
self.content.metadata().map(|meta| meta.len())
|
|
}
|
|
}
|
|
|
|
/// Uploaded file
|
|
///
|
|
/// **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
|
|
/// *[Full Example](<https://github.com/async-graphql/examples/blob/master/models/files/src/lib.rs>)*
|
|
///
|
|
/// ```
|
|
/// use async_graphql::*;
|
|
///
|
|
/// struct MutationRoot;
|
|
///
|
|
/// #[Object]
|
|
/// impl MutationRoot {
|
|
/// async fn upload(&self, ctx: &Context<'_>, file: Upload) -> bool {
|
|
/// println!("upload: filename={}", file.value(ctx).unwrap().filename);
|
|
/// true
|
|
/// }
|
|
/// }
|
|
///
|
|
/// ```
|
|
/// # Example Curl Request
|
|
/// Assuming you have defined your MutationRoot like in the example above,
|
|
/// you can now upload a file `myFile.txt` with the below curl command:
|
|
///
|
|
/// ```curl
|
|
/// curl 'localhost:8000' \
|
|
/// --form 'operations={
|
|
/// "query": "mutation ($file: Upload!) { upload(file: $file) }",
|
|
/// "variables": { "file": null }}' \
|
|
/// --form 'map={ "0": ["variables.file"] }' \
|
|
/// --form '0=@myFile.txt'
|
|
/// ```
|
|
pub struct Upload(usize);
|
|
|
|
impl Upload {
|
|
/// Get the upload value.
|
|
pub fn value(&self, ctx: &Context<'_>) -> std::io::Result<UploadValue> {
|
|
ctx.query_env.uploads[self.0].try_clone()
|
|
}
|
|
}
|
|
|
|
impl Type for Upload {
|
|
fn type_name() -> Cow<'static, str> {
|
|
Cow::Borrowed("Upload")
|
|
}
|
|
|
|
fn create_type_info(registry: &mut registry::Registry) -> String {
|
|
registry.create_type::<Self, _>(|_| registry::MetaType::Scalar {
|
|
name: Self::type_name().to_string(),
|
|
description: None,
|
|
is_valid: |value| matches!(value, Value::String(_)),
|
|
})
|
|
}
|
|
}
|
|
|
|
impl InputType for Upload {
|
|
fn parse(value: Option<Value>) -> InputValueResult<Self> {
|
|
const PREFIX: &str = "#__graphql_file__:";
|
|
let value = value.unwrap_or_default();
|
|
if let Value::String(s) = &value {
|
|
if let Some(filename) = s.strip_prefix(PREFIX) {
|
|
return Ok(Upload(filename.parse::<usize>().unwrap()));
|
|
}
|
|
}
|
|
Err(InputValueError::expected_type(value))
|
|
}
|
|
|
|
fn to_value(&self) -> Value {
|
|
Value::Null
|
|
}
|
|
}
|