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", Parser.Token.TryParse, HttpHeaderKind.Response),
  94                                 HeaderInfo.CreateSingle<TimeSpan> ("Age", Parser.TimeSpanSeconds.TryParse, HttpHeaderKind.Response),
  95                                 HeaderInfo.CreateMulti<string> ("Allow", Parser.Token.TryParse, HttpHeaderKind.Content),
  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", Parser.Token.TryParse, HttpHeaderKind.Request | HttpHeaderKind.Response),
  99                                 HeaderInfo.CreateMulti<string> ("Content-Encoding", Parser.Token.TryParse, HttpHeaderKind.Content),
 100                                 HeaderInfo.CreateMulti<string> ("Content-Language", Parser.Token.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.CreateMultiList<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),
 128                                 HeaderInfo.CreateMulti<string> ("Trailer", Parser.Token.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.CreateMultiList<ProductInfoHeaderValue> ("User-Agent", ProductInfoHeaderValue.TryParse, HttpHeaderKind.Request),
 132                                 HeaderInfo.CreateMulti<string> ("Vary", Parser.Token.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                         if (string.IsNullOrEmpty (name))
 235                                 return false;
 236
 237                         Parser.Token.Check (name);
 238
 239                         HeaderInfo headerInfo;
 240                         if (known_headers.TryGetValue (name, out headerInfo) && (headerInfo.HeaderKind & HeaderKind) == 0) {
 241                                 if (HeaderKind != HttpHeaderKind.None && ((HeaderKind | headerInfo.HeaderKind) & HttpHeaderKind.Content) != 0)
 242                                         return false;
 243                         }
 244
 245                         AddInternal (name, values, null, true);
 246                         return true;
 247                 }
 248
 249                 HeaderInfo CheckName (string name)
 250                 {
 251                         if (string.IsNullOrEmpty (name))
 252                                 throw new ArgumentException ("name");
 253
 254                         Parser.Token.Check (name);
 255
 256                         HeaderInfo headerInfo;
 257                         if (known_headers.TryGetValue (name, out headerInfo) && (headerInfo.HeaderKind & HeaderKind) == 0) {
 258                                 if (HeaderKind != HttpHeaderKind.None && ((HeaderKind | headerInfo.HeaderKind) & HttpHeaderKind.Content) != 0)
 259                                         throw new InvalidOperationException (name);
 260
 261                                 return null;
 262                         }
 263
 264                         return headerInfo;
 265                 }
 266
 267                 public void Clear ()
 268                 {
 269                         connectionclose = null;
 270                         transferEncodingChunked = null;
 271                         headers.Clear ();
 272                 }
 273
 274                 public bool Contains (string name)
 275                 {
 276                         CheckName (name);
 277
 278                         return headers.ContainsKey (name);
 279                 }
 280
 281                 public IEnumerator<KeyValuePair<string, IEnumerable<string>>> GetEnumerator ()
 282                 {
 283                         foreach (var entry in headers) {
 284                                 var bucket = headers[entry.Key];
 285
 286                                 HeaderInfo headerInfo;
 287                                 known_headers.TryGetValue (entry.Key, out headerInfo);
 288
 289                                 var svalues = GetAllHeaderValues (bucket, headerInfo);
 290                                 if (svalues == null)
 291                                         continue;
 292
 293                                 yield return new KeyValuePair<string, IEnumerable<string>> (entry.Key, svalues);
 294                         }
 295                 }
 296
 297                 IEnumerator IEnumerable.GetEnumerator ()
 298                 {
 299                         return GetEnumerator ();
 300                 }
 301
 302                 public IEnumerable<string> GetValues (string name)
 303                 {
 304                         IEnumerable<string> values;
 305                         if (!TryGetValues (name, out values))
 306                                 throw new InvalidOperationException ();
 307
 308                         return values;
 309                 }
 310
 311                 public bool Remove (string name)
 312                 {
 313                         CheckName (name);
 314                         return headers.Remove (name);
 315                 }
 316
 317                 public bool TryGetValues (string name, out IEnumerable<string> values)
 318                 {
 319                         var header_info = CheckName (name);
 320
 321                         HeaderBucket bucket;
 322                         if (!headers.TryGetValue (name, out bucket)) {
 323                                 values = null;
 324                                 return false;
 325                         }
 326
 327                         values = GetAllHeaderValues (bucket, header_info);
 328                         return true;
 329                 }
 330
 331                 public override string ToString ()
 332                 {
 333                         var sb = new StringBuilder ();
 334                         foreach (var entry in this) {
 335                                 sb.Append (entry.Key);
 336                                 sb.Append (": ");
 337
 338                                 bool first = true;
 339                                 foreach (var v in entry.Value) {
 340                                         if (!first)
 341                                                 sb.Append (", ");
 342
 343                                         sb.Append (v);
 344                                         first = false;
 345                                 }
 346
 347                                 sb.Append ("\r\n");
 348                         }
 349
 350                         return sb.ToString ();
 351                 }
 352
 353                 internal void AddOrRemove (string name, string value)
 354                 {
 355                         if (string.IsNullOrEmpty (value))
 356                                 Remove (name);
 357                         else
 358                                 SetValue (name, value);
 359                 }
 360
 361                 internal void AddOrRemove<T> (string name, T value) where T : class
 362                 {
 363                         if (value == null)
 364                                 Remove (name);
 365                         else
 366                                 SetValue (name, value);
 367                 }
 368
 369                 internal void AddOrRemove<T> (string name, T? value) where T : struct
 370                 {
 371                         AddOrRemove<T> (name, value, null);
 372                 }
 373
 374                 internal void AddOrRemove<T> (string name, T? value, Func<object, string> converter) where T : struct
 375                 {
 376                         if (!value.HasValue)
 377                                 Remove (name);
 378                         else
 379                                 SetValue (name, value, converter);
 380                 }
 381
 382                 List<string> GetAllHeaderValues (HeaderBucket bucket, HeaderInfo headerInfo)
 383                 {
 384                         List<string> string_values = null;
 385                         if (headerInfo != null && headerInfo.AllowsMany) {
 386                                 string_values = headerInfo.ToStringCollection (bucket.Parsed);
 387                         } else {
 388                                 if (bucket.Parsed != null) {
 389                                         string s = bucket.ParsedToString ();
 390                                         if (!string.IsNullOrEmpty (s)) {
 391                                                 string_values = new List<string> ();
 392                                                 string_values.Add (s);
 393                                         }
 394                                 }
 395                         }
 396
 397                         if (bucket.HasStringValues) {
 398                                 if (string_values == null)
 399                                         string_values = new List<string> ();
 400
 401                                 string_values.AddRange (bucket.Values);
 402                         }
 403
 404                         return string_values;
 405                 }
 406
 407                 internal static HttpHeaderKind GetKnownHeaderKind (string name)
 408                 {
 409                         if (string.IsNullOrEmpty (name))
 410                                 throw new ArgumentException ("name");
 411
 412                         HeaderInfo headerInfo;
 413                         if (known_headers.TryGetValue (name, out headerInfo))
 414                                 return headerInfo.HeaderKind;
 415
 416                         return HttpHeaderKind.None;
 417                 }
 418
 419                 internal T GetValue<T> (string name)
 420                 {
 421                         HeaderBucket value;
 422
 423                         if (!headers.TryGetValue (name, out value))
 424                                 return default (T);
 425
 426                         if (value.HasStringValues) {
 427                                 var hinfo = known_headers[name];
 428
 429                                 object pvalue;
 430                                 if (!hinfo.TryParse (value.Values [0], out pvalue)) {
 431                                         return typeof (T) == typeof (string) ? (T) (object) value.Values[0] : default (T);
 432                                 }
 433
 434                                 value.Parsed = pvalue;
 435                                 value.Values = null;
 436                         }
 437
 438                         return (T) value.Parsed;
 439                 }
 440
 441                 internal HttpHeaderValueCollection<T> GetValues<T> (string name) where T : class
 442                 {
 443                         HeaderBucket value;
 444
 445                         if (!headers.TryGetValue (name, out value)) {
 446                                 value = new HeaderBucket (new HttpHeaderValueCollection<T> (this, known_headers [name]));
 447                                 headers.Add (name, value);
 448                         }
 449
 450                         if (value.HasStringValues) {
 451                                 var hinfo = known_headers[name];
 452                                 if (value.Parsed == null)
 453                                         value.Parsed = hinfo.CreateCollection (this);
 454
 455                                 object pvalue;
 456                                 for (int i = 0; i < value.Values.Count; ++i) {
 457                                         if (!hinfo.TryParse (value.Values[i], out pvalue))
 458                                                 continue;
 459
 460                                         hinfo.AddToCollection (value.Parsed, pvalue);
 461                                         value.Values.RemoveAt (i);
 462                                         --i;
 463                                 }
 464                         }
 465
 466                         return (HttpHeaderValueCollection<T>) value.Parsed;
 467                 }
 468
 469                 void SetValue<T> (string name, T value, Func<object, string> toStringConverter = null)
 470                 {
 471                         headers[name] = new HeaderBucket (value, toStringConverter);
 472                 }
 473         }
 474 }