509 lines
17 KiB
C#
509 lines
17 KiB
C#
//
|
|
// HttpHeaders.cs
|
|
//
|
|
// Authors:
|
|
// Marek Safar <marek.safar@gmail.com>
|
|
//
|
|
// Copyright (C) 2011 Xamarin Inc (http://www.xamarin.com)
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining
|
|
// a copy of this software and associated documentation files (the
|
|
// "Software"), to deal in the Software without restriction, including
|
|
// without limitation the rights to use, copy, modify, merge, publish,
|
|
// distribute, sublicense, and/or sell copies of the Software, and to
|
|
// permit persons to whom the Software is furnished to do so, subject to
|
|
// the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be
|
|
// included in all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
|
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
|
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
//
|
|
|
|
using System.Collections;
|
|
using System.Collections.Generic;
|
|
using System.Linq;
|
|
using System.Text;
|
|
|
|
namespace System.Net.Http.Headers
|
|
{
|
|
public abstract class HttpHeaders : IEnumerable<KeyValuePair<string, IEnumerable<string>>>
|
|
{
|
|
class HeaderBucket
|
|
{
|
|
//
|
|
// headers can hold an object of 3 kinds
|
|
// - simple type for parsed single values (e.g. DateTime)
|
|
// - CollectionHeader for multi-value headers
|
|
// - List<string> for not checked single values
|
|
//
|
|
public object Parsed;
|
|
List<string> values;
|
|
|
|
public readonly Func<object, string> CustomToString;
|
|
|
|
public HeaderBucket (object parsed, Func<object, string> converter)
|
|
{
|
|
this.Parsed = parsed;
|
|
this.CustomToString = converter;
|
|
}
|
|
|
|
public bool HasStringValues {
|
|
get {
|
|
return values != null && values.Count > 0;
|
|
}
|
|
}
|
|
|
|
public List<string> Values {
|
|
get {
|
|
return values ?? (values = new List<string> ());
|
|
}
|
|
set {
|
|
values = value;
|
|
}
|
|
}
|
|
|
|
public string ParsedToString ()
|
|
{
|
|
if (Parsed == null)
|
|
return null;
|
|
|
|
if (CustomToString != null)
|
|
return CustomToString (Parsed);
|
|
|
|
return Parsed.ToString ();
|
|
}
|
|
}
|
|
|
|
static readonly Dictionary<string, HeaderInfo> known_headers;
|
|
|
|
static HttpHeaders ()
|
|
{
|
|
var headers = new[] {
|
|
HeaderInfo.CreateMulti<MediaTypeWithQualityHeaderValue> ("Accept", MediaTypeWithQualityHeaderValue.TryParse, HttpHeaderKind.Request),
|
|
HeaderInfo.CreateMulti<StringWithQualityHeaderValue> ("Accept-Charset", StringWithQualityHeaderValue.TryParse, HttpHeaderKind.Request),
|
|
HeaderInfo.CreateMulti<StringWithQualityHeaderValue> ("Accept-Encoding", StringWithQualityHeaderValue.TryParse, HttpHeaderKind.Request),
|
|
HeaderInfo.CreateMulti<StringWithQualityHeaderValue> ("Accept-Language", StringWithQualityHeaderValue.TryParse, HttpHeaderKind.Request),
|
|
HeaderInfo.CreateMulti<string> ("Accept-Ranges", CollectionParser.TryParse, HttpHeaderKind.Response),
|
|
HeaderInfo.CreateSingle<TimeSpan> ("Age", Parser.TimeSpanSeconds.TryParse, HttpHeaderKind.Response),
|
|
HeaderInfo.CreateMulti<string> ("Allow", CollectionParser.TryParse, HttpHeaderKind.Content, 0),
|
|
HeaderInfo.CreateSingle<AuthenticationHeaderValue> ("Authorization", AuthenticationHeaderValue.TryParse, HttpHeaderKind.Request),
|
|
HeaderInfo.CreateSingle<CacheControlHeaderValue> ("Cache-Control", CacheControlHeaderValue.TryParse, HttpHeaderKind.Request | HttpHeaderKind.Response),
|
|
HeaderInfo.CreateMulti<string> ("Connection", CollectionParser.TryParse, HttpHeaderKind.Request | HttpHeaderKind.Response),
|
|
HeaderInfo.CreateSingle<ContentDispositionHeaderValue> ("Content-Disposition", ContentDispositionHeaderValue.TryParse, HttpHeaderKind.Content),
|
|
HeaderInfo.CreateMulti<string> ("Content-Encoding", CollectionParser.TryParse, HttpHeaderKind.Content),
|
|
HeaderInfo.CreateMulti<string> ("Content-Language", CollectionParser.TryParse, HttpHeaderKind.Content),
|
|
HeaderInfo.CreateSingle<long> ("Content-Length", Parser.Long.TryParse, HttpHeaderKind.Content),
|
|
HeaderInfo.CreateSingle<Uri> ("Content-Location", Parser.Uri.TryParse, HttpHeaderKind.Content),
|
|
HeaderInfo.CreateSingle<byte[]> ("Content-MD5", Parser.MD5.TryParse, HttpHeaderKind.Content),
|
|
HeaderInfo.CreateSingle<ContentRangeHeaderValue> ("Content-Range", ContentRangeHeaderValue.TryParse, HttpHeaderKind.Content),
|
|
HeaderInfo.CreateSingle<MediaTypeHeaderValue> ("Content-Type", MediaTypeHeaderValue.TryParse, HttpHeaderKind.Content),
|
|
HeaderInfo.CreateSingle<DateTimeOffset> ("Date", Parser.DateTime.TryParse, HttpHeaderKind.Request | HttpHeaderKind.Response, Parser.DateTime.ToString),
|
|
HeaderInfo.CreateSingle<EntityTagHeaderValue> ("ETag", EntityTagHeaderValue.TryParse, HttpHeaderKind.Response),
|
|
HeaderInfo.CreateMulti<NameValueWithParametersHeaderValue> ("Expect", NameValueWithParametersHeaderValue.TryParse, HttpHeaderKind.Request),
|
|
HeaderInfo.CreateSingle<DateTimeOffset> ("Expires", Parser.DateTime.TryParse, HttpHeaderKind.Content, Parser.DateTime.ToString),
|
|
HeaderInfo.CreateSingle<string> ("From", Parser.EmailAddress.TryParse, HttpHeaderKind.Request),
|
|
HeaderInfo.CreateSingle<string> ("Host", Parser.Host.TryParse, HttpHeaderKind.Request),
|
|
HeaderInfo.CreateMulti<EntityTagHeaderValue> ("If-Match", EntityTagHeaderValue.TryParse, HttpHeaderKind.Request),
|
|
HeaderInfo.CreateSingle<DateTimeOffset> ("If-Modified-Since", Parser.DateTime.TryParse, HttpHeaderKind.Request, Parser.DateTime.ToString),
|
|
HeaderInfo.CreateMulti<EntityTagHeaderValue> ("If-None-Match", EntityTagHeaderValue.TryParse, HttpHeaderKind.Request),
|
|
HeaderInfo.CreateSingle<RangeConditionHeaderValue> ("If-Range", RangeConditionHeaderValue.TryParse, HttpHeaderKind.Request),
|
|
HeaderInfo.CreateSingle<DateTimeOffset> ("If-Unmodified-Since", Parser.DateTime.TryParse, HttpHeaderKind.Request, Parser.DateTime.ToString),
|
|
HeaderInfo.CreateSingle<DateTimeOffset> ("Last-Modified", Parser.DateTime.TryParse, HttpHeaderKind.Content, Parser.DateTime.ToString),
|
|
HeaderInfo.CreateSingle<Uri> ("Location", Parser.Uri.TryParse, HttpHeaderKind.Response),
|
|
HeaderInfo.CreateSingle<int> ("Max-Forwards", Parser.Int.TryParse, HttpHeaderKind.Request),
|
|
HeaderInfo.CreateMulti<NameValueHeaderValue> ("Pragma", NameValueHeaderValue.TryParsePragma, HttpHeaderKind.Request | HttpHeaderKind.Response),
|
|
HeaderInfo.CreateMulti<AuthenticationHeaderValue> ("Proxy-Authenticate", AuthenticationHeaderValue.TryParse, HttpHeaderKind.Response),
|
|
HeaderInfo.CreateSingle<AuthenticationHeaderValue> ("Proxy-Authorization", AuthenticationHeaderValue.TryParse, HttpHeaderKind.Request),
|
|
HeaderInfo.CreateSingle<RangeHeaderValue> ("Range", RangeHeaderValue.TryParse, HttpHeaderKind.Request),
|
|
HeaderInfo.CreateSingle<Uri> ("Referer", Parser.Uri.TryParse, HttpHeaderKind.Request),
|
|
HeaderInfo.CreateSingle<RetryConditionHeaderValue> ("Retry-After", RetryConditionHeaderValue.TryParse, HttpHeaderKind.Response),
|
|
HeaderInfo.CreateMulti<ProductInfoHeaderValue> ("Server", ProductInfoHeaderValue.TryParse, HttpHeaderKind.Response, separator: " "),
|
|
HeaderInfo.CreateMulti<TransferCodingWithQualityHeaderValue> ("TE", TransferCodingWithQualityHeaderValue.TryParse, HttpHeaderKind.Request, 0),
|
|
HeaderInfo.CreateMulti<string> ("Trailer", CollectionParser.TryParse, HttpHeaderKind.Request | HttpHeaderKind.Response),
|
|
HeaderInfo.CreateMulti<TransferCodingHeaderValue> ("Transfer-Encoding", TransferCodingHeaderValue.TryParse, HttpHeaderKind.Request | HttpHeaderKind.Response),
|
|
HeaderInfo.CreateMulti<ProductHeaderValue> ("Upgrade", ProductHeaderValue.TryParse, HttpHeaderKind.Request | HttpHeaderKind.Response),
|
|
HeaderInfo.CreateMulti<ProductInfoHeaderValue> ("User-Agent", ProductInfoHeaderValue.TryParse, HttpHeaderKind.Request, separator: " "),
|
|
HeaderInfo.CreateMulti<string> ("Vary", CollectionParser.TryParse, HttpHeaderKind.Response),
|
|
HeaderInfo.CreateMulti<ViaHeaderValue> ("Via", ViaHeaderValue.TryParse, HttpHeaderKind.Request | HttpHeaderKind.Response),
|
|
HeaderInfo.CreateMulti<WarningHeaderValue> ("Warning", WarningHeaderValue.TryParse, HttpHeaderKind.Request | HttpHeaderKind.Response),
|
|
HeaderInfo.CreateMulti<AuthenticationHeaderValue> ("WWW-Authenticate", AuthenticationHeaderValue.TryParse, HttpHeaderKind.Response)
|
|
};
|
|
|
|
known_headers = new Dictionary<string, HeaderInfo> (StringComparer.OrdinalIgnoreCase);
|
|
foreach (var header in headers) {
|
|
known_headers.Add (header.Name, header);
|
|
}
|
|
}
|
|
|
|
readonly Dictionary<string, HeaderBucket> headers;
|
|
readonly HttpHeaderKind HeaderKind;
|
|
|
|
internal bool? connectionclose, transferEncodingChunked;
|
|
|
|
protected HttpHeaders ()
|
|
{
|
|
headers = new Dictionary<string, HeaderBucket> (StringComparer.OrdinalIgnoreCase);
|
|
}
|
|
|
|
internal HttpHeaders (HttpHeaderKind headerKind)
|
|
: this ()
|
|
{
|
|
this.HeaderKind = headerKind;
|
|
}
|
|
|
|
public void Add (string name, string value)
|
|
{
|
|
Add (name, new[] { value });
|
|
}
|
|
|
|
public void Add (string name, IEnumerable<string> values)
|
|
{
|
|
if (values == null)
|
|
throw new ArgumentNullException ("values");
|
|
|
|
AddInternal (name, values, CheckName (name), false);
|
|
}
|
|
|
|
internal bool AddValue (string value, HeaderInfo headerInfo, bool ignoreInvalid)
|
|
{
|
|
return AddInternal (headerInfo.Name, new [] { value }, headerInfo, ignoreInvalid);
|
|
}
|
|
|
|
bool AddInternal (string name, IEnumerable<string> values, HeaderInfo headerInfo, bool ignoreInvalid)
|
|
{
|
|
HeaderBucket bucket;
|
|
headers.TryGetValue (name, out bucket);
|
|
bool ok = true;
|
|
|
|
foreach (var value in values) {
|
|
bool first_entry = bucket == null;
|
|
|
|
if (headerInfo != null) {
|
|
object parsed_value;
|
|
if (!headerInfo.TryParse (value, out parsed_value)) {
|
|
if (ignoreInvalid) {
|
|
ok = false;
|
|
continue;
|
|
}
|
|
|
|
throw new FormatException ();
|
|
}
|
|
|
|
if (headerInfo.AllowsMany) {
|
|
if (bucket == null)
|
|
bucket = new HeaderBucket (headerInfo.CreateCollection (this), headerInfo.CustomToString);
|
|
|
|
headerInfo.AddToCollection (bucket.Parsed, parsed_value);
|
|
} else {
|
|
if (bucket != null)
|
|
throw new FormatException ();
|
|
|
|
bucket = new HeaderBucket (parsed_value, headerInfo.CustomToString);
|
|
}
|
|
} else {
|
|
if (bucket == null)
|
|
bucket = new HeaderBucket (null, null);
|
|
|
|
bucket.Values.Add (value ?? string.Empty);
|
|
}
|
|
|
|
if (first_entry) {
|
|
headers.Add (name, bucket);
|
|
}
|
|
}
|
|
|
|
return ok;
|
|
}
|
|
|
|
public bool TryAddWithoutValidation (string name, string value)
|
|
{
|
|
return TryAddWithoutValidation (name, new[] { value });
|
|
}
|
|
|
|
public bool TryAddWithoutValidation (string name, IEnumerable<string> values)
|
|
{
|
|
if (values == null)
|
|
throw new ArgumentNullException ("values");
|
|
|
|
HeaderInfo headerInfo;
|
|
if (!TryCheckName (name, out headerInfo))
|
|
return false;
|
|
|
|
AddInternal (name, values, null, true);
|
|
return true;
|
|
}
|
|
|
|
HeaderInfo CheckName (string name)
|
|
{
|
|
if (string.IsNullOrEmpty (name))
|
|
throw new ArgumentException ("name");
|
|
|
|
Parser.Token.Check (name);
|
|
|
|
HeaderInfo headerInfo;
|
|
if (known_headers.TryGetValue (name, out headerInfo) && (headerInfo.HeaderKind & HeaderKind) == 0) {
|
|
if (HeaderKind != HttpHeaderKind.None && ((HeaderKind | headerInfo.HeaderKind) & HttpHeaderKind.Content) != 0)
|
|
throw new InvalidOperationException (name);
|
|
|
|
return null;
|
|
}
|
|
|
|
return headerInfo;
|
|
}
|
|
|
|
bool TryCheckName (string name, out HeaderInfo headerInfo)
|
|
{
|
|
if (!Parser.Token.TryCheck (name)) {
|
|
headerInfo = null;
|
|
return false;
|
|
}
|
|
|
|
if (known_headers.TryGetValue (name, out headerInfo) && (headerInfo.HeaderKind & HeaderKind) == 0) {
|
|
if (HeaderKind != HttpHeaderKind.None && ((HeaderKind | headerInfo.HeaderKind) & HttpHeaderKind.Content) != 0)
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
public void Clear ()
|
|
{
|
|
connectionclose = null;
|
|
transferEncodingChunked = null;
|
|
headers.Clear ();
|
|
}
|
|
|
|
public bool Contains (string name)
|
|
{
|
|
CheckName (name);
|
|
|
|
return headers.ContainsKey (name);
|
|
}
|
|
|
|
public IEnumerator<KeyValuePair<string, IEnumerable<string>>> GetEnumerator ()
|
|
{
|
|
foreach (var entry in headers) {
|
|
var bucket = headers[entry.Key];
|
|
|
|
HeaderInfo headerInfo;
|
|
known_headers.TryGetValue (entry.Key, out headerInfo);
|
|
|
|
var svalues = GetAllHeaderValues (bucket, headerInfo);
|
|
if (svalues == null)
|
|
continue;
|
|
|
|
yield return new KeyValuePair<string, IEnumerable<string>> (entry.Key, svalues);
|
|
}
|
|
}
|
|
|
|
IEnumerator IEnumerable.GetEnumerator ()
|
|
{
|
|
return GetEnumerator ();
|
|
}
|
|
|
|
public IEnumerable<string> GetValues (string name)
|
|
{
|
|
CheckName (name);
|
|
|
|
IEnumerable<string> values;
|
|
if (!TryGetValues (name, out values))
|
|
throw new InvalidOperationException ();
|
|
|
|
return values;
|
|
}
|
|
|
|
public bool Remove (string name)
|
|
{
|
|
CheckName (name);
|
|
return headers.Remove (name);
|
|
}
|
|
|
|
public bool TryGetValues (string name, out IEnumerable<string> values)
|
|
{
|
|
HeaderInfo headerInfo;
|
|
if (!TryCheckName (name, out headerInfo)) {
|
|
values = null;
|
|
return false;
|
|
}
|
|
|
|
HeaderBucket bucket;
|
|
if (!headers.TryGetValue (name, out bucket)) {
|
|
values = null;
|
|
return false;
|
|
}
|
|
|
|
values = GetAllHeaderValues (bucket, headerInfo);
|
|
return true;
|
|
}
|
|
|
|
internal static string GetSingleHeaderString (string key, IEnumerable<string> values)
|
|
{
|
|
string separator = ",";
|
|
HeaderInfo headerInfo;
|
|
if (known_headers.TryGetValue (key, out headerInfo) && headerInfo.AllowsMany)
|
|
separator = headerInfo.Separator;
|
|
|
|
var sb = new StringBuilder ();
|
|
bool first = true;
|
|
foreach (var v in values) {
|
|
if (!first) {
|
|
sb.Append (separator);
|
|
if (separator != " ")
|
|
sb.Append (" ");
|
|
}
|
|
|
|
sb.Append (v);
|
|
first = false;
|
|
}
|
|
|
|
// Return null for empty values list
|
|
if (first)
|
|
return null;
|
|
|
|
return sb.ToString ();
|
|
}
|
|
|
|
public override string ToString ()
|
|
{
|
|
var sb = new StringBuilder ();
|
|
foreach (var entry in this) {
|
|
sb.Append (entry.Key);
|
|
sb.Append (": ");
|
|
sb.Append (GetSingleHeaderString (entry.Key, entry.Value));
|
|
sb.Append ("\r\n");
|
|
}
|
|
|
|
return sb.ToString ();
|
|
}
|
|
|
|
internal void AddOrRemove (string name, string value)
|
|
{
|
|
if (string.IsNullOrEmpty (value))
|
|
Remove (name);
|
|
else
|
|
SetValue (name, value);
|
|
}
|
|
|
|
internal void AddOrRemove<T> (string name, T value, Func<object, string> converter = null) where T : class
|
|
{
|
|
if (value == null)
|
|
Remove (name);
|
|
else
|
|
SetValue (name, value, converter);
|
|
}
|
|
|
|
internal void AddOrRemove<T> (string name, T? value) where T : struct
|
|
{
|
|
AddOrRemove<T> (name, value, null);
|
|
}
|
|
|
|
internal void AddOrRemove<T> (string name, T? value, Func<object, string> converter) where T : struct
|
|
{
|
|
if (!value.HasValue)
|
|
Remove (name);
|
|
else
|
|
SetValue (name, value, converter);
|
|
}
|
|
|
|
List<string> GetAllHeaderValues (HeaderBucket bucket, HeaderInfo headerInfo)
|
|
{
|
|
List<string> string_values = null;
|
|
if (headerInfo != null && headerInfo.AllowsMany) {
|
|
string_values = headerInfo.ToStringCollection (bucket.Parsed);
|
|
} else {
|
|
if (bucket.Parsed != null) {
|
|
string s = bucket.ParsedToString ();
|
|
if (!string.IsNullOrEmpty (s)) {
|
|
string_values = new List<string> ();
|
|
string_values.Add (s);
|
|
}
|
|
}
|
|
}
|
|
|
|
if (bucket.HasStringValues) {
|
|
if (string_values == null)
|
|
string_values = new List<string> ();
|
|
|
|
string_values.AddRange (bucket.Values);
|
|
}
|
|
|
|
return string_values;
|
|
}
|
|
|
|
internal static HttpHeaderKind GetKnownHeaderKind (string name)
|
|
{
|
|
if (string.IsNullOrEmpty (name))
|
|
throw new ArgumentException ("name");
|
|
|
|
HeaderInfo headerInfo;
|
|
if (known_headers.TryGetValue (name, out headerInfo))
|
|
return headerInfo.HeaderKind;
|
|
|
|
return HttpHeaderKind.None;
|
|
}
|
|
|
|
internal T GetValue<T> (string name)
|
|
{
|
|
HeaderBucket value;
|
|
|
|
if (!headers.TryGetValue (name, out value))
|
|
return default (T);
|
|
|
|
if (value.HasStringValues) {
|
|
var hinfo = known_headers[name];
|
|
|
|
object pvalue;
|
|
if (!hinfo.TryParse (value.Values [0], out pvalue)) {
|
|
return typeof (T) == typeof (string) ? (T) (object) value.Values[0] : default (T);
|
|
}
|
|
|
|
value.Parsed = pvalue;
|
|
value.Values = null;
|
|
}
|
|
|
|
return (T) value.Parsed;
|
|
}
|
|
|
|
internal HttpHeaderValueCollection<T> GetValues<T> (string name) where T : class
|
|
{
|
|
HeaderBucket value;
|
|
|
|
if (!headers.TryGetValue (name, out value)) {
|
|
var hinfo = known_headers[name];
|
|
value = new HeaderBucket (new HttpHeaderValueCollection<T> (this, hinfo), hinfo.CustomToString);
|
|
headers.Add (name, value);
|
|
}
|
|
|
|
if (value.HasStringValues) {
|
|
var hinfo = known_headers[name];
|
|
if (value.Parsed == null)
|
|
value.Parsed = hinfo.CreateCollection (this);
|
|
|
|
object pvalue;
|
|
for (int i = 0; i < value.Values.Count; ++i) {
|
|
if (!hinfo.TryParse (value.Values[i], out pvalue))
|
|
continue;
|
|
|
|
hinfo.AddToCollection (value.Parsed, pvalue);
|
|
value.Values.RemoveAt (i);
|
|
--i;
|
|
}
|
|
}
|
|
|
|
return (HttpHeaderValueCollection<T>) value.Parsed;
|
|
}
|
|
|
|
internal void SetValue<T> (string name, T value, Func<object, string> toStringConverter = null)
|
|
{
|
|
headers[name] = new HeaderBucket (value, toStringConverter);
|
|
}
|
|
}
|
|
}
|