| | | 1 | | // Licensed to the .NET Foundation under one or more agreements. |
| | | 2 | | // The .NET Foundation licenses this file to you under the MIT license. |
| | | 3 | | |
| | | 4 | | using System.Diagnostics; |
| | | 5 | | using System.Diagnostics.CodeAnalysis; |
| | | 6 | | |
| | | 7 | | namespace System.Net.Http.Headers |
| | | 8 | | { |
| | | 9 | | public class EntityTagHeaderValue : ICloneable |
| | | 10 | | { |
| | 1253 | 11 | | public string Tag { get; private init; } |
| | | 12 | | |
| | 1253 | 13 | | public bool IsWeak { get; private init; } |
| | | 14 | | |
| | 32 | 15 | | public static EntityTagHeaderValue Any { get; } = new EntityTagHeaderValue("*", isWeak: false, false); |
| | | 16 | | |
| | 539 | 17 | | private EntityTagHeaderValue(string tag, bool isWeak, bool _) |
| | 539 | 18 | | { |
| | | 19 | | #if DEBUG |
| | | 20 | | // This constructor should only be used with already validated values. |
| | | 21 | | // "*" is a special case that can only be created via the static Any property. |
| | 539 | 22 | | if (tag != "*") |
| | 538 | 23 | | { |
| | 538 | 24 | | new EntityTagHeaderValue(tag, isWeak); |
| | 538 | 25 | | } |
| | | 26 | | #endif |
| | | 27 | | |
| | 539 | 28 | | Tag = tag; |
| | 539 | 29 | | IsWeak = isWeak; |
| | 539 | 30 | | } |
| | | 31 | | |
| | | 32 | | public EntityTagHeaderValue(string tag) |
| | 0 | 33 | | : this(tag, false) |
| | 0 | 34 | | { |
| | 0 | 35 | | } |
| | | 36 | | |
| | 538 | 37 | | public EntityTagHeaderValue(string tag, bool isWeak) |
| | 538 | 38 | | { |
| | 538 | 39 | | HeaderUtilities.CheckValidQuotedString(tag); |
| | | 40 | | |
| | 538 | 41 | | Tag = tag; |
| | 538 | 42 | | IsWeak = isWeak; |
| | 538 | 43 | | } |
| | | 44 | | |
| | 0 | 45 | | private EntityTagHeaderValue(EntityTagHeaderValue source) |
| | 0 | 46 | | { |
| | 0 | 47 | | Debug.Assert(source != null); |
| | | 48 | | |
| | 0 | 49 | | Tag = source.Tag; |
| | 0 | 50 | | IsWeak = source.IsWeak; |
| | 0 | 51 | | } |
| | | 52 | | |
| | | 53 | | public override string ToString() => |
| | 176 | 54 | | IsWeak ? $"W/{Tag}" : Tag; |
| | | 55 | | |
| | | 56 | | public override bool Equals([NotNullWhen(true)] object? obj) => |
| | 0 | 57 | | obj is EntityTagHeaderValue other && |
| | 0 | 58 | | IsWeak == other.IsWeak && |
| | 0 | 59 | | // Since the tag is a quoted-string we treat it case-sensitive. |
| | 0 | 60 | | string.Equals(Tag, other.Tag, StringComparison.Ordinal); |
| | | 61 | | |
| | | 62 | | public override int GetHashCode() => |
| | 0 | 63 | | HashCode.Combine(Tag, IsWeak); |
| | | 64 | | |
| | | 65 | | public static EntityTagHeaderValue Parse(string input) |
| | 0 | 66 | | { |
| | 0 | 67 | | int index = 0; |
| | 0 | 68 | | return (EntityTagHeaderValue)GenericHeaderParser.SingleValueEntityTagParser.ParseValue( |
| | 0 | 69 | | input, null, ref index); |
| | 0 | 70 | | } |
| | | 71 | | |
| | | 72 | | public static bool TryParse([NotNullWhen(true)] string? input, [NotNullWhen(true)] out EntityTagHeaderValue? par |
| | 0 | 73 | | { |
| | 0 | 74 | | int index = 0; |
| | 0 | 75 | | parsedValue = null; |
| | | 76 | | |
| | 0 | 77 | | if (GenericHeaderParser.SingleValueEntityTagParser.TryParseValue(input, null, ref index, out object? output) |
| | 0 | 78 | | { |
| | 0 | 79 | | parsedValue = (EntityTagHeaderValue)output!; |
| | 0 | 80 | | return true; |
| | | 81 | | } |
| | 0 | 82 | | return false; |
| | 0 | 83 | | } |
| | | 84 | | |
| | | 85 | | internal static int GetEntityTagLength(string? input, int startIndex, out EntityTagHeaderValue? parsedValue) |
| | 1073 | 86 | | { |
| | 1073 | 87 | | Debug.Assert(startIndex >= 0); |
| | | 88 | | |
| | 1073 | 89 | | parsedValue = null; |
| | | 90 | | |
| | 1073 | 91 | | if (string.IsNullOrEmpty(input) || (startIndex >= input.Length)) |
| | 0 | 92 | | { |
| | 0 | 93 | | return 0; |
| | | 94 | | } |
| | | 95 | | |
| | | 96 | | // Caller must remove leading whitespace. If not, we'll return 0. |
| | 1073 | 97 | | bool isWeak = false; |
| | 1073 | 98 | | int current = startIndex; |
| | | 99 | | |
| | 1073 | 100 | | char firstChar = input[startIndex]; |
| | 1073 | 101 | | if (firstChar == '*') |
| | 9 | 102 | | { |
| | | 103 | | // We have '*' value, indicating "any" ETag. |
| | 9 | 104 | | parsedValue = Any; |
| | 9 | 105 | | current++; |
| | 9 | 106 | | } |
| | | 107 | | else |
| | 1064 | 108 | | { |
| | | 109 | | // The RFC defines 'W/' as prefix, but we'll be flexible and also accept lower-case 'w'. |
| | 1064 | 110 | | if ((firstChar == 'W') || (firstChar == 'w')) |
| | 34 | 111 | | { |
| | 34 | 112 | | current++; |
| | | 113 | | // We need at least 3 more chars: the '/' character followed by two quotes. |
| | 34 | 114 | | if ((current + 2 >= input.Length) || (input[current] != '/')) |
| | 18 | 115 | | { |
| | 18 | 116 | | return 0; |
| | | 117 | | } |
| | 16 | 118 | | isWeak = true; |
| | 16 | 119 | | current++; // we have a weak-entity tag. |
| | 16 | 120 | | current += HttpRuleParser.GetWhitespaceLength(input, current); |
| | 16 | 121 | | } |
| | | 122 | | |
| | 1046 | 123 | | if (current == input.Length || HttpRuleParser.GetQuotedStringLength(input, current, out int tagLength) ! |
| | 508 | 124 | | { |
| | 508 | 125 | | return 0; |
| | | 126 | | } |
| | | 127 | | |
| | | 128 | | // Most of the time we'll have strong ETags without leading/trailing whitespace. |
| | 538 | 129 | | Debug.Assert(tagLength != input.Length || (startIndex == 0 && !isWeak)); |
| | | 130 | | |
| | 538 | 131 | | parsedValue = new EntityTagHeaderValue(input.Substring(current, tagLength), isWeak, false); |
| | | 132 | | |
| | 538 | 133 | | current += tagLength; |
| | 538 | 134 | | } |
| | 547 | 135 | | current += HttpRuleParser.GetWhitespaceLength(input, current); |
| | | 136 | | |
| | 547 | 137 | | return current - startIndex; |
| | 1073 | 138 | | } |
| | | 139 | | |
| | 0 | 140 | | object ICloneable.Clone() => ReferenceEquals(this, Any) ? Any : new EntityTagHeaderValue(this); |
| | | 141 | | } |
| | | 142 | | } |
| | | 143 | | |