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
use std::{borrow::Cow, io::Read, sync::Arc};
#[cfg(feature = "unblock")]
use futures_util::io::AsyncRead;
use crate::{
registry, registry::MetaTypeId, Context, InputType, InputValueError, InputValueResult, 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.
#[cfg(feature = "tempfile")]
pub content: std::fs::File,
/// The file data.
#[cfg(not(feature = "tempfile"))]
pub content: bytes::Bytes,
}
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> {
#[cfg(feature = "tempfile")]
{
Ok(Self {
filename: self.filename.clone(),
content_type: self.content_type.clone(),
content: self.content.try_clone()?,
})
}
#[cfg(not(feature = "tempfile"))]
{
Ok(Self {
filename: self.filename.clone(),
content_type: self.content_type.clone(),
content: self.content.clone(),
})
}
}
/// Convert to a `Read`.
///
/// **Note**: this is a *synchronous/blocking* reader.
pub fn into_read(self) -> impl Read + Sync + Send + 'static {
#[cfg(feature = "tempfile")]
{
self.content
}
#[cfg(not(feature = "tempfile"))]
{
std::io::Cursor::new(self.content)
}
}
/// Convert to a `AsyncRead`.
#[cfg(feature = "unblock")]
#[cfg_attr(docsrs, doc(cfg(feature = "unblock")))]
pub fn into_async_read(self) -> impl AsyncRead + Sync + Send + 'static {
#[cfg(feature = "tempfile")]
{
blocking::Unblock::new(self.content)
}
#[cfg(not(feature = "tempfile"))]
{
std::io::Cursor::new(self.content)
}
}
/// Returns the size of the file, in bytes.
pub fn size(&self) -> std::io::Result<u64> {
#[cfg(feature = "tempfile")]
{
self.content.metadata().map(|meta| meta.len())
}
#[cfg(not(feature = "tempfile"))]
{
Ok(self.content.len() as u64)
}
}
}
/// 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 Mutation;
///
/// #[Object]
/// impl Mutation {
/// 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 Mutation 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 InputType for Upload {
type RawValueType = Self;
fn type_name() -> Cow<'static, str> {
Cow::Borrowed("Upload")
}
fn create_type_info(registry: &mut registry::Registry) -> String {
registry.create_input_type::<Self, _>(MetaTypeId::Scalar, |_| registry::MetaType::Scalar {
name: Self::type_name().to_string(),
description: None,
is_valid: Some(Arc::new(|value| matches!(value, Value::String(_)))),
visible: None,
inaccessible: false,
tags: Default::default(),
specified_by_url: Some(
"https://github.com/jaydenseric/graphql-multipart-request-spec".to_string(),
),
})
}
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
}
fn as_raw_value(&self) -> Option<&Self::RawValueType> {
Some(self)
}
}