| | | 1 | | /******************************************************************************** |
| | | 2 | | * QueryStringParser.cs * |
| | | 3 | | * * |
| | | 4 | | * Author: Denes Solti * |
| | | 5 | | ********************************************************************************/ |
| | | 6 | | using System; |
| | | 7 | | using System.Buffers; |
| | | 8 | | using System.Collections.Frozen; |
| | | 9 | | using System.Collections.Generic; |
| | | 10 | | using System.Diagnostics; |
| | | 11 | | using System.Diagnostics.CodeAnalysis; |
| | | 12 | | using System.Net; |
| | | 13 | | using System.Net.Http; |
| | | 14 | | using System.Threading.Tasks; |
| | | 15 | | |
| | | 16 | | namespace NanoRoute.Internals |
| | | 17 | | { |
| | | 18 | | using Properties; |
| | | 19 | | |
| | 1 | 20 | | internal sealed class QueryStringParser(RequestContext context, FrozenDictionary<ReadOnlyMemory<char>, ParameterPars |
| | | 21 | | { |
| | | 22 | | #region Private |
| | | 23 | | // Extend only lists created by this parser; replace anything supplied by earlier middleware. |
| | | 24 | | private sealed class QueryValueList : List<object?>; |
| | | 25 | | |
| | 1 | 26 | | private static readonly ArrayPool<char> s_arrayPool = ArrayPool<char>.Create(); |
| | | 27 | | |
| | | 28 | | private char[]? _decodedBuffer; |
| | | 29 | | |
| | | 30 | | // Track only query parameters seen during this parse so required checks and duplicate detection |
| | | 31 | | // will not be confused by values that were already present in context.Parameters. |
| | 1 | 32 | | private readonly bool[] _visited = new bool[expectedParameters.Count]; |
| | | 33 | | |
| | | 34 | | // DelimitedSegment is a mutable struct: keep this field non-readonly so MoveNext() updates the _parameter |
| | | 35 | | // itself instead of a defensive copy. |
| | 1 | 36 | | private DelimitedSegment _parameter = new(GetRawQuery(context.Request.RequestUri), '&'); |
| | | 37 | | |
| | | 38 | | private int _nextDecoded; |
| | | 39 | | |
| | | 40 | | // Keep Parse() state-machine-free while all query value parsers complete synchronously. |
| | | 41 | | // If a parser really suspends, this helper resumes the current parameter and finishes the loop. |
| | | 42 | | private async ValueTask ParseAwaitedAsync(ParameterParser expectedParameter, ValueTask<ValueParseResult> parseRe |
| | | 43 | | { |
| | | 44 | | AcceptParameter(expectedParameter.Definition, await parseResult.ConfigureAwait(false)); |
| | | 45 | | await Parse().ConfigureAwait(false); |
| | | 46 | | } |
| | | 47 | | |
| | | 48 | | private void AcceptParameter(ParameterDefinition parameterDefinition, ValueParseResult parseResult) |
| | 1 | 49 | | { |
| | 1 | 50 | | if (!parseResult.Success) |
| | 1 | 51 | | ThrowBadRequest(Resources.ERR_QUERY_INVALID_PARAMETER, parameterDefinition.ParameterName!); |
| | | 52 | | |
| | 1 | 53 | | if (parameterDefinition.ValueParser.IsList) |
| | 1 | 54 | | { |
| | 1 | 55 | | if (!context.Parameters.TryGetValue(parameterDefinition.ParameterName!, out object? val) || val is not Q |
| | 1 | 56 | | context.Parameters[parameterDefinition.ParameterName!] = lst = []; |
| | | 57 | | |
| | 1 | 58 | | lst.Add(parseResult.Parsed); |
| | 1 | 59 | | } |
| | | 60 | | else |
| | 1 | 61 | | context.Parameters[parameterDefinition.ParameterName!] = parseResult.Parsed; |
| | 1 | 62 | | } |
| | | 63 | | |
| | | 64 | | private ReadOnlyMemory<char> DecodeParameter(ReadOnlyMemory<char> source) |
| | 1 | 65 | | { |
| | 1 | 66 | | if (source.Span.IndexOfAny('%', '+') < 0) |
| | 1 | 67 | | return source; |
| | | 68 | | |
| | 1 | 69 | | char[] decodedBuffer = _decodedBuffer ??= s_arrayPool.Rent(_parameter.Remaining.Length); |
| | | 70 | | |
| | 1 | 71 | | if (!UrlUtils.TryDecodeUrl(source.Span, decodedBuffer.AsSpan(_nextDecoded), UrlDecodeMode.Form, out int char |
| | 1 | 72 | | ThrowBadRequest(Resources.ERR_DECODING_FAILED); |
| | | 73 | | |
| | 1 | 74 | | ReadOnlyMemory<char> result = decodedBuffer.AsMemory(_nextDecoded, charsWritten); |
| | 1 | 75 | | _nextDecoded += charsWritten; |
| | | 76 | | |
| | 1 | 77 | | return result; |
| | 1 | 78 | | } |
| | | 79 | | |
| | | 80 | | private static ReadOnlyMemory<char> GetRawQuery(Uri uri) |
| | 1 | 81 | | { |
| | 1 | 82 | | ReadOnlyMemory<char> raw = uri.OriginalString.AsMemory(); |
| | | 83 | | |
| | 1 | 84 | | int fragmentIndex = raw.Span.IndexOf('#'); |
| | 1 | 85 | | if (fragmentIndex >= 0) |
| | 1 | 86 | | raw = raw.Slice(0, fragmentIndex); |
| | | 87 | | |
| | 1 | 88 | | int queryIndex = raw.Span.IndexOf('?'); |
| | 1 | 89 | | return queryIndex >= 0 |
| | 1 | 90 | | ? raw.Slice(queryIndex + 1) |
| | 1 | 91 | | : default; |
| | 1 | 92 | | } |
| | | 93 | | |
| | | 94 | | [DoesNotReturn] |
| | 1 | 95 | | private static void ThrowBadRequest(string? error, params object[] paramz) => HttpRequestException.Throw |
| | 1 | 96 | | ( |
| | 1 | 97 | | HttpStatusCode.BadRequest, |
| | 1 | 98 | | Resources.ERR_BAD_REQUEST, |
| | 1 | 99 | | !string.IsNullOrEmpty(error) ? [string.Format(Resources.Culture, error, paramz)] : [] |
| | 1 | 100 | | ); |
| | | 101 | | #endregion |
| | | 102 | | |
| | | 103 | | public void Dispose() |
| | 1 | 104 | | { |
| | 1 | 105 | | if (_decodedBuffer is not null) |
| | 1 | 106 | | s_arrayPool.Return(_decodedBuffer, clearArray: false); |
| | 1 | 107 | | } |
| | | 108 | | |
| | | 109 | | public ValueTask Parse() |
| | 1 | 110 | | { |
| | 1 | 111 | | while (_parameter.MoveNext()) |
| | 1 | 112 | | { |
| | 1 | 113 | | int separatorIndex = _parameter.Current.Span.IndexOf('='); |
| | 1 | 114 | | if (separatorIndex <= 0) |
| | 1 | 115 | | ThrowBadRequest(null); |
| | | 116 | | |
| | 1 | 117 | | ReadOnlyMemory<char> parameterName = DecodeParameter(_parameter.Current.Slice(0, separatorIndex)); |
| | | 118 | | |
| | 1 | 119 | | if (!expectedParameters.TryGetValue(parameterName, out ParameterParser? expectedParameter)) |
| | 1 | 120 | | { |
| | 1 | 121 | | switch (config.UnexpectedParameterBehavior) |
| | | 122 | | { |
| | | 123 | | case UnexpectedParameterBehavior.Ignore: |
| | 1 | 124 | | continue; |
| | | 125 | | |
| | | 126 | | case UnexpectedParameterBehavior.Reject: |
| | 1 | 127 | | ThrowBadRequest(Resources.ERR_QUERY_UNEXPECTED_PARAMETER, parameterName); |
| | | 128 | | break; |
| | | 129 | | |
| | | 130 | | default: |
| | 0 | 131 | | Debug.Fail($"Unknown {nameof(UnexpectedParameterBehavior)} value: {config.UnexpectedParamete |
| | 0 | 132 | | break; |
| | | 133 | | } |
| | 0 | 134 | | } |
| | | 135 | | |
| | 1 | 136 | | ParameterDefinition parameterDefinition = expectedParameter!.Definition; |
| | | 137 | | |
| | 1 | 138 | | if (_visited[parameterDefinition.Index] && !parameterDefinition.ValueParser.IsList) |
| | 1 | 139 | | ThrowBadRequest(Resources.ERR_QUERY_DUPLICATE_PARAMETER, parameterDefinition.ParameterName!); |
| | | 140 | | |
| | 1 | 141 | | _visited[parameterDefinition.Index] = true; |
| | | 142 | | |
| | 1 | 143 | | ValueTask<ValueParseResult> parseResult = expectedParameter.Parse |
| | 1 | 144 | | ( |
| | 1 | 145 | | new ValueParserContext |
| | 1 | 146 | | { |
| | 1 | 147 | | Segment = DecodeParameter(_parameter.Current.Slice(separatorIndex + 1)), |
| | 1 | 148 | | Services = context.Services, |
| | 1 | 149 | | Arguments = expectedParameter.Arguments, |
| | 1 | 150 | | Cancellation = context.Cancellation |
| | 1 | 151 | | } |
| | 1 | 152 | | ); |
| | | 153 | | |
| | 1 | 154 | | if (!parseResult.IsCompletedSuccessfully) |
| | 1 | 155 | | return ParseAwaitedAsync(expectedParameter, parseResult); |
| | | 156 | | |
| | 1 | 157 | | AcceptParameter(parameterDefinition, parseResult.Result); |
| | 1 | 158 | | } |
| | | 159 | | |
| | 1 | 160 | | foreach (ParameterParser expectedParameter in expectedParameters.Values) |
| | 1 | 161 | | { |
| | 1 | 162 | | ParameterDefinition parameterDefinition = expectedParameter.Definition; |
| | | 163 | | |
| | 1 | 164 | | if (!parameterDefinition.IsOptional && !_visited[parameterDefinition.Index]) |
| | 1 | 165 | | ThrowBadRequest(Resources.ERR_QUERY_MISSING_PARAMETER, parameterDefinition.ParameterName!); |
| | 1 | 166 | | } |
| | | 167 | | |
| | 1 | 168 | | return default; |
| | 1 | 169 | | } |
| | | 170 | | } |
| | | 171 | | } |