123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161 |
- using System;
- using System.Collections.Generic;
- using System.IO;
- using System.Text;
- #if !NETFX_CORE || UNITY_EDITOR
- using System.Net.Sockets;
- #endif
- using UnityEngine;
- namespace BestHTTP
- {
- #if !BESTHTTP_DISABLE_CACHING && (!UNITY_WEBGL || UNITY_EDITOR)
- using BestHTTP.Caching;
- #endif
- using BestHTTP.Extensions;
- #if !BESTHTTP_DISABLE_COOKIES && (!UNITY_WEBGL || UNITY_EDITOR)
- using BestHTTP.Cookies;
- #endif
- public interface IProtocol
- {
- bool IsClosed { get; }
- void HandleEvents();
- }
- /// <summary>
- ///
- /// </summary>
- public class HTTPResponse : IDisposable
- {
- internal const byte CR = 13;
- internal const byte LF = 10;
- public const int MinBufferSize = 4 * 1024;
- #region Public Properties
- public int VersionMajor { get; protected set; }
- public int VersionMinor { get; protected set; }
- /// <summary>
- /// The status code that sent from the server.
- /// </summary>
- public int StatusCode { get; protected set; }
- /// <summary>
- /// Returns true if the status code is in the range of [200..300[ or 304 (Not Modified)
- /// </summary>
- public bool IsSuccess { get { return (this.StatusCode >= 200 && this.StatusCode < 300) || this.StatusCode == 304; } }
- /// <summary>
- /// The message that sent along with the StatusCode from the server. You can check it for errors from the server.
- /// </summary>
- public string Message { get; protected set; }
- /// <summary>
- /// True if it's a streamed response.
- /// </summary>
- public bool IsStreamed { get; protected set; }
- /// <summary>
- /// True if the streaming is finished, and no more fragments are coming.
- /// </summary>
- public bool IsStreamingFinished { get; internal set; }
- #if !BESTHTTP_DISABLE_CACHING && (!UNITY_WEBGL || UNITY_EDITOR)
- /// <summary>
- /// Indicates that the response body is read from the cache.
- /// </summary>
- public bool IsFromCache { get; internal set; }
- /// <summary>
- /// Provides information about the file used for caching the request.
- /// </summary>
- public HTTPCacheFileInfo CacheFileInfo { get; internal set; }
- /// <summary>
- /// Determines if this response is only stored to cache.
- /// If both IsCacheOnly and IsStreamed are true, GetStreamedFragments should not be called.
- /// </summary>
- public bool IsCacheOnly { get; private set; }
- #endif
- /// <summary>
- /// The headers that sent from the server.
- /// </summary>
- public Dictionary<string, List<string>> Headers { get; protected set; }
- /// <summary>
- /// The data that downloaded from the server. All Transfer and Content encodings decoded if any(eg. chunked, gzip, deflate).
- /// </summary>
- public byte[] Data { get; internal set; }
- /// <summary>
- /// The normal HTTP protocol is upgraded to an other.
- /// </summary>
- public bool IsUpgraded { get; protected set; }
- #if !BESTHTTP_DISABLE_COOKIES && (!UNITY_WEBGL || UNITY_EDITOR)
- /// <summary>
- /// The cookies that the server sent to the client.
- /// </summary>
- public List<Cookie> Cookies { get; internal set; }
- #endif
- /// <summary>
- /// Cached, converted data.
- /// </summary>
- protected string dataAsText;
- /// <summary>
- /// The data converted to an UTF8 string.
- /// </summary>
- public string DataAsText
- {
- get
- {
- if (Data == null)
- return string.Empty;
- if (!string.IsNullOrEmpty(dataAsText))
- return dataAsText;
- return dataAsText = Encoding.UTF8.GetString(Data, 0, Data.Length);
- }
- }
- /// <summary>
- /// Cached converted data.
- /// </summary>
- protected Texture2D texture;
- /// <summary>
- /// The data loaded to a Texture2D.
- /// </summary>
- public Texture2D DataAsTexture2D
- {
- get
- {
- if (Data == null)
- return null;
- if (texture != null)
- return texture;
- texture = new Texture2D(0, 0, TextureFormat.ARGB32, false);
- texture.LoadImage(Data);
- return texture;
- }
- }
- /// <summary>
- /// True if the connection's stream will be closed manually. Used in custom protocols (WebSocket, EventSource).
- /// </summary>
- public bool IsClosedManually { get; protected set; }
- #endregion
- #region Internal Fields
- internal HTTPRequest baseRequest;
- #endregion
- #region Protected Properties And Fields
- protected Stream Stream;
- protected List<byte[]> streamedFragments;
- protected object SyncRoot = new object();
- protected byte[] fragmentBuffer;
- protected int fragmentBufferDataLength;
- #if !BESTHTTP_DISABLE_CACHING && (!UNITY_WEBGL || UNITY_EDITOR)
- protected Stream cacheStream;
- #endif
- protected int allFragmentSize;
- #endregion
- public HTTPResponse(HTTPRequest request, Stream stream, bool isStreamed, bool isFromCache)
- {
- this.baseRequest = request;
- this.Stream = stream;
- this.IsStreamed = isStreamed;
- #if !BESTHTTP_DISABLE_CACHING && (!UNITY_WEBGL || UNITY_EDITOR)
- this.IsFromCache = isFromCache;
- this.IsCacheOnly = request.CacheOnly;
- #endif
- this.IsClosedManually = false;
- }
- public virtual bool Receive(int forceReadRawContentLength = -1, bool readPayloadData = true)
- {
- string statusLine = string.Empty;
- if (HTTPManager.Logger.Level == Logger.Loglevels.All)
- VerboseLogging(string.Format("Receive. forceReadRawContentLength: '{0:N0}', readPayloadData: '{1:N0}'", forceReadRawContentLength, readPayloadData));
- // On WP platform we aren't able to determined sure enough whether the tcp connection is closed or not.
- // So if we get an exception here, we need to recreate the connection.
- try
- {
- // Read out 'HTTP/1.1' from the "HTTP/1.1 {StatusCode} {Message}"
- statusLine = ReadTo(Stream, (byte)' ');
- }
- catch
- {
- if (!baseRequest.DisableRetry)
- {
- HTTPManager.Logger.Warning("HTTPResponse", string.Format("{0} - Failed to read Status Line! Retry is enabled, returning with false.", this.baseRequest.CurrentUri.ToString()));
- return false;
- }
- HTTPManager.Logger.Warning("HTTPResponse", string.Format("{0} - Failed to read Status Line! Retry is disabled, re-throwing exception.", this.baseRequest.CurrentUri.ToString()));
- throw;
- }
- if (HTTPManager.Logger.Level == Logger.Loglevels.All)
- VerboseLogging(string.Format("Status Line: '{0}'", statusLine));
- if (string.IsNullOrEmpty(statusLine))
- {
- if (!baseRequest.DisableRetry)
- return false;
- throw new Exception("Remote server closed the connection before sending response header!");
- }
- string[] versions = statusLine.Split(new char[] { '/', '.' });
- this.VersionMajor = int.Parse(versions[1]);
- this.VersionMinor = int.Parse(versions[2]);
- if (HTTPManager.Logger.Level == Logger.Loglevels.All)
- VerboseLogging(string.Format("HTTP Version: '{0}.{1}'", this.VersionMajor.ToString(), this.VersionMinor.ToString()));
- int statusCode;
- string statusCodeStr = NoTrimReadTo(Stream, (byte)' ', LF);
- if (HTTPManager.Logger.Level == Logger.Loglevels.All)
- VerboseLogging(string.Format("Status Code: '{0}'", statusCodeStr));
- if (baseRequest.DisableRetry)
- statusCode = int.Parse(statusCodeStr);
- else if (!int.TryParse(statusCodeStr, out statusCode))
- return false;
- this.StatusCode = statusCode;
- if (statusCodeStr.Length > 0 && (byte)statusCodeStr[statusCodeStr.Length - 1] != LF && (byte)statusCodeStr[statusCodeStr.Length - 1] != CR)
- {
- this.Message = ReadTo(Stream, LF);
- if (HTTPManager.Logger.Level == Logger.Loglevels.All)
- VerboseLogging(string.Format("Status Message: '{0}'", this.Message));
- }
- else
- {
- HTTPManager.Logger.Warning("HTTPResponse", string.Format("{0} - Skipping Status Message reading!", this.baseRequest.CurrentUri.ToString()));
- this.Message = string.Empty;
- }
- //Read Headers
- ReadHeaders(Stream);
- IsUpgraded = StatusCode == 101 && (HasHeaderWithValue("connection", "upgrade") || HasHeader("upgrade"));
- if (IsUpgraded && HTTPManager.Logger.Level == Logger.Loglevels.All)
- VerboseLogging("Request Upgraded!");
- if (!readPayloadData)
- return true;
- return ReadPayload(forceReadRawContentLength);
- }
- protected bool ReadPayload(int forceReadRawContentLength)
- {
- // Reading from an already unpacked stream (eq. From a file cache)
- if (forceReadRawContentLength != -1)
- {
- #if !BESTHTTP_DISABLE_CACHING && (!UNITY_WEBGL || UNITY_EDITOR)
- this.IsFromCache = true;
- #endif
- ReadRaw(Stream, forceReadRawContentLength);
- if (HTTPManager.Logger.Level == Logger.Loglevels.All)
- VerboseLogging("ReadPayload Finished!");
- return true;
- }
- // http://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.4
- // 1.Any response message which "MUST NOT" include a message-body (such as the 1xx, 204, and 304 responses and any response to a HEAD request)
- // is always terminated by the first empty line after the header fields, regardless of the entity-header fields present in the message.
- if ((StatusCode >= 100 && StatusCode < 200) || StatusCode == 204 || StatusCode == 304 || baseRequest.MethodType == HTTPMethods.Head)
- return true;
- #if (!UNITY_WEBGL || UNITY_EDITOR)
- if (HasHeaderWithValue("transfer-encoding", "chunked"))
- ReadChunked(Stream);
- else
- #endif
- {
- // http://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.4
- // Case 3 in the above link.
- List<string> contentLengthHeaders = GetHeaderValues("content-length");
- var contentRangeHeaders = GetHeaderValues("content-range");
- if (contentLengthHeaders != null && contentRangeHeaders == null)
- ReadRaw(Stream, long.Parse(contentLengthHeaders[0]));
- else if (contentRangeHeaders != null)
- {
- if (contentLengthHeaders != null)
- ReadRaw(Stream, long.Parse(contentLengthHeaders[0]));
- else
- {
- HTTPRange range = GetRange();
- ReadRaw(Stream, (range.LastBytePos - range.FirstBytePos) + 1);
- }
- }
- else
- ReadUnknownSize(Stream);
- }
- if (HTTPManager.Logger.Level == Logger.Loglevels.All)
- VerboseLogging("ReadPayload Finished!");
- return true;
- }
- #region Header Management
- protected void ReadHeaders(Stream stream)
- {
- string headerName = ReadTo(stream, (byte)':', LF).Trim();
- while (headerName != string.Empty)
- {
- string value = ReadTo(stream, LF);
- if (HTTPManager.Logger.Level == Logger.Loglevels.All)
- VerboseLogging(string.Format("Header - '{0}': '{1}'", headerName, value));
- AddHeader(headerName, value);
- headerName = ReadTo(stream, (byte)':', LF);
- }
- }
- protected void AddHeader(string name, string value)
- {
- name = name.ToLower();
- if (Headers == null)
- Headers = new Dictionary<string, List<string>>();
- List<string> values;
- if (!Headers.TryGetValue(name, out values))
- Headers.Add(name, values = new List<string>(1));
- values.Add(value);
- }
- /// <summary>
- /// Returns the list of values that received from the server for the given header name.
- /// <remarks>Remarks: All headers converted to lowercase while reading the response.</remarks>
- /// </summary>
- /// <param name="name">Name of the header</param>
- /// <returns>If no header found with the given name or there are no values in the list (eg. Count == 0) returns null.</returns>
- public List<string> GetHeaderValues(string name)
- {
- if (Headers == null)
- return null;
- name = name.ToLower();
- List<string> values;
- if (!Headers.TryGetValue(name, out values) || values.Count == 0)
- return null;
- return values;
- }
- /// <summary>
- /// Returns the first value in the header list or null if there are no header or value.
- /// </summary>
- /// <param name="name">Name of the header</param>
- /// <returns>If no header found with the given name or there are no values in the list (eg. Count == 0) returns null.</returns>
- public string GetFirstHeaderValue(string name)
- {
- if (Headers == null)
- return null;
- name = name.ToLower();
- List<string> values;
- if (!Headers.TryGetValue(name, out values) || values.Count == 0)
- return null;
- return values[0];
- }
- /// <summary>
- /// Checks if there is a header with the given name and value.
- /// </summary>
- /// <param name="headerName">Name of the header.</param>
- /// <param name="value"></param>
- /// <returns>Returns true if there is a header with the given name and value.</returns>
- public bool HasHeaderWithValue(string headerName, string value)
- {
- var values = GetHeaderValues(headerName);
- if (values == null)
- return false;
- for (int i = 0; i < values.Count; ++i)
- if (string.Compare(values[i], value, StringComparison.OrdinalIgnoreCase) == 0)
- return true;
- return false;
- }
- /// <summary>
- /// Checks if there is a header with the given name.
- /// </summary>
- /// <param name="headerName">Name of the header.</param>
- /// <returns>Returns true if there is a header with the given name.</returns>
- public bool HasHeader(string headerName)
- {
- var values = GetHeaderValues(headerName);
- if (values == null)
- return false;
- return true;
- }
- /// <summary>
- /// Parses the 'Content-Range' header's value and returns a HTTPRange object.
- /// </summary>
- /// <remarks>If the server ignores a byte-range-spec because it is syntactically invalid, the server SHOULD treat the request as if the invalid Range header field did not exist.
- /// (Normally, this means return a 200 response containing the full entity). In this case because of there are no 'Content-Range' header, this function will return null!</remarks>
- /// <returns>Returns null if no 'Content-Range' header found.</returns>
- public HTTPRange GetRange()
- {
- var rangeHeaders = GetHeaderValues("content-range");
- if (rangeHeaders == null)
- return null;
- // A byte-content-range-spec with a byte-range-resp-spec whose last- byte-pos value is less than its first-byte-pos value,
- // or whose instance-length value is less than or equal to its last-byte-pos value, is invalid.
- // The recipient of an invalid byte-content-range- spec MUST ignore it and any content transferred along with it.
- // A valid content-range sample: "bytes 500-1233/1234"
- var ranges = rangeHeaders[0].Split(new char[] { ' ', '-', '/' }, StringSplitOptions.RemoveEmptyEntries);
- // A server sending a response with status code 416 (Requested range not satisfiable) SHOULD include a Content-Range field with a byte-range-resp-spec of "*".
- // The instance-length specifies the current length of the selected resource.
- // "bytes */1234"
- if (ranges[1] == "*")
- return new HTTPRange(int.Parse(ranges[2]));
- return new HTTPRange(int.Parse(ranges[1]), int.Parse(ranges[2]), ranges[3] != "*" ? int.Parse(ranges[3]) : -1);
- }
- #endregion
- #region Static Stream Management Helper Functions
- public static string ReadTo(Stream stream, byte blocker)
- {
- using (var ms = new MemoryStream())
- {
- int ch = stream.ReadByte();
- while (ch != blocker && ch != -1)
- {
- ms.WriteByte((byte)ch);
- ch = stream.ReadByte();
- }
- return ms.ToArray().AsciiToString().Trim();
- }
- }
- public static string ReadTo(Stream stream, byte blocker1, byte blocker2)
- {
- using (var ms = new MemoryStream())
- {
- int ch = stream.ReadByte();
- while (ch != blocker1 && ch != blocker2 && ch != -1)
- {
- ms.WriteByte((byte)ch);
- ch = stream.ReadByte();
- }
- return ms.ToArray().AsciiToString().Trim();
- }
- }
- public static string NoTrimReadTo(Stream stream, byte blocker1, byte blocker2)
- {
- using (var ms = new MemoryStream())
- {
- int ch = stream.ReadByte();
- while (ch != blocker1 && ch != blocker2 && ch != -1)
- {
- ms.WriteByte((byte)ch);
- ch = stream.ReadByte();
- }
- return ms.ToArray().AsciiToString();
- }
- }
- #endregion
- #region Read Chunked Body
- protected int ReadChunkLength(Stream stream)
- {
- // Read until the end of line, then split the string so we will discard any optional chunk extensions
- string line = ReadTo(stream, LF);
- string[] splits = line.Split(';');
- string num = splits[0];
- int result;
- if (int.TryParse(num, System.Globalization.NumberStyles.AllowHexSpecifier, null, out result))
- return result;
- throw new Exception(string.Format("Can't parse '{0}' as a hex number!", num));
- }
- // http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.6.1
- protected void ReadChunked(Stream stream)
- {
- BeginReceiveStreamFragments();
- string contentLengthHeader = GetFirstHeaderValue("Content-Length");
- bool hasContentLengthHeader = !string.IsNullOrEmpty(contentLengthHeader);
- int realLength = 0;
- if (hasContentLengthHeader)
- hasContentLengthHeader = int.TryParse(contentLengthHeader, out realLength);
- if (HTTPManager.Logger.Level == Logger.Loglevels.All)
- VerboseLogging(string.Format("ReadChunked - hasContentLengthHeader: {0}, contentLengthHeader: {1} realLength: {2:N0}", hasContentLengthHeader.ToString(), contentLengthHeader, realLength));
- using (var output = new MemoryStream())
- {
- int chunkLength = ReadChunkLength(stream);
- if (HTTPManager.Logger.Level == Logger.Loglevels.All)
- VerboseLogging(string.Format("chunkLength: {0:N0}", chunkLength));
- byte[] buffer = new byte[chunkLength];
- int contentLength = 0;
- // Progress report:
- baseRequest.DownloadLength = hasContentLengthHeader ? realLength : chunkLength;
- baseRequest.DownloadProgressChanged = this.IsSuccess
- #if !BESTHTTP_DISABLE_CACHING && (!UNITY_WEBGL || UNITY_EDITOR)
- || this.IsFromCache
- #endif
- ;
- string encoding =
- #if !BESTHTTP_DISABLE_CACHING && (!UNITY_WEBGL || UNITY_EDITOR)
- IsFromCache ? null :
- #endif
- GetFirstHeaderValue("content-encoding");
- bool gzipped = !string.IsNullOrEmpty(encoding) && encoding == "gzip";
- while (chunkLength != 0)
- {
- // To avoid more GC garbage we use only one buffer, and resize only if the next chunk doesn't fit.
- if (buffer.Length < chunkLength)
- Array.Resize<byte>(ref buffer, chunkLength);
- int readBytes = 0;
- // Fill up the buffer
- do
- {
- int bytes = stream.Read(buffer, readBytes, chunkLength - readBytes);
- if (bytes <= 0)
- throw ExceptionHelper.ServerClosedTCPStream();
- readBytes += bytes;
- // Progress report:
- // Placing reporting inside this cycle will report progress much more frequent
- baseRequest.Downloaded += bytes;
- baseRequest.DownloadProgressChanged = this.IsSuccess
- #if !BESTHTTP_DISABLE_CACHING && (!UNITY_WEBGL || UNITY_EDITOR)
- || this.IsFromCache
- #endif
- ;
- } while (readBytes < chunkLength);
- if (baseRequest.UseStreaming)
- {
- // If reading from cache, we don't want to read too much data to memory. So we will wait until the loaded fragment processed.
- WaitWhileHasFragments();
- if (gzipped)
- {
- var decompressed = Decompress(buffer, 0, readBytes);
- if (decompressed != null)
- FeedStreamFragment(decompressed, 0, decompressed.Length);
- }
- else
- FeedStreamFragment(buffer, 0, readBytes);
- }
- else
- output.Write(buffer, 0, readBytes);
- // Every chunk data has a trailing CRLF
- ReadTo(stream, LF);
- contentLength += readBytes;
- // read the next chunk's length
- chunkLength = ReadChunkLength(stream);
- if (HTTPManager.Logger.Level == Logger.Loglevels.All)
- VerboseLogging(string.Format("chunkLength: {0:N0}", chunkLength));
- if (!hasContentLengthHeader)
- baseRequest.DownloadLength += chunkLength;
- baseRequest.DownloadProgressChanged = this.IsSuccess
- #if !BESTHTTP_DISABLE_CACHING && (!UNITY_WEBGL || UNITY_EDITOR)
- || this.IsFromCache
- #endif
- ;
- }
- if (baseRequest.UseStreaming)
- {
- if (gzipped)
- {
- var decompressed = Decompress(null, 0, 0, true);
- if (decompressed != null)
- FeedStreamFragment(decompressed, 0, decompressed.Length);
- }
- FlushRemainingFragmentBuffer();
- }
- // Read the trailing headers or the CRLF
- ReadHeaders(stream);
- // HTTP servers sometimes use compression (gzip) or deflate methods to optimize transmission.
- // How both chunked and gzip encoding interact is dictated by the two-staged encoding of HTTP:
- // first the content stream is encoded as (Content-Encoding: gzip), after which the resulting byte stream is encoded for transfer using another encoder (Transfer-Encoding: chunked).
- // This means that in case both compression and chunked encoding are enabled, the chunk encoding itself is not compressed, and the data in each chunk should not be compressed individually.
- // The remote endpoint can decode the incoming stream by first decoding it with the Transfer-Encoding, followed by the specified Content-Encoding.
- // It would be a better implementation when the chunk would be decododed on-the-fly. Becouse now the whole stream must be downloaded, and then decoded. It needs more memory.
- if (!baseRequest.UseStreaming)
- this.Data = DecodeStream(output);
- }
- }
- #endregion
- #region Read Raw Body
- // No transfer-encoding just raw bytes.
- internal void ReadRaw(Stream stream, long contentLength)
- {
- BeginReceiveStreamFragments();
- // Progress report:
- baseRequest.DownloadLength = contentLength;
- baseRequest.DownloadProgressChanged = this.IsSuccess
- #if !BESTHTTP_DISABLE_CACHING && (!UNITY_WEBGL || UNITY_EDITOR)
- || this.IsFromCache
- #endif
- ;
- if (HTTPManager.Logger.Level == Logger.Loglevels.All)
- VerboseLogging(string.Format("ReadRaw - contentLength: {0:N0}", contentLength));
- string encoding =
- #if !BESTHTTP_DISABLE_CACHING && (!UNITY_WEBGL || UNITY_EDITOR)
- IsFromCache ? null :
- #endif
- GetFirstHeaderValue("content-encoding");
- bool gzipped = !string.IsNullOrEmpty(encoding) && encoding == "gzip";
- if(!baseRequest.UseStreaming && contentLength > 2147483646)
- {
- throw new OverflowException("You have to use STREAMING to download files bigger than 2GB!");
- }
- using (var output = new MemoryStream(baseRequest.UseStreaming ? 0 : (int)contentLength))
- {
- byte[] buffer = new byte[Math.Max(baseRequest.StreamFragmentSize, MinBufferSize)];
- int readBytes = 0;
- while (contentLength > 0)
- {
- readBytes = 0;
- do
- {
- int readbuffer = (int)Math.Min(2147483646, (uint)contentLength);
- int bytes = stream.Read(buffer, readBytes, Math.Min(readbuffer, buffer.Length - readBytes));
- if (bytes <= 0)
- throw ExceptionHelper.ServerClosedTCPStream();
- readBytes += bytes;
- contentLength -= bytes;
- // Progress report:
- baseRequest.Downloaded += bytes;
- baseRequest.DownloadProgressChanged = this.IsSuccess
- #if !BESTHTTP_DISABLE_CACHING && (!UNITY_WEBGL || UNITY_EDITOR)
- || this.IsFromCache
- #endif
- ;
- } while (readBytes < buffer.Length && contentLength > 0);
- if (baseRequest.UseStreaming)
- {
- // If reading from cache, we don't want to read too much data to memory. So we will wait until the loaded fragment processed.
- WaitWhileHasFragments();
- if (gzipped)
- {
- var decompressed = Decompress(buffer, 0, readBytes);
- if (decompressed != null)
- FeedStreamFragment(decompressed, 0, decompressed.Length);
- }
- else
- FeedStreamFragment(buffer, 0, readBytes);
- }
- else
- output.Write(buffer, 0, readBytes);
- };
- if (baseRequest.UseStreaming)
- {
- if (gzipped)
- {
- var decompressed = Decompress(null, 0, 0, true);
- if (decompressed != null)
- FeedStreamFragment(decompressed, 0, decompressed.Length);
- }
- FlushRemainingFragmentBuffer();
- }
- if (!baseRequest.UseStreaming)
- this.Data = DecodeStream(output);
- }
- }
- #endregion
- #region Read Unknown Size
- protected void ReadUnknownSize(Stream stream)
- {
- string encoding =
- #if !BESTHTTP_DISABLE_CACHING && (!UNITY_WEBGL || UNITY_EDITOR)
- IsFromCache ? null :
- #endif
- GetFirstHeaderValue("content-encoding");
- bool gzipped = !string.IsNullOrEmpty(encoding) && encoding == "gzip";
- using (var output = new MemoryStream())
- {
- byte[] buffer = new byte[Math.Max(baseRequest.StreamFragmentSize, MinBufferSize)];
- if (HTTPManager.Logger.Level == Logger.Loglevels.All)
- VerboseLogging(string.Format("ReadUnknownSize - buffer size: {0:N0}", buffer.Length));
- int readBytes = 0;
- int bytes = 0;
- do
- {
- readBytes = 0;
- do
- {
- bytes = 0;
- #if (!NETFX_CORE && !UNITY_WP8) || UNITY_EDITOR
- NetworkStream networkStream = stream as NetworkStream;
- // If we have the good-old NetworkStream, than we can use the DataAvailable property. On WP8 platforms, these are omitted... :/
- if (networkStream != null && baseRequest.EnableSafeReadOnUnknownContentLength)
- {
- for (int i = readBytes; i < buffer.Length && networkStream.DataAvailable; ++i)
- {
- int read = stream.ReadByte();
- if (read >= 0)
- {
- buffer[i] = (byte)read;
- bytes++;
- }
- else
- break;
- }
- }
- else // This will be good anyway, but a little slower.
- #endif
- {
- bytes = stream.Read(buffer, readBytes, buffer.Length - readBytes);
- }
- readBytes += bytes;
- // Progress report:
- baseRequest.Downloaded += bytes;
- baseRequest.DownloadLength = baseRequest.Downloaded;
- baseRequest.DownloadProgressChanged = this.IsSuccess
- #if !BESTHTTP_DISABLE_CACHING && (!UNITY_WEBGL || UNITY_EDITOR)
- || this.IsFromCache
- #endif
- ;
- } while (readBytes < buffer.Length && bytes > 0);
- if (baseRequest.UseStreaming)
- {
- // If reading from cache, we don't want to read too much data to memory. So we will wait until the loaded fragment processed.
- WaitWhileHasFragments();
- if (gzipped)
- {
- var decompressed = Decompress(buffer, 0, readBytes);
- if (decompressed != null)
- FeedStreamFragment(decompressed, 0, decompressed.Length);
- }
- else
- FeedStreamFragment(buffer, 0, readBytes);
- }
- else
- output.Write(buffer, 0, readBytes);
- } while (bytes > 0);
- if (baseRequest.UseStreaming)
- {
- if (gzipped)
- {
- var decompressed = Decompress(null, 0, 0, true);
- if (decompressed != null)
- FeedStreamFragment(decompressed, 0, decompressed.Length);
- }
- FlushRemainingFragmentBuffer();
- }
- if (!baseRequest.UseStreaming)
- this.Data = DecodeStream(output);
- }
- }
- #endregion
- #region Stream Decoding
- protected byte[] DecodeStream(MemoryStream streamToDecode)
- {
- streamToDecode.Seek(0, SeekOrigin.Begin);
- // The cache stores the decoded data
- var encoding =
- #if !BESTHTTP_DISABLE_CACHING && (!UNITY_WEBGL || UNITY_EDITOR)
- IsFromCache ? null :
- #endif
- GetHeaderValues("content-encoding");
- #if !UNITY_WEBGL || UNITY_EDITOR
- Stream decoderStream = null;
- #endif
- // Return early if there are no encoding used.
- if (encoding == null)
- return streamToDecode.ToArray();
- else
- {
- switch (encoding[0])
- {
- #if !UNITY_WEBGL || UNITY_EDITOR
- case "gzip": decoderStream = new Decompression.Zlib.GZipStream(streamToDecode, Decompression.Zlib.CompressionMode.Decompress); break;
- case "deflate": decoderStream = new Decompression.Zlib.DeflateStream(streamToDecode, Decompression.Zlib.CompressionMode.Decompress); break;
- #endif
- //identity, utf-8, etc.
- default:
- // Do not copy from one stream to an other, just return with the raw bytes
- return streamToDecode.ToArray();
- }
- }
- #if !UNITY_WEBGL || UNITY_EDITOR
- using (var ms = new MemoryStream((int)streamToDecode.Length))
- {
- var buf = new byte[1024];
- int byteCount = 0;
- while ((byteCount = decoderStream.Read(buf, 0, buf.Length)) > 0)
- ms.Write(buf, 0, byteCount);
- return ms.ToArray();
- }
- #endif
- }
- #endregion
- #region Streaming Fragments Support
- private System.IO.MemoryStream decompressorInputStream;
- private System.IO.MemoryStream decompressorOutputStream;
- private Decompression.Zlib.GZipStream decompressorGZipStream;
- private byte[] copyBuffer;
- const int MinLengthToDecompress = 256;
- private byte[] Decompress(byte[] data, int offset, int count, bool forceDecompress = false)
- {
- if (decompressorInputStream == null)
- decompressorInputStream = new MemoryStream(count);
- if (data != null)
- decompressorInputStream.Write(data, offset, count);
- if (!forceDecompress && decompressorInputStream.Length < MinLengthToDecompress)
- return null;
-
- decompressorInputStream.Position = 0;
- if (decompressorGZipStream == null)
- {
- decompressorGZipStream = new Decompression.Zlib.GZipStream(decompressorInputStream,
- Decompression.Zlib.CompressionMode.Decompress,
- Decompression.Zlib.CompressionLevel.Default,
- true);
- decompressorGZipStream.FlushMode = Decompression.Zlib.FlushType.Sync;
- }
- if (decompressorOutputStream == null)
- decompressorOutputStream = new System.IO.MemoryStream();
- decompressorOutputStream.SetLength(0);
- if (copyBuffer == null)
- copyBuffer = new byte[1024];
- int readCount;
- while ((readCount = decompressorGZipStream.Read(copyBuffer, 0, copyBuffer.Length)) != 0)
- decompressorOutputStream.Write(copyBuffer, 0, readCount);
- decompressorGZipStream.SetLength(0);
- byte[] result = decompressorOutputStream.ToArray();
-
- return result;
- }
- protected void BeginReceiveStreamFragments()
- {
- #if !BESTHTTP_DISABLE_CACHING && (!UNITY_WEBGL || UNITY_EDITOR)
- if (!baseRequest.DisableCache && baseRequest.UseStreaming)
- {
- // If caching is enabled and the response not from cache and it's cacheble we will cache the downloaded data.
- if (!IsFromCache && HTTPCacheService.IsCacheble(baseRequest.CurrentUri, baseRequest.MethodType, this))
- cacheStream = HTTPCacheService.PrepareStreamed(baseRequest.CurrentUri, this);
- }
- #endif
- allFragmentSize = 0;
- }
- /// <summary>
- /// Add data to the fragments list.
- /// </summary>
- /// <param name="buffer">The buffer to be added.</param>
- /// <param name="pos">The position where we start copy the data.</param>
- /// <param name="length">How many data we want to copy.</param>
- protected void FeedStreamFragment(byte[] buffer, int pos, int length)
- {
- if (buffer == null || length == 0)
- return;
- if (fragmentBuffer == null)
- {
- fragmentBuffer = new byte[baseRequest.StreamFragmentSize];
- fragmentBufferDataLength = 0;
- }
- if (fragmentBufferDataLength + length <= baseRequest.StreamFragmentSize)
- {
- Array.Copy(buffer, pos, fragmentBuffer, fragmentBufferDataLength, length);
- fragmentBufferDataLength += length;
- if (fragmentBufferDataLength == baseRequest.StreamFragmentSize)
- {
- AddStreamedFragment(fragmentBuffer);
- fragmentBuffer = null;
- fragmentBufferDataLength = 0;
- }
- }
- else
- {
- int remaining = baseRequest.StreamFragmentSize - fragmentBufferDataLength;
- FeedStreamFragment(buffer, pos, remaining);
- FeedStreamFragment(buffer, pos + remaining, length - remaining);
- }
- }
- protected void FlushRemainingFragmentBuffer()
- {
- if (fragmentBuffer != null)
- {
- Array.Resize<byte>(ref fragmentBuffer, fragmentBufferDataLength);
- AddStreamedFragment(fragmentBuffer);
- fragmentBuffer = null;
- fragmentBufferDataLength = 0;
- }
- #if !BESTHTTP_DISABLE_CACHING && (!UNITY_WEBGL || UNITY_EDITOR)
- if (cacheStream != null)
- {
- cacheStream.Dispose();
- cacheStream = null;
- HTTPCacheService.SetBodyLength(baseRequest.CurrentUri, allFragmentSize);
- }
- #endif
- }
- protected void AddStreamedFragment(byte[] buffer)
- {
- lock (SyncRoot)
- {
- #if !BESTHTTP_DISABLE_CACHING && (!UNITY_WEBGL || UNITY_EDITOR)
- if (!IsCacheOnly)
- #endif
- {
- if (streamedFragments == null)
- streamedFragments = new List<byte[]>();
- streamedFragments.Add(buffer);
- }
- if (HTTPManager.Logger.Level == Logger.Loglevels.All && buffer != null && streamedFragments != null)
- VerboseLogging(string.Format("AddStreamedFragment buffer length: {0:N0} streamedFragments: {1:N0}", buffer.Length, streamedFragments.Count));
- #if !BESTHTTP_DISABLE_CACHING && (!UNITY_WEBGL || UNITY_EDITOR)
- if (cacheStream != null)
- {
- cacheStream.Write(buffer, 0, buffer.Length);
- allFragmentSize += buffer.Length;
- }
- #endif
- }
- }
- protected
- #if NETFX_CORE
- async
- #endif
- void WaitWhileHasFragments()
- {
- VerboseLogging("WaitWhileHasFragments");
- #if !UNITY_WEBGL || UNITY_EDITOR
- while (baseRequest.UseStreaming && HasFragmentsInQueue())
- {
- #if NETFX_CORE
- await System.Threading.Tasks.Task.Delay(16);
- #else
- System.Threading.Thread.Sleep(16);
- #endif
- }
- #endif
- }
- bool HasFragmentsInQueue()
- {
- lock (SyncRoot)
- {
- bool result = streamedFragments != null && streamedFragments.Count >= baseRequest.MaxFragmentQueueLength;
- if (result && HTTPManager.Logger.Level == Logger.Loglevels.All)
- VerboseLogging(string.Format("HasFragmentsInQueue - {0} / {1}", streamedFragments.Count, baseRequest.MaxFragmentQueueLength));
- return result;
- }
- }
- /// <summary>
- /// If streaming is used, then every time this callback function called we can use this function to
- /// retrieve the downloaded and buffered data. The returned list can be null, if there is no data yet.
- /// </summary>
- /// <returns></returns>
- public List<byte[]> GetStreamedFragments()
- {
- lock (SyncRoot)
- {
- if (streamedFragments == null || streamedFragments.Count == 0)
- {
- if (HTTPManager.Logger.Level == Logger.Loglevels.All)
- VerboseLogging("GetStreamedFragments - no fragments, returning with null");
- return null;
- }
- var result = new List<byte[]>(streamedFragments);
- streamedFragments.Clear();
- if (HTTPManager.Logger.Level == Logger.Loglevels.All)
- VerboseLogging(string.Format("GetStreamedFragments - returning with {0:N0} fragments", result.Count.ToString()));
- return result;
- }
- }
- internal bool HasStreamedFragments()
- {
- lock (SyncRoot)
- return streamedFragments != null && streamedFragments.Count >= baseRequest.MaxFragmentQueueLength;
- }
- internal void FinishStreaming()
- {
- if (HTTPManager.Logger.Level == Logger.Loglevels.All)
- VerboseLogging("FinishStreaming");
- IsStreamingFinished = true;
- Dispose();
- }
- #endregion
- void VerboseLogging(string str)
- {
- if (HTTPManager.Logger.Level == Logger.Loglevels.All)
- HTTPManager.Logger.Verbose("HTTPResponse", "'" + this.baseRequest.CurrentUri.ToString() + "' - " + str);
- }
- /// <summary>
- /// IDisposable implementation.
- /// </summary>
- public void Dispose()
- {
- #if !BESTHTTP_DISABLE_CACHING && (!UNITY_WEBGL || UNITY_EDITOR)
- if (cacheStream != null)
- {
- cacheStream.Dispose();
- cacheStream = null;
- }
- #endif
- }
- }
- }
|