Skip to content

Add better support for adding form file parameters to web requests #6412

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 6, 2024
Merged

Add better support for adding form file parameters to web requests #6412

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 14 additions & 8 deletions osu.Framework/IO/Network/WebRequest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ public class WebRequest : IDisposable
/// <summary>
/// FILE parameters.
/// </summary>
private readonly IDictionary<string, byte[]> files = new Dictionary<string, byte[]>();
private readonly List<FormFile> files = new List<FormFile>();

/// <summary>
/// The request headers.
Expand Down Expand Up @@ -349,9 +349,9 @@ private async Task internalPerform(CancellationToken cancellationToken = default

foreach (var p in files)
{
var byteContent = new ByteArrayContent(p.Value);
var byteContent = new ByteArrayContent(p.Content);
byteContent.Headers.Add("Content-Type", "application/octet-stream");
formData.Add(byteContent, p.Key, p.Key);
formData.Add(byteContent, p.ParamName, p.Filename);
}

postContent = await formData.ReadAsStreamAsync(linkedToken.Token).ConfigureAwait(false);
Expand Down Expand Up @@ -662,17 +662,21 @@ public void AddRaw(Stream stream)
}

/// <summary>
/// Add a new FILE parameter to this request. Replaces any existing file with the same name.
/// Add a new FILE parameter to this request.
/// This may not be used in conjunction with <see cref="AddRaw(Stream)"/>. GET requests may not contain files.
/// </summary>
/// <param name="name">The name of the file. This becomes the name of the file in a multi-part form POST content.</param>
/// <param name="paramName">The name of the form parameter of the request that the file relates to.</param>
/// <param name="data">The file data.</param>
public void AddFile(string name, byte[] data)
/// <param name="filename">
/// The filename of the file to be sent to be reported to the server in the <c>Content-Disposition</c> header.
/// <c>blob</c> is used by default if omitted, to <see href="https://developer.mozilla.org/en-US/docs/Web/API/FormData/append#filename">mirror browser behaviour</see>.
/// </param>
public void AddFile(string paramName, byte[] data, string filename = "blob")
{
ArgumentNullException.ThrowIfNull(name);
ArgumentNullException.ThrowIfNull(paramName);
ArgumentNullException.ThrowIfNull(data);

files[name] = data;
files.Add(new FormFile(paramName, data, filename));
}

/// <summary>
Expand Down Expand Up @@ -931,5 +935,7 @@ protected override void Dispose(bool disposing)
baseStream.Dispose();
}
}

private record struct FormFile(string ParamName, byte[] Content, string Filename);
}
}
Loading