mcs/class/System.Net.Http/System.Net.Http.Headers/HttpHeaders.cs

   1 //
   2 // HttpHeaders.cs
   3 //
   4 // Authors:
   5 //      Marek Safar  <marek.safar@gmail.com>
   6 //
   7 // Copyright (C) 2011 Xamarin Inc (http://www.xamarin.com)
   8 //
   9 // Permission is hereby granted, free of charge, to any person obtaining
  10 // a copy of this software and associated documentation files (the
  11 // "Software"), to deal in the Software without restriction, including
  12 // without limitation the rights to use, copy, modify, merge, publish,
  13 // distribute, sublicense, and/or sell copies of the Software, and to
  14 // permit persons to whom the Software is furnished to do so, subject to
  15 // the following conditions:
  16 //
  17 // The above copyright notice and this permission notice shall be
  18 // included in all copies or substantial portions of the Software.
  19 //
  20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  24 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  25 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  26 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  27 //
  28
  29 using System.Collections;
  30 using System.Collections.Generic;
  31 using System.Linq;
  32 using System.Text;
  33
  34 namespace System.Net.Http.Headers
  35 {
  36         public abstract class HttpHeaders : IEnumerable<KeyValuePair<string, IEnumerable<string>>>
  37         {
  38                 class HeaderBucket
  39                 {
  40                         //
  41                         // headers can hold an object of 3 kinds
  42                         // - simple type for parsed single values (e.g. DateTime)
  43                         // - CollectionHeader for multi-value headers
  44                         // - List<string> for not checked single values
  45                         //
  46                         public object Parsed;
  47                         List<string> values;
  48
  49                         public readonly Func<object, string> CustomToString;
  50
  51                         public HeaderBucket (object parsed, Func<object, string> converter = null)
  52                         {
  53                                 this.Parsed = parsed;
  54                                 this.CustomToString = converter;
  55                         }
  56
  57                         public bool HasStringValues {
  58                                 get {
  59                                         return values != null && values.Count > 0;
  60                                 }
  61                         }
  62
  63                         public List<string> Values {
  64                                 get {
  65                                         return values ?? (values = new List<string> ());
  66                                 }
  67                                 set {
  68                                         values = value;
  69                                 }
  70                         }
  71
  72                         public string ParsedToString ()
  73                         {
  74                                 if (Parsed == null)
  75                                         return null;
  76
  77                                 if (CustomToString != null)
  78                                         return CustomToString (Parsed);
  79
  80                                 return Parsed.ToString ();
  81                         }
  82                 }
  83
  84                 static readonly Dictionary<string, HeaderInfo> known_headers;
  85
  86                 static HttpHeaders ()
  87                 {
  88                         var headers = new[] {
  89                                 HeaderInfo.CreateMulti<MediaTypeWithQualityHeaderValue> ("Accept", MediaTypeWithQualityHeaderValue.TryParse, HttpHeaderKind.Request),
  90                                 HeaderInfo.CreateMulti<StringWithQualityHeaderValue> ("Accept-Charset", StringWithQualityHeaderValue.TryParse, HttpHeaderKind.Request),
  91                                 HeaderInfo.CreateMulti<StringWithQualityHeaderValue> ("Accept-Encoding", StringWithQualityHeaderValue.TryParse, HttpHeaderKind.Request),
  92                                 HeaderInfo.CreateMulti<StringWithQualityHeaderValue> ("Accept-Language", StringWithQualityHeaderValue.TryParse, HttpHeaderKind.Request),
  93                                 HeaderInfo.CreateMulti<string> ("Accept-Ranges", CollectionParser.TryParse, HttpHeaderKind.Response),
  94                                 HeaderInfo.CreateSingle<TimeSpan> ("Age", Parser.TimeSpanSeconds.TryParse, HttpHeaderKind.Response),
  95                                 HeaderInfo.CreateMulti<string> ("Allow", CollectionParser.TryParse, HttpHeaderKind.Content, 0),
  96                                 HeaderInfo.CreateSingle<AuthenticationHeaderValue> ("Authorization", AuthenticationHeaderValue.TryParse, HttpHeaderKind.Request),
  97                                 HeaderInfo.CreateSingle<CacheControlHeaderValue> ("Cache-Control", CacheControlHeaderValue.TryParse, HttpHeaderKind.Request | HttpHeaderKind.Response),
  98                                 HeaderInfo.CreateMulti<string> ("Connection", CollectionParser.TryParse, HttpHeaderKind.Request | HttpHeaderKind.Response),
  99                                 HeaderInfo.CreateMulti<string> ("Content-Encoding", CollectionParser.TryParse, HttpHeaderKind.Content),
 100                                 HeaderInfo.CreateMulti<string> ("Content-Language", CollectionParser.TryParse, HttpHeaderKind.Content),
 101                                 HeaderInfo.CreateSingle<long> ("Content-Length", Parser.Long.TryParse, HttpHeaderKind.Content),
 102                                 HeaderInfo.CreateSingle<Uri> ("Content-Location", Parser.Uri.TryParse, HttpHeaderKind.Content),
 103                                 HeaderInfo.CreateSingle<byte[]> ("Content-MD5", Parser.MD5.TryParse, HttpHeaderKind.Content),
 104                                 HeaderInfo.CreateSingle<ContentRangeHeaderValue> ("Content-Range", ContentRangeHeaderValue.TryParse, HttpHeaderKind.Content),
 105                                 HeaderInfo.CreateSingle<MediaTypeHeaderValue> ("Content-Type", MediaTypeHeaderValue.TryParse, HttpHeaderKind.Content),
 106                                 HeaderInfo.CreateSingle<DateTimeOffset> ("Date", Parser.DateTime.TryParse, HttpHeaderKind.Request | HttpHeaderKind.Response),
 107                                 HeaderInfo.CreateSingle<EntityTagHeaderValue> ("ETag", EntityTagHeaderValue.TryParse, HttpHeaderKind.Response),
 108                                 HeaderInfo.CreateMulti<NameValueWithParametersHeaderValue> ("Expect", NameValueWithParametersHeaderValue.TryParse, HttpHeaderKind.Request),
 109                                 HeaderInfo.CreateSingle<DateTimeOffset> ("Expires", Parser.DateTime.TryParse, HttpHeaderKind.Content),
 110                                 HeaderInfo.CreateSingle<string> ("From", Parser.EmailAddress.TryParse, HttpHeaderKind.Request),
 111                                 HeaderInfo.CreateSingle<Uri> ("Host", Parser.Uri.TryParse, HttpHeaderKind.Request),
 112                                 HeaderInfo.CreateMulti<EntityTagHeaderValue> ("If-Match", EntityTagHeaderValue.TryParse, HttpHeaderKind.Request),
 113                                 HeaderInfo.CreateSingle<DateTimeOffset> ("If-Modified-Since", Parser.DateTime.TryParse, HttpHeaderKind.Request),
 114                                 HeaderInfo.CreateMulti<EntityTagHeaderValue> ("If-None-Match", EntityTagHeaderValue.TryParse, HttpHeaderKind.Request),
 115                                 HeaderInfo.CreateSingle<RangeConditionHeaderValue> ("If-Range", RangeConditionHeaderValue.TryParse, HttpHeaderKind.Request),
 116                                 HeaderInfo.CreateSingle<DateTimeOffset> ("If-Unmodified-Since", Parser.DateTime.TryParse, HttpHeaderKind.Request),
 117                                 HeaderInfo.CreateSingle<DateTimeOffset> ("Last-Modified", Parser.DateTime.TryParse, HttpHeaderKind.Content),
 118                                 HeaderInfo.CreateSingle<Uri> ("Location", Parser.Uri.TryParse, HttpHeaderKind.Response),
 119                                 HeaderInfo.CreateSingle<int> ("Max-Forwards", Parser.Int.TryParse, HttpHeaderKind.Request),
 120                                 HeaderInfo.CreateMulti<NameValueHeaderValue> ("Pragma", NameValueHeaderValue.TryParsePragma, HttpHeaderKind.Request | HttpHeaderKind.Response),
 121                                 HeaderInfo.CreateMulti<AuthenticationHeaderValue> ("Proxy-Authenticate", AuthenticationHeaderValue.TryParse, HttpHeaderKind.Response),
 122                                 HeaderInfo.CreateSingle<AuthenticationHeaderValue> ("Proxy-Authorization", AuthenticationHeaderValue.TryParse, HttpHeaderKind.Request),
 123                                 HeaderInfo.CreateSingle<RangeHeaderValue> ("Range", RangeHeaderValue.TryParse, HttpHeaderKind.Request),
 124                                 HeaderInfo.CreateSingle<Uri> ("Referer", Parser.Uri.TryParse, HttpHeaderKind.Request),
 125                                 HeaderInfo.CreateSingle<RetryConditionHeaderValue> ("Retry-After", RetryConditionHeaderValue.TryParse, HttpHeaderKind.Response),
 126                                 HeaderInfo.CreateMulti<ProductInfoHeaderValue> ("Server", ProductInfoHeaderValue.TryParse, HttpHeaderKind.Response),
 127                                 HeaderInfo.CreateMulti<TransferCodingWithQualityHeaderValue> ("TE", TransferCodingWithQualityHeaderValue.TryParse, HttpHeaderKind.Request, 0),
 128                                 HeaderInfo.CreateMulti<string> ("Trailer", CollectionParser.TryParse, HttpHeaderKind.Request | HttpHeaderKind.Response),
 129                                 HeaderInfo.CreateMulti<TransferCodingHeaderValue> ("Transfer-Encoding", TransferCodingHeaderValue.TryParse, HttpHeaderKind.Request | HttpHeaderKind.Response),
 130                                 HeaderInfo.CreateMulti<ProductHeaderValue> ("Upgrade", ProductHeaderValue.TryParse, HttpHeaderKind.Request | HttpHeaderKind.Response),
 131                                 HeaderInfo.CreateMulti<ProductInfoHeaderValue> ("User-Agent", ProductInfoHeaderValue.TryParse, HttpHeaderKind.Request),
 132                                 HeaderInfo.CreateMulti<string> ("Vary", CollectionParser.TryParse, HttpHeaderKind.Response),
 133                                 HeaderInfo.CreateMulti<ViaHeaderValue> ("Via", ViaHeaderValue.TryParse, HttpHeaderKind.Request | HttpHeaderKind.Response),
 134                                 HeaderInfo.CreateMulti<WarningHeaderValue> ("Warning", WarningHeaderValue.TryParse, HttpHeaderKind.Request | HttpHeaderKind.Response),
 135                                 HeaderInfo.CreateMulti<AuthenticationHeaderValue> ("WWW-Authenticate", AuthenticationHeaderValue.TryParse, HttpHeaderKind.Response)
 136                         };
 137
 138                         known_headers = new Dictionary<string, HeaderInfo> (StringComparer.OrdinalIgnoreCase);
 139                         foreach (var header in headers) {
 140                                 known_headers.Add (header.Name, header);
 141                         }
 142                 }
 143
 144                 readonly Dictionary<string, HeaderBucket> headers;
 145                 readonly HttpHeaderKind HeaderKind;
 146
 147                 internal bool? connectionclose, transferEncodingChunked;
 148
 149                 protected HttpHeaders ()
 150                 {
 151                         headers = new Dictionary<string, HeaderBucket> (StringComparer.OrdinalIgnoreCase);
 152                 }
 153
 154                 internal HttpHeaders (HttpHeaderKind headerKind)
 155                         : this ()
 156                 {
 157                         this.HeaderKind = headerKind;
 158                 }
 159
 160                 public void Add (string name, string value)
 161                 {
 162                         Add (name, new[] { value });
 163                 }
 164
 165                 public void Add (string name, IEnumerable<string> values)
 166                 {
 167                         if (values == null)
 168                                 throw new ArgumentNullException ("values");
 169
 170                         AddInternal (name, values, CheckName (name), false);
 171                 }
 172
 173                 internal bool AddValue (string value, HeaderInfo headerInfo, bool ignoreInvalid)
 174                 {
 175                         return AddInternal (headerInfo.Name, new [] { value }, headerInfo, ignoreInvalid);
 176                 }
 177
 178                 bool AddInternal (string name, IEnumerable<string> values, HeaderInfo headerInfo, bool ignoreInvalid)
 179                 {
 180                         HeaderBucket bucket;
 181                         headers.TryGetValue (name, out bucket);
 182                         bool ok = true;
 183
 184                         foreach (var value in values) {
 185                                 bool first_entry = bucket == null;
 186
 187                                 if (headerInfo != null) {
 188                                         object parsed_value;
 189                                         if (!headerInfo.TryParse (value, out parsed_value)) {
 190                                                 if (ignoreInvalid) {
 191                                                         ok = false;
 192                                                         continue;
 193                                                 }
 194
 195                                                 throw new FormatException ();
 196                                         }
 197
 198                                         if (headerInfo.AllowsMany) {
 199                                                 if (bucket == null)
 200                                                         bucket = new HeaderBucket (headerInfo.CreateCollection (this));
 201
 202                                                 headerInfo.AddToCollection (bucket.Parsed, parsed_value);
 203                                         } else {
 204                                                 if (bucket != null)
 205                                                         throw new FormatException ();
 206
 207                                                 bucket = new HeaderBucket (parsed_value);
 208                                         }
 209                                 } else {
 210                                         if (bucket == null)
 211                                                 bucket = new HeaderBucket (null);
 212
 213                                         bucket.Values.Add (value ?? string.Empty);
 214                                 }
 215
 216                                 if (first_entry) {
 217                                         headers.Add (name, bucket);
 218                                 }
 219                         }
 220
 221                         return ok;
 222                 }
 223
 224                 public bool TryAddWithoutValidation (string name, string value)
 225                 {
 226                         return TryAddWithoutValidation (name, new[] { value });
 227                 }
 228
 229                 public bool TryAddWithoutValidation (string name, IEnumerable<string> values)
 230                 {
 231                         if (values == null)
 232                                 throw new ArgumentNullException ("values");
 233
 234                         HeaderInfo headerInfo;
 235                         if (!TryCheckName (name, out headerInfo))
 236                                 return false;
 237
 238                         AddInternal (name, values, null, true);
 239                         return true;
 240                 }
 241
 242                 HeaderInfo CheckName (string name)
 243                 {
 244                         if (string.IsNullOrEmpty (name))
 245                                 throw new ArgumentException ("name");
 246
 247                         Parser.Token.Check (name);
 248
 249                         HeaderInfo headerInfo;
 250                         if (known_headers.TryGetValue (name, out headerInfo) && (headerInfo.HeaderKind & HeaderKind) == 0) {
 251                                 if (HeaderKind != HttpHeaderKind.None && ((HeaderKind | headerInfo.HeaderKind) & HttpHeaderKind.Content) != 0)
 252                                         throw new InvalidOperationException (name);
 253
 254                                 return null;
 255                         }
 256
 257                         return headerInfo;
 258                 }
 259
 260                 bool TryCheckName (string name, out HeaderInfo headerInfo)
 261                 {
 262                         if (!Parser.Token.TryCheck (name)) {
 263                                 headerInfo = null;
 264                                 return false;
 265                         }
 266
 267                         if (known_headers.TryGetValue (name, out headerInfo) && (headerInfo.HeaderKind & HeaderKind) == 0) {
 268                                 if (HeaderKind != HttpHeaderKind.None && ((HeaderKind | headerInfo.HeaderKind) & HttpHeaderKind.Content) != 0)
 269                                         return false;
 270                         }
 271
 272                         return true;
 273                 }
 274
 275                 public void Clear ()
 276                 {
 277                         connectionclose = null;
 278                         transferEncodingChunked = null;
 279                         headers.Clear ();
 280                 }
 281
 282                 public bool Contains (string name)
 283                 {
 284                         CheckName (name);
 285
 286                         return headers.ContainsKey (name);
 287                 }
 288
 289                 public IEnumerator<KeyValuePair<string, IEnumerable<string>>> GetEnumerator ()
 290                 {
 291                         foreach (var entry in headers) {
 292                                 var bucket = headers[entry.Key];
 293
 294                                 HeaderInfo headerInfo;
 295                                 known_headers.TryGetValue (entry.Key, out headerInfo);
 296
 297                                 var svalues = GetAllHeaderValues (bucket, headerInfo);
 298                                 if (svalues == null)
 299                                         continue;
 300
 301                                 yield return new KeyValuePair<string, IEnumerable<string>> (entry.Key, svalues);
 302                         }
 303                 }
 304
 305                 IEnumerator IEnumerable.GetEnumerator ()
 306                 {
 307                         return GetEnumerator ();
 308                 }
 309
 310                 public IEnumerable<string> GetValues (string name)
 311                 {
 312                         CheckName (name);
 313
 314                         IEnumerable<string> values;
 315                         if (!TryGetValues (name, out values))
 316                                 throw new InvalidOperationException ();
 317
 318                         return values;
 319                 }
 320
 321                 public bool Remove (string name)
 322                 {
 323                         CheckName (name);
 324                         return headers.Remove (name);
 325                 }
 326
 327                 public bool TryGetValues (string name, out IEnumerable<string> values)
 328                 {
 329                         HeaderInfo headerInfo;
 330                         if (!TryCheckName (name, out headerInfo)) {
 331                                 values = null;
 332                                 return false;
 333                         }
 334
 335                         HeaderBucket bucket;
 336                         if (!headers.TryGetValue (name, out bucket)) {
 337                                 values = null;
 338                                 return false;
 339                         }
 340
 341                         values = GetAllHeaderValues (bucket, headerInfo);
 342                         return true;
 343                 }
 344
 345                 public override string ToString ()
 346                 {
 347                         var sb = new StringBuilder ();
 348                         foreach (var entry in this) {
 349                                 sb.Append (entry.Key);
 350                                 sb.Append (": ");
 351
 352                                 bool first = true;
 353                                 foreach (var v in entry.Value) {
 354                                         if (!first)
 355                                                 sb.Append (", ");
 356
 357                                         sb.Append (v);
 358                                         first = false;
 359                                 }
 360
 361                                 sb.Append ("\r\n");
 362                         }
 363
 364                         return sb.ToString ();
 365                 }
 366
 367                 internal void AddOrRemove (string name, string value)
 368                 {
 369                         if (string.IsNullOrEmpty (value))
 370                                 Remove (name);
 371                         else
 372                                 SetValue (name, value);
 373                 }
 374
 375                 internal void AddOrRemove<T> (string name, T value) where T : class
 376                 {
 377                         if (value == null)
 378                                 Remove (name);
 379                         else
 380                                 SetValue (name, value);
 381                 }
 382
 383                 internal void AddOrRemove<T> (string name, T? value) where T : struct
 384                 {
 385                         AddOrRemove<T> (name, value, null);
 386                 }
 387
 388                 internal void AddOrRemove<T> (string name, T? value, Func<object, string> converter) where T : struct
 389                 {
 390                         if (!value.HasValue)
 391                                 Remove (name);
 392                         else
 393                                 SetValue (name, value, converter);
 394                 }
 395
 396                 List<string> GetAllHeaderValues (HeaderBucket bucket, HeaderInfo headerInfo)
 397                 {
 398                         List<string> string_values = null;
 399                         if (headerInfo != null && headerInfo.AllowsMany) {
 400                                 string_values = headerInfo.ToStringCollection (bucket.Parsed);
 401                         } else {
 402                                 if (bucket.Parsed != null) {
 403                                         string s = bucket.ParsedToString ();
 404                                         if (!string.IsNullOrEmpty (s)) {
 405                                                 string_values = new List<string> ();
 406                                                 string_values.Add (s);
 407                                         }
 408                                 }
 409                         }
 410
 411                         if (bucket.HasStringValues) {
 412                                 if (string_values == null)
 413                                         string_values = new List<string> ();
 414
 415                                 string_values.AddRange (bucket.Values);
 416                         }
 417
 418                         return string_values;
 419                 }
 420
 421                 internal static HttpHeaderKind GetKnownHeaderKind (string name)
 422                 {
 423                         if (string.IsNullOrEmpty (name))
 424                                 throw new ArgumentException ("name");
 425
 426                         HeaderInfo headerInfo;
 427                         if (known_headers.TryGetValue (name, out headerInfo))
 428                                 return headerInfo.HeaderKind;
 429
 430                         return HttpHeaderKind.None;
 431                 }
 432
 433                 internal T GetValue<T> (string name)
 434                 {
 435                         HeaderBucket value;
 436
 437                         if (!headers.TryGetValue (name, out value))
 438                                 return default (T);
 439
 440                         if (value.HasStringValues) {
 441                                 var hinfo = known_headers[name];
 442
 443                                 object pvalue;
 444                                 if (!hinfo.TryParse (value.Values [0], out pvalue)) {
 445                                         return typeof (T) == typeof (string) ? (T) (object) value.Values[0] : default (T);
 446                                 }
 447
 448                                 value.Parsed = pvalue;
 449                                 value.Values = null;
 450                         }
 451
 452                         return (T) value.Parsed;
 453                 }
 454
 455                 internal HttpHeaderValueCollection<T> GetValues<T> (string name) where T : class
 456                 {
 457                         HeaderBucket value;
 458
 459                         if (!headers.TryGetValue (name, out value)) {
 460                                 value = new HeaderBucket (new HttpHeaderValueCollection<T> (this, known_headers [name]));
 461                                 headers.Add (name, value);
 462                         }
 463
 464                         if (value.HasStringValues) {
 465                                 var hinfo = known_headers[name];
 466                                 if (value.Parsed == null)
 467                                         value.Parsed = hinfo.CreateCollection (this);
 468
 469                                 object pvalue;
 470                                 for (int i = 0; i < value.Values.Count; ++i) {
 471                                         if (!hinfo.TryParse (value.Values[i], out pvalue))
 472                                                 continue;
 473
 474                                         hinfo.AddToCollection (value.Parsed, pvalue);
 475                                         value.Values.RemoveAt (i);
 476                                         --i;
 477                                 }
 478                         }
 479
 480                         return (HttpHeaderValueCollection<T>) value.Parsed;
 481                 }
 482
 483                 void SetValue<T> (string name, T value, Func<object, string> toStringConverter = null)
 484                 {
 485                         headers[name] = new HeaderBucket (value, toStringConverter);
 486                 }
 487         }
 488 }