| | | 1 | | namespace Kestrun.Forms; |
| | | 2 | | |
| | | 3 | | /// <summary> |
| | | 4 | | /// Configures form parsing behavior for Kestrun. |
| | | 5 | | /// </summary> |
| | | 6 | | public sealed class KrFormOptions |
| | | 7 | | { |
| | | 8 | | /// <summary> |
| | | 9 | | /// Gets or sets the name of the form parser. |
| | | 10 | | /// </summary> |
| | 27 | 11 | | public string? Name { get; set; } |
| | | 12 | | |
| | | 13 | | /// <summary> |
| | | 14 | | /// Gets or sets the description of the form parser. |
| | | 15 | | /// </summary> |
| | 2 | 16 | | public string? Description { get; set; } |
| | | 17 | | /// <summary> |
| | | 18 | | /// Gets the allowed request content types. |
| | | 19 | | /// </summary> |
| | 42 | 20 | | public List<string> AllowedContentTypes { get; } = |
| | 28 | 21 | | [ |
| | 28 | 22 | | "multipart/form-data" |
| | 28 | 23 | | ]; |
| | | 24 | | |
| | | 25 | | /// <summary> |
| | | 26 | | /// Gets or sets a value indicating whether unknown request content types should be rejected. |
| | | 27 | | /// </summary> |
| | 38 | 28 | | public bool RejectUnknownRequestContentType { get; set; } = true; |
| | | 29 | | |
| | | 30 | | /// <summary> |
| | | 31 | | /// Gets the form parsing limits. |
| | | 32 | | /// </summary> |
| | 67 | 33 | | public KrFormLimits Limits { get; } = new(); |
| | | 34 | | |
| | | 35 | | /// <summary> |
| | | 36 | | /// Gets or sets the default upload path for stored parts. |
| | | 37 | | /// </summary> |
| | 33 | 38 | | public string DefaultUploadPath { get; set; } = KestrunHostManager.Default?.Options.DefaultUploadPath ?? Path.Combin |
| | | 39 | | |
| | | 40 | | /// <summary> |
| | | 41 | | /// Gets or sets the filename sanitizer. |
| | | 42 | | /// </summary> |
| | 30 | 43 | | public Func<string, string> SanitizeFileName { get; set; } = static name => |
| | 28 | 44 | | { |
| | 0 | 45 | | var sanitized = Path.GetFileName(name); |
| | 0 | 46 | | return string.IsNullOrWhiteSpace(sanitized) ? Path.GetRandomFileName() : sanitized; |
| | 28 | 47 | | }; |
| | | 48 | | |
| | | 49 | | /// <summary> |
| | | 50 | | /// Gets or sets a value indicating whether SHA-256 hashes should be computed for file parts. |
| | | 51 | | /// </summary> |
| | 10 | 52 | | public bool ComputeSha256 { get; set; } |
| | | 53 | | |
| | | 54 | | /// <summary> |
| | | 55 | | /// Gets or sets a value indicating whether per-part decompression is enabled. |
| | | 56 | | /// </summary> |
| | 17 | 57 | | public bool EnablePartDecompression { get; set; } |
| | | 58 | | |
| | | 59 | | /// <summary> |
| | | 60 | | /// Gets the allowed part content encodings for decompression. |
| | | 61 | | /// </summary> |
| | 6 | 62 | | public List<string> AllowedPartContentEncodings { get; } = |
| | 28 | 63 | | [ |
| | 28 | 64 | | "identity", |
| | 28 | 65 | | "gzip", |
| | 28 | 66 | | "deflate", |
| | 28 | 67 | | "br" |
| | 28 | 68 | | ]; |
| | | 69 | | |
| | | 70 | | /// <summary> |
| | | 71 | | /// Gets or sets the maximum decompressed bytes per part. |
| | | 72 | | /// </summary> |
| | 32 | 73 | | public long MaxDecompressedBytesPerPart { get; set; } = 20 * 1024 * 1024; |
| | | 74 | | |
| | | 75 | | /// <summary> |
| | | 76 | | /// Gets or sets a value indicating whether unknown content encodings should be rejected. |
| | | 77 | | /// </summary> |
| | 37 | 78 | | public bool RejectUnknownContentEncoding { get; set; } = true; |
| | | 79 | | |
| | | 80 | | /// <summary> |
| | | 81 | | /// Gets the per-part rules. |
| | | 82 | | /// </summary> |
| | 110 | 83 | | public List<KrFormPartRule> Rules { get; } = []; |
| | | 84 | | |
| | | 85 | | /// <summary> |
| | | 86 | | /// Gets or sets the hook invoked for each part. |
| | | 87 | | /// </summary> |
| | 6 | 88 | | public Func<KrPartContext, ValueTask<KrPartAction>>? OnPart { get; set; } |
| | | 89 | | |
| | | 90 | | /// <summary> |
| | | 91 | | /// Gets or sets the hook invoked after parsing completes. |
| | | 92 | | /// </summary> |
| | 7 | 93 | | public Func<KrFormContext, ValueTask<object?>>? OnCompleted { get; set; } |
| | | 94 | | |
| | | 95 | | /// <summary> |
| | | 96 | | /// Gets or sets the logger used by the form parser. |
| | | 97 | | /// </summary> |
| | 24 | 98 | | public Serilog.ILogger? Logger { get; set; } |
| | | 99 | | |
| | | 100 | | /// <summary> |
| | | 101 | | /// Initializes a new instance of the <see cref="KrFormOptions"/> class. |
| | | 102 | | /// </summary> |
| | 54 | 103 | | public KrFormOptions() { } |
| | | 104 | | |
| | | 105 | | /// <summary> |
| | | 106 | | /// Initializes a new instance of the <see cref="KrFormOptions"/> class by copying settings from another instance. |
| | | 107 | | /// </summary> |
| | | 108 | | /// <param name="copyFrom">The instance to copy settings from.</param> |
| | 1 | 109 | | public KrFormOptions(KrFormOptions copyFrom) |
| | | 110 | | { |
| | 1 | 111 | | Name = copyFrom.Name; |
| | 1 | 112 | | Description = copyFrom.Description; |
| | 1 | 113 | | AllowedContentTypes.AddRange(copyFrom.AllowedContentTypes); |
| | 1 | 114 | | RejectUnknownRequestContentType = copyFrom.RejectUnknownRequestContentType; |
| | 1 | 115 | | DefaultUploadPath = copyFrom.DefaultUploadPath; |
| | 1 | 116 | | SanitizeFileName = copyFrom.SanitizeFileName; |
| | 1 | 117 | | ComputeSha256 = copyFrom.ComputeSha256; |
| | 1 | 118 | | EnablePartDecompression = copyFrom.EnablePartDecompression; |
| | 1 | 119 | | AllowedPartContentEncodings.AddRange(copyFrom.AllowedPartContentEncodings); |
| | 1 | 120 | | MaxDecompressedBytesPerPart = copyFrom.MaxDecompressedBytesPerPart; |
| | 1 | 121 | | RejectUnknownContentEncoding = copyFrom.RejectUnknownContentEncoding; |
| | 1 | 122 | | Rules.AddRange(copyFrom.Rules); |
| | 1 | 123 | | OnPart = copyFrom.OnPart; |
| | 1 | 124 | | OnCompleted = copyFrom.OnCompleted; |
| | 1 | 125 | | Logger = copyFrom.Logger; |
| | | 126 | | // Copy limits |
| | 1 | 127 | | Limits = new KrFormLimits(copyFrom.Limits); |
| | 1 | 128 | | } |
| | | 129 | | } |