mcs/class/System.Net.Http/System.Net.Http/HttpContent.cs

   1 //
   2 // HttpContent.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.Net.Http.Headers;
  30 using System.IO;
  31 using System.Threading.Tasks;
  32 using System.Text;
  33
  34 namespace System.Net.Http
  35 {
  36         public abstract class HttpContent : IDisposable
  37         {
  38                 sealed class FixedMemoryStream : MemoryStream
  39                 {
  40                         readonly long maxSize;
  41
  42                         public FixedMemoryStream (long maxSize)
  43                                 : base ()
  44                         {
  45                                 this.maxSize = maxSize;
  46                         }
  47
  48                         void CheckOverflow (int count)
  49                         {
  50                                 if (Length + count > maxSize)
  51                                         throw new HttpRequestException (string.Format ("Cannot write more bytes to the buffer than the configured maximum buffer size: {0}", maxSize));
  52                         }
  53
  54                         public override void WriteByte (byte value)
  55                         {
  56                                 CheckOverflow (1);
  57                                 base.WriteByte (value);
  58                         }
  59
  60                         public override void Write (byte[] buffer, int offset, int count)
  61                         {
  62                                 CheckOverflow (count);
  63                                 base.Write (buffer, offset, count);
  64                         }
  65                 }
  66
  67                 FixedMemoryStream buffer;
  68                 Stream stream;
  69                 bool disposed;
  70                 HttpContentHeaders headers;
  71
  72                 public HttpContentHeaders Headers {
  73                         get {
  74                                 return headers ?? (headers = new HttpContentHeaders (this));
  75                         }
  76                 }
  77
  78                 internal long? LoadedBufferLength {
  79                         get {
  80                                 return buffer == null ? (long?)null : buffer.Length;
  81                         }
  82                 }
  83
  84                 // Only used by HttpWebRequest internals which is not async friendly
  85                 internal void CopyTo (Stream stream)
  86                 {
  87                         CopyToAsync (stream).Wait ();
  88                 }
  89
  90                 public Task CopyToAsync (Stream stream)
  91                 {
  92                         return CopyToAsync (stream, null);
  93                 }
  94
  95                 public Task CopyToAsync (Stream stream, TransportContext context)
  96                 {
  97                         if (stream == null)
  98                                 throw new ArgumentNullException ("stream");
  99
 100                         if (buffer != null)
 101                                 return buffer.CopyToAsync (stream);
 102
 103                         return SerializeToStreamAsync (stream, context);
 104                 }
 105
 106                 protected async virtual Task<Stream> CreateContentReadStreamAsync ()
 107                 {
 108                         await LoadIntoBufferAsync ().ConfigureAwait (false);
 109                         return buffer;
 110                 }
 111
 112                 static FixedMemoryStream CreateFixedMemoryStream (long maxBufferSize)
 113                 {
 114                         return new FixedMemoryStream (maxBufferSize);
 115                 }
 116
 117                 public void Dispose ()
 118                 {
 119                         Dispose (true);
 120                 }
 121
 122                 protected virtual void Dispose (bool disposing)
 123                 {
 124                         if (disposing && !disposed) {
 125                                 disposed = true;
 126
 127                                 if (buffer != null)
 128                                         buffer.Dispose ();
 129                         }
 130                 }
 131
 132                 public Task LoadIntoBufferAsync ()
 133                 {
 134                         return LoadIntoBufferAsync (int.MaxValue);
 135                 }
 136
 137                 public async Task LoadIntoBufferAsync (long maxBufferSize)
 138                 {
 139                         if (disposed)
 140                                 throw new ObjectDisposedException (GetType ().ToString ());
 141
 142                         if (buffer != null)
 143                                 return;
 144
 145                         buffer = CreateFixedMemoryStream (maxBufferSize);
 146                         await SerializeToStreamAsync (buffer, null).ConfigureAwait (false);
 147                         buffer.Seek (0, SeekOrigin.Begin);
 148                 }
 149
 150                 public async Task<Stream> ReadAsStreamAsync ()
 151                 {
 152                         if (disposed)
 153                                 throw new ObjectDisposedException (GetType ().ToString ());
 154
 155                         if (buffer != null)
 156                                 return new MemoryStream (buffer.GetBuffer (), 0, (int)buffer.Length, false);
 157
 158                         if (stream == null)
 159                                 stream = await CreateContentReadStreamAsync ().ConfigureAwait (false);
 160
 161                         return stream;
 162                 }
 163
 164                 public async Task<byte[]> ReadAsByteArrayAsync ()
 165                 {
 166                         await LoadIntoBufferAsync ().ConfigureAwait (false);
 167                         return buffer.ToArray ();
 168                 }
 169
 170                 public async Task<string> ReadAsStringAsync ()
 171                 {
 172                         await LoadIntoBufferAsync ().ConfigureAwait (false);
 173                         if (buffer.Length == 0)
 174                                 return string.Empty;
 175
 176                         var buf = buffer.GetBuffer ();
 177                         var buf_length = (int) buffer.Length;
 178                         int preambleLength = 0;
 179                         Encoding encoding;
 180
 181                         if (headers != null && headers.ContentType != null && headers.ContentType.CharSet != null) {
 182                                 encoding = Encoding.GetEncoding (headers.ContentType.CharSet);
 183                                 preambleLength = StartsWith (buf, buf_length, encoding.GetPreamble ());
 184                         } else {
 185                                 encoding = GetEncodingFromBuffer (buf, buf_length, ref preambleLength) ?? Encoding.UTF8;
 186                         }
 187
 188                         return encoding.GetString (buf, preambleLength, buf_length - preambleLength);
 189                 }
 190
 191                 static Encoding GetEncodingFromBuffer (byte[] buffer, int length, ref int preambleLength)
 192                 {
 193                         var encodings_with_preamble = new [] { Encoding.UTF8, Encoding.UTF32, Encoding.Unicode };
 194                         foreach (var enc in encodings_with_preamble) {
 195                                 if ((preambleLength = StartsWith (buffer, length, enc.GetPreamble ())) != 0)
 196                                         return enc;
 197                         }
 198
 199                         return null;
 200                 }
 201
 202                 static int StartsWith (byte[] array, int length, byte[] value)
 203                 {
 204                         if (length < value.Length)
 205                                 return 0;
 206
 207                         for (int i = 0; i < value.Length; ++i) {
 208                                 if (array [i] != value [i])
 209                                         return 0;
 210                         }
 211
 212                         return value.Length;
 213                 }
 214
 215                 protected internal abstract Task SerializeToStreamAsync (Stream stream, TransportContext context);
 216                 protected internal abstract bool TryComputeLength (out long length);
 217         }
 218 }