jellyfin-server/MediaBrowser.Common.Implementations/HttpClientManager/HttpClientManager.cs

937 lines
33 KiB
C#
Raw Normal View History

2014-12-01 12:43:34 +00:00
using System.Net.Sockets;
using MediaBrowser.Common.Configuration;
2014-09-28 16:50:33 +00:00
using MediaBrowser.Common.Extensions;
2013-03-04 05:43:06 +00:00
using MediaBrowser.Common.IO;
2013-02-25 00:13:45 +00:00
using MediaBrowser.Common.Net;
2013-02-21 21:39:53 +00:00
using MediaBrowser.Model.Logging;
2013-02-21 01:33:05 +00:00
using MediaBrowser.Model.Net;
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
2014-05-16 17:11:07 +00:00
using System.Collections.Specialized;
using System.Globalization;
2013-02-21 01:33:05 +00:00
using System.IO;
using System.Linq;
using System.Net;
using System.Net.Cache;
2013-02-21 01:33:05 +00:00
using System.Text;
using System.Threading;
using System.Threading.Tasks;
2016-10-25 19:02:04 +00:00
using MediaBrowser.Model.IO;
using MediaBrowser.Model.IO;
2013-02-21 01:33:05 +00:00
2013-02-26 21:05:52 +00:00
namespace MediaBrowser.Common.Implementations.HttpClientManager
2013-02-21 01:33:05 +00:00
{
/// <summary>
2013-02-26 21:05:52 +00:00
/// Class HttpClientManager
2013-02-21 01:33:05 +00:00
/// </summary>
2013-02-26 21:05:52 +00:00
public class HttpClientManager : IHttpClient
2013-02-21 01:33:05 +00:00
{
2013-11-30 06:49:38 +00:00
/// <summary>
/// When one request to a host times out, we'll ban all other requests for this period of time, to prevent scans from stalling
/// </summary>
2013-11-30 18:32:39 +00:00
private const int TimeoutSeconds = 30;
2013-11-30 06:49:38 +00:00
2013-02-21 21:39:53 +00:00
/// <summary>
/// The _logger
/// </summary>
private readonly ILogger _logger;
/// <summary>
2013-02-25 00:13:45 +00:00
/// The _app paths
/// </summary>
2013-02-25 00:13:45 +00:00
private readonly IApplicationPaths _appPaths;
2013-04-20 22:19:55 +00:00
private readonly IFileSystem _fileSystem;
2016-10-06 18:55:01 +00:00
private readonly IMemoryStreamProvider _memoryStreamProvider;
2013-02-21 01:33:05 +00:00
/// <summary>
2013-11-30 18:32:39 +00:00
/// Initializes a new instance of the <see cref="HttpClientManager" /> class.
2013-02-21 01:33:05 +00:00
/// </summary>
2013-10-02 17:05:13 +00:00
/// <param name="appPaths">The app paths.</param>
2013-02-21 21:39:53 +00:00
/// <param name="logger">The logger.</param>
2013-11-30 18:32:39 +00:00
/// <param name="fileSystem">The file system.</param>
/// <exception cref="System.ArgumentNullException">appPaths
2013-04-20 22:19:55 +00:00
/// or
2013-11-30 18:32:39 +00:00
/// logger</exception>
2016-10-06 18:55:01 +00:00
public HttpClientManager(IApplicationPaths appPaths, ILogger logger, IFileSystem fileSystem, IMemoryStreamProvider memoryStreamProvider)
2013-02-21 01:33:05 +00:00
{
2013-02-25 00:13:45 +00:00
if (appPaths == null)
{
2013-02-25 00:13:45 +00:00
throw new ArgumentNullException("appPaths");
}
if (logger == null)
{
throw new ArgumentNullException("logger");
}
2013-04-20 22:19:55 +00:00
2013-02-21 21:39:53 +00:00
_logger = logger;
_fileSystem = fileSystem;
2016-10-06 18:55:01 +00:00
_memoryStreamProvider = memoryStreamProvider;
2013-02-25 00:13:45 +00:00
_appPaths = appPaths;
// http://stackoverflow.com/questions/566437/http-post-returns-the-error-417-expectation-failed-c
ServicePointManager.Expect100Continue = false;
2015-07-23 05:25:55 +00:00
// Trakt requests sometimes fail without this
ServicePointManager.SecurityProtocol = SecurityProtocolType.Ssl3 | SecurityProtocolType.Tls;
2013-02-21 01:33:05 +00:00
}
/// <summary>
/// Holds a dictionary of http clients by host. Use GetHttpClient(host) to retrieve or create a client for web requests.
/// DON'T dispose it after use.
/// </summary>
/// <value>The HTTP clients.</value>
2013-06-01 17:57:34 +00:00
private readonly ConcurrentDictionary<string, HttpClientInfo> _httpClients = new ConcurrentDictionary<string, HttpClientInfo>();
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets
/// </summary>
/// <param name="host">The host.</param>
2013-05-22 13:49:57 +00:00
/// <param name="enableHttpCompression">if set to <c>true</c> [enable HTTP compression].</param>
2013-02-21 01:33:05 +00:00
/// <returns>HttpClient.</returns>
/// <exception cref="System.ArgumentNullException">host</exception>
2013-06-01 17:57:34 +00:00
private HttpClientInfo GetHttpClient(string host, bool enableHttpCompression)
2013-02-21 01:33:05 +00:00
{
if (string.IsNullOrEmpty(host))
{
throw new ArgumentNullException("host");
}
2013-06-01 17:57:34 +00:00
HttpClientInfo client;
var key = host + enableHttpCompression;
if (!_httpClients.TryGetValue(key, out client))
2013-02-21 01:33:05 +00:00
{
client = new HttpClientInfo();
2013-10-02 17:05:13 +00:00
_httpClients.TryAdd(key, client);
2013-02-21 01:33:05 +00:00
}
return client;
}
2015-06-07 21:21:30 +00:00
private WebRequest CreateWebRequest(string url)
{
try
{
return WebRequest.Create(url);
}
catch (NotSupportedException)
{
//Webrequest creation does fail on MONO randomly when using WebRequest.Create
//the issue occurs in the GetCreator method here: http://www.oschina.net/code/explore/mono-2.8.1/mcs/class/System/System.Net/WebRequest.cs
var type = Type.GetType("System.Net.HttpRequestCreator, System, Version=4.0.0.0,Culture=neutral, PublicKeyToken=b77a5c561934e089");
var creator = Activator.CreateInstance(type, nonPublic: true) as IWebRequestCreate;
return creator.Create(new Uri(url)) as HttpWebRequest;
}
}
2016-03-25 05:39:49 +00:00
private void AddIpv4Option(HttpWebRequest request, HttpRequestOptions options)
{
request.ServicePoint.BindIPEndPointDelegate = (servicePount, remoteEndPoint, retryCount) =>
{
if (remoteEndPoint.AddressFamily == AddressFamily.InterNetwork)
{
return new IPEndPoint(IPAddress.Any, 0);
}
throw new InvalidOperationException("no IPv4 address");
};
}
2016-06-16 02:37:06 +00:00
private WebRequest GetRequest(HttpRequestOptions options, string method)
{
var url = options.Url;
var uriAddress = new Uri(url);
var userInfo = uriAddress.UserInfo;
if (!string.IsNullOrWhiteSpace(userInfo))
{
_logger.Info("Found userInfo in url: {0} ... url: {1}", userInfo, url);
url = url.Replace(userInfo + "@", string.Empty);
}
var request = CreateWebRequest(url);
2015-03-31 18:50:08 +00:00
var httpWebRequest = request as HttpWebRequest;
2015-03-31 18:50:08 +00:00
if (httpWebRequest != null)
{
2016-06-30 14:50:08 +00:00
if (options.PreferIpv4)
{
AddIpv4Option(httpWebRequest, options);
}
2016-03-25 05:39:49 +00:00
2015-03-31 18:50:08 +00:00
AddRequestHeaders(httpWebRequest, options);
2016-06-16 02:37:06 +00:00
httpWebRequest.AutomaticDecompression = options.EnableHttpCompression ?
(options.DecompressionMethod ?? DecompressionMethods.Deflate) :
DecompressionMethods.None;
2015-03-31 18:50:08 +00:00
}
2014-04-08 12:27:22 +00:00
2014-05-07 02:28:19 +00:00
request.CachePolicy = new RequestCachePolicy(RequestCacheLevel.BypassCache);
2014-04-08 12:27:22 +00:00
2015-03-31 18:50:08 +00:00
if (httpWebRequest != null)
2014-07-17 03:17:14 +00:00
{
2015-03-31 18:50:08 +00:00
if (options.EnableKeepAlive)
{
httpWebRequest.KeepAlive = true;
}
2014-07-17 03:17:14 +00:00
}
request.Method = method;
2014-10-22 04:42:08 +00:00
request.Timeout = options.TimeoutMs;
2015-03-31 18:50:08 +00:00
if (httpWebRequest != null)
2014-06-04 03:34:36 +00:00
{
2015-03-31 18:50:08 +00:00
if (!string.IsNullOrEmpty(options.Host))
{
httpWebRequest.Host = options.Host;
}
if (!string.IsNullOrEmpty(options.Referer))
{
httpWebRequest.Referer = options.Referer;
}
2014-06-04 03:34:36 +00:00
}
if (!string.IsNullOrWhiteSpace(userInfo))
{
var parts = userInfo.Split(':');
if (parts.Length == 2)
{
request.Credentials = GetCredential(url, parts[0], parts[1]);
request.PreAuthenticate = true;
}
}
return request;
}
private CredentialCache GetCredential(string url, string username, string password)
{
//ServicePointManager.SecurityProtocol = SecurityProtocolType.Ssl3;
CredentialCache credentialCache = new CredentialCache();
credentialCache.Add(new Uri(url), "Basic", new NetworkCredential(username, password));
return credentialCache;
}
2014-02-27 18:00:49 +00:00
private void AddRequestHeaders(HttpWebRequest request, HttpRequestOptions options)
{
foreach (var header in options.RequestHeaders.ToList())
{
if (string.Equals(header.Key, "Accept", StringComparison.OrdinalIgnoreCase))
{
request.Accept = header.Value;
}
else if (string.Equals(header.Key, "User-Agent", StringComparison.OrdinalIgnoreCase))
{
request.UserAgent = header.Value;
}
else
{
request.Headers.Set(header.Key, header.Value);
}
}
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets the response internal.
2013-02-21 01:33:05 +00:00
/// </summary>
/// <param name="options">The options.</param>
/// <returns>Task{HttpResponseInfo}.</returns>
2013-12-16 18:44:03 +00:00
public Task<HttpResponseInfo> GetResponse(HttpRequestOptions options)
{
return SendAsync(options, "GET");
}
/// <summary>
/// Performs a GET request and returns the resulting stream
/// </summary>
/// <param name="options">The options.</param>
/// <returns>Task{Stream}.</returns>
public async Task<Stream> Get(HttpRequestOptions options)
{
var response = await GetResponse(options).ConfigureAwait(false);
return response.Content;
}
/// <summary>
/// Performs a GET request and returns the resulting stream
/// </summary>
/// <param name="url">The URL.</param>
/// <param name="resourcePool">The resource pool.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{Stream}.</returns>
public Task<Stream> Get(string url, SemaphoreSlim resourcePool, CancellationToken cancellationToken)
2013-02-21 01:33:05 +00:00
{
2013-12-16 18:44:03 +00:00
return Get(new HttpRequestOptions
{
Url = url,
ResourcePool = resourcePool,
CancellationToken = cancellationToken,
2016-10-06 18:55:01 +00:00
BufferContent = resourcePool != null
2013-12-16 18:44:03 +00:00
});
}
/// <summary>
/// Gets the specified URL.
/// </summary>
/// <param name="url">The URL.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{Stream}.</returns>
public Task<Stream> Get(string url, CancellationToken cancellationToken)
{
return Get(url, null, cancellationToken);
}
/// <summary>
/// send as an asynchronous operation.
/// </summary>
/// <param name="options">The options.</param>
/// <param name="httpMethod">The HTTP method.</param>
/// <returns>Task{HttpResponseInfo}.</returns>
/// <exception cref="HttpException">
/// </exception>
2014-04-21 16:02:30 +00:00
public async Task<HttpResponseInfo> SendAsync(HttpRequestOptions options, string httpMethod)
2014-09-28 16:50:33 +00:00
{
2014-10-02 00:28:16 +00:00
if (options.CacheMode == CacheMode.None)
2014-09-28 16:50:33 +00:00
{
2016-09-13 18:29:31 +00:00
return await SendAsyncInternal(options, httpMethod).ConfigureAwait(false);
2014-09-28 16:50:33 +00:00
}
var url = options.Url;
var urlHash = url.ToLower().GetMD5().ToString("N");
2015-11-12 18:41:08 +00:00
2014-09-28 16:50:33 +00:00
var responseCachePath = Path.Combine(_appPaths.CachePath, "httpclient", urlHash);
2016-09-13 18:29:31 +00:00
var response = await GetCachedResponse(responseCachePath, options.CacheLength, url).ConfigureAwait(false);
2014-09-28 16:50:33 +00:00
if (response != null)
{
return response;
}
2015-11-12 18:41:08 +00:00
response = await SendAsyncInternal(options, httpMethod).ConfigureAwait(false);
2015-10-16 04:46:41 +00:00
2015-11-12 18:41:08 +00:00
if (response.StatusCode == HttpStatusCode.OK)
2014-09-28 16:50:33 +00:00
{
2015-11-12 18:41:08 +00:00
await CacheResponse(response, responseCachePath).ConfigureAwait(false);
2014-09-28 16:50:33 +00:00
}
2015-11-12 18:41:08 +00:00
return response;
2014-09-28 16:50:33 +00:00
}
private async Task<HttpResponseInfo> GetCachedResponse(string responseCachePath, TimeSpan cacheLength, string url)
{
2016-06-30 23:17:49 +00:00
_logger.Info("Checking for cache file {0}", responseCachePath);
2014-09-28 16:50:33 +00:00
try
{
if (_fileSystem.GetLastWriteTimeUtc(responseCachePath).Add(cacheLength) > DateTime.UtcNow)
{
2016-10-25 19:02:04 +00:00
using (var stream = _fileSystem.GetFileStream(responseCachePath, FileOpenMode.Open, FileAccessMode.Read, FileShareMode.Read, true))
2014-09-28 16:50:33 +00:00
{
2016-10-06 18:55:01 +00:00
var memoryStream = _memoryStreamProvider.CreateNew();
2014-09-28 16:50:33 +00:00
await stream.CopyToAsync(memoryStream).ConfigureAwait(false);
memoryStream.Position = 0;
return new HttpResponseInfo
{
ResponseUrl = url,
Content = memoryStream,
StatusCode = HttpStatusCode.OK,
ContentLength = memoryStream.Length
};
}
}
}
catch (FileNotFoundException)
{
}
catch (DirectoryNotFoundException)
{
}
return null;
}
private async Task CacheResponse(HttpResponseInfo response, string responseCachePath)
{
2015-10-15 15:51:00 +00:00
_fileSystem.CreateDirectory(Path.GetDirectoryName(responseCachePath));
2014-09-28 16:50:33 +00:00
using (var responseStream = response.Content)
{
2016-10-06 18:55:01 +00:00
var memoryStream = _memoryStreamProvider.CreateNew();
2015-11-12 18:41:08 +00:00
await responseStream.CopyToAsync(memoryStream).ConfigureAwait(false);
memoryStream.Position = 0;
2014-09-28 16:50:33 +00:00
2016-10-25 19:02:04 +00:00
using (var fileStream = _fileSystem.GetFileStream(responseCachePath, FileOpenMode.Create, FileAccessMode.Write, FileShareMode.None, true))
2015-11-12 18:41:08 +00:00
{
2014-09-28 16:50:33 +00:00
await memoryStream.CopyToAsync(fileStream).ConfigureAwait(false);
memoryStream.Position = 0;
response.Content = memoryStream;
}
}
}
private async Task<HttpResponseInfo> SendAsyncInternal(HttpRequestOptions options, string httpMethod)
2013-12-16 18:44:03 +00:00
{
ValidateParams(options);
2013-02-21 01:33:05 +00:00
options.CancellationToken.ThrowIfCancellationRequested();
2013-02-21 01:33:05 +00:00
2013-06-01 17:57:34 +00:00
var client = GetHttpClient(GetHostFromUrl(options.Url), options.EnableHttpCompression);
2013-11-30 06:49:38 +00:00
if ((DateTime.UtcNow - client.LastTimeout).TotalSeconds < TimeoutSeconds)
2013-06-01 17:57:34 +00:00
{
2014-09-16 03:33:30 +00:00
throw new HttpException(string.Format("Cancelling connection to {0} due to a previous timeout.", options.Url))
{
IsTimedOut = true
};
2013-06-01 17:57:34 +00:00
}
2016-06-16 02:37:06 +00:00
var httpWebRequest = GetRequest(options, httpMethod);
2013-12-16 18:44:03 +00:00
2014-05-05 04:36:45 +00:00
if (options.RequestContentBytes != null ||
!string.IsNullOrEmpty(options.RequestContent) ||
string.Equals(httpMethod, "post", StringComparison.OrdinalIgnoreCase))
2013-12-16 18:44:03 +00:00
{
2014-09-28 16:50:33 +00:00
var bytes = options.RequestContentBytes ??
2014-05-07 02:28:19 +00:00
Encoding.UTF8.GetBytes(options.RequestContent ?? string.Empty);
2013-12-16 18:44:03 +00:00
httpWebRequest.ContentType = options.RequestContentType ?? "application/x-www-form-urlencoded";
2014-09-28 16:50:33 +00:00
2013-12-16 18:44:03 +00:00
httpWebRequest.ContentLength = bytes.Length;
httpWebRequest.GetRequestStream().Write(bytes, 0, bytes.Length);
}
if (options.ResourcePool != null)
{
await options.ResourcePool.WaitAsync(options.CancellationToken).ConfigureAwait(false);
}
2013-11-30 06:49:38 +00:00
if ((DateTime.UtcNow - client.LastTimeout).TotalSeconds < TimeoutSeconds)
{
2013-05-22 16:51:39 +00:00
if (options.ResourcePool != null)
{
options.ResourcePool.Release();
2013-05-22 16:51:39 +00:00
}
throw new HttpException(string.Format("Connection to {0} timed out", options.Url)) { IsTimedOut = true };
}
2014-03-14 17:09:22 +00:00
if (options.LogRequest)
{
_logger.Info("HttpClientManager {0}: {1}", httpMethod.ToUpper(), options.Url);
}
try
{
options.CancellationToken.ThrowIfCancellationRequested();
2013-05-06 20:47:37 +00:00
if (!options.BufferContent)
{
2014-10-22 04:42:08 +00:00
var response = await GetResponseAsync(httpWebRequest, TimeSpan.FromMilliseconds(options.TimeoutMs)).ConfigureAwait(false);
var httpResponse = (HttpWebResponse)response;
2015-07-20 18:32:55 +00:00
EnsureSuccessStatusCode(client, httpResponse, options);
options.CancellationToken.ThrowIfCancellationRequested();
2014-10-12 01:46:02 +00:00
return GetResponseInfo(httpResponse, httpResponse.GetResponseStream(), GetContentLength(httpResponse), httpResponse);
}
2014-04-08 12:27:22 +00:00
2014-10-22 04:42:08 +00:00
using (var response = await GetResponseAsync(httpWebRequest, TimeSpan.FromMilliseconds(options.TimeoutMs)).ConfigureAwait(false))
2013-05-22 16:51:39 +00:00
{
var httpResponse = (HttpWebResponse)response;
2015-07-20 18:32:55 +00:00
EnsureSuccessStatusCode(client, httpResponse, options);
2013-05-22 12:45:03 +00:00
options.CancellationToken.ThrowIfCancellationRequested();
2013-04-20 22:19:55 +00:00
using (var stream = httpResponse.GetResponseStream())
{
2016-10-06 18:55:01 +00:00
var memoryStream = _memoryStreamProvider.CreateNew();
2013-04-20 22:19:55 +00:00
await stream.CopyToAsync(memoryStream).ConfigureAwait(false);
2013-05-22 16:51:39 +00:00
memoryStream.Position = 0;
2013-05-22 16:51:39 +00:00
2014-10-12 01:46:02 +00:00
return GetResponseInfo(httpResponse, memoryStream, memoryStream.Length, null);
2013-06-01 17:57:34 +00:00
}
2013-05-18 18:58:16 +00:00
}
}
catch (OperationCanceledException ex)
{
2015-10-15 15:51:00 +00:00
throw GetCancellationException(options, client, options.CancellationToken, ex);
}
catch (Exception ex)
{
2015-10-15 15:51:00 +00:00
throw GetException(ex, options, client);
}
finally
{
if (options.ResourcePool != null)
{
options.ResourcePool.Release();
}
2013-02-21 01:33:05 +00:00
}
}
2013-04-20 22:19:55 +00:00
2014-10-12 01:46:02 +00:00
private HttpResponseInfo GetResponseInfo(HttpWebResponse httpResponse, Stream content, long? contentLength, IDisposable disposable)
{
2016-10-22 02:08:34 +00:00
var responseInfo = new HttpResponseInfo(disposable)
{
Content = content,
StatusCode = httpResponse.StatusCode,
ContentType = httpResponse.ContentType,
2014-06-02 19:32:41 +00:00
ContentLength = contentLength,
ResponseUrl = httpResponse.ResponseUri.ToString()
};
2016-10-22 02:08:34 +00:00
if (httpResponse.Headers != null)
{
SetHeaders(httpResponse.Headers, responseInfo);
}
return responseInfo;
}
private HttpResponseInfo GetResponseInfo(HttpWebResponse httpResponse, string tempFile, long? contentLength)
{
2016-10-22 02:08:34 +00:00
var responseInfo = new HttpResponseInfo
{
TempFilePath = tempFile,
StatusCode = httpResponse.StatusCode,
ContentType = httpResponse.ContentType,
ContentLength = contentLength
};
2016-10-22 02:08:34 +00:00
if (httpResponse.Headers != null)
{
SetHeaders(httpResponse.Headers, responseInfo);
}
return responseInfo;
}
private void SetHeaders(WebHeaderCollection headers, HttpResponseInfo responseInfo)
{
foreach (var key in headers.AllKeys)
{
responseInfo.Headers[key] = headers[key];
}
}
2013-12-16 18:44:03 +00:00
public Task<HttpResponseInfo> Post(HttpRequestOptions options)
{
2013-12-16 18:44:03 +00:00
return SendAsync(options, "POST");
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Performs a POST request
/// </summary>
/// <param name="options">The options.</param>
2013-02-21 01:33:05 +00:00
/// <param name="postData">Params to add to the POST data.</param>
/// <returns>stream on success, null on failure</returns>
public async Task<Stream> Post(HttpRequestOptions options, Dictionary<string, string> postData)
2013-02-21 01:33:05 +00:00
{
2014-09-03 02:30:05 +00:00
options.SetPostData(postData);
2013-02-21 01:33:05 +00:00
2013-12-16 18:44:03 +00:00
var response = await Post(options).ConfigureAwait(false);
2013-12-16 18:44:03 +00:00
return response.Content;
2013-02-21 01:33:05 +00:00
}
/// <summary>
/// Performs a POST request
/// </summary>
/// <param name="url">The URL.</param>
/// <param name="postData">Params to add to the POST data.</param>
/// <param name="resourcePool">The resource pool.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>stream on success, null on failure</returns>
public Task<Stream> Post(string url, Dictionary<string, string> postData, SemaphoreSlim resourcePool, CancellationToken cancellationToken)
{
return Post(new HttpRequestOptions
{
Url = url,
ResourcePool = resourcePool,
2016-10-06 18:55:01 +00:00
CancellationToken = cancellationToken,
BufferContent = resourcePool != null
}, postData);
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Downloads the contents of a given url into a temporary location
/// </summary>
2013-03-14 19:52:53 +00:00
/// <param name="options">The options.</param>
2013-02-21 01:33:05 +00:00
/// <returns>Task{System.String}.</returns>
public async Task<string> GetTempFile(HttpRequestOptions options)
2013-07-20 21:36:59 +00:00
{
var response = await GetTempFileResponse(options).ConfigureAwait(false);
return response.TempFilePath;
}
public async Task<HttpResponseInfo> GetTempFileResponse(HttpRequestOptions options)
2013-03-14 19:52:53 +00:00
{
2013-12-16 18:44:03 +00:00
ValidateParams(options);
2013-03-14 19:52:53 +00:00
2015-10-15 15:51:00 +00:00
_fileSystem.CreateDirectory(_appPaths.TempDirectory);
2013-12-15 01:17:57 +00:00
var tempFile = Path.Combine(_appPaths.TempDirectory, Guid.NewGuid() + ".tmp");
2013-03-14 19:52:53 +00:00
if (options.Progress == null)
2013-02-21 01:33:05 +00:00
{
throw new ArgumentNullException("progress");
}
2013-03-14 19:52:53 +00:00
options.CancellationToken.ThrowIfCancellationRequested();
2013-02-21 01:33:05 +00:00
2016-06-16 02:37:06 +00:00
var httpWebRequest = GetRequest(options, "GET");
2013-03-14 19:52:53 +00:00
if (options.ResourcePool != null)
2013-02-21 01:33:05 +00:00
{
2013-03-14 19:52:53 +00:00
await options.ResourcePool.WaitAsync(options.CancellationToken).ConfigureAwait(false);
2013-02-21 01:33:05 +00:00
}
2013-03-14 19:52:53 +00:00
options.Progress.Report(0);
2014-03-14 17:09:22 +00:00
if (options.LogRequest)
{
_logger.Info("HttpClientManager.GetTempFileResponse url: {0}", options.Url);
}
2013-03-14 19:52:53 +00:00
2015-10-15 15:51:00 +00:00
var client = GetHttpClient(GetHostFromUrl(options.Url), options.EnableHttpCompression);
2013-02-21 01:33:05 +00:00
try
{
2013-03-14 19:52:53 +00:00
options.CancellationToken.ThrowIfCancellationRequested();
2013-02-21 01:33:05 +00:00
using (var response = await httpWebRequest.GetResponseAsync().ConfigureAwait(false))
2013-02-21 01:33:05 +00:00
{
var httpResponse = (HttpWebResponse)response;
2013-02-21 01:33:05 +00:00
2015-07-20 18:32:55 +00:00
EnsureSuccessStatusCode(client, httpResponse, options);
2013-03-14 19:52:53 +00:00
options.CancellationToken.ThrowIfCancellationRequested();
var contentLength = GetContentLength(httpResponse);
2013-02-21 01:33:05 +00:00
if (!contentLength.HasValue)
{
// We're not able to track progress
using (var stream = httpResponse.GetResponseStream())
2013-02-21 01:33:05 +00:00
{
2016-10-25 19:02:04 +00:00
using (var fs = _fileSystem.GetFileStream(tempFile, FileOpenMode.Create, FileAccessMode.Write, FileShareMode.Read, true))
{
await stream.CopyToAsync(fs, StreamDefaults.DefaultCopyToBufferSize, options.CancellationToken).ConfigureAwait(false);
}
2013-02-21 01:33:05 +00:00
}
}
else
{
using (var stream = ProgressStream.CreateReadProgressStream(httpResponse.GetResponseStream(), options.Progress.Report, contentLength.Value))
2013-02-21 01:33:05 +00:00
{
2016-10-25 19:02:04 +00:00
using (var fs = _fileSystem.GetFileStream(tempFile, FileOpenMode.Create, FileAccessMode.Write, FileShareMode.Read, true))
{
await stream.CopyToAsync(fs, StreamDefaults.DefaultCopyToBufferSize, options.CancellationToken).ConfigureAwait(false);
}
2013-02-21 01:33:05 +00:00
}
}
2013-02-21 01:33:05 +00:00
options.Progress.Report(100);
2013-02-21 01:33:05 +00:00
return GetResponseInfo(httpResponse, tempFile, contentLength);
2013-02-21 01:33:05 +00:00
}
}
2013-03-14 19:52:53 +00:00
catch (Exception ex)
2013-02-21 01:33:05 +00:00
{
2014-10-23 04:26:01 +00:00
DeleteTempFile(tempFile);
2015-10-15 15:51:00 +00:00
throw GetException(ex, options, client);
2013-02-21 01:33:05 +00:00
}
2013-03-14 19:52:53 +00:00
finally
2013-02-21 01:33:05 +00:00
{
2013-03-14 19:52:53 +00:00
if (options.ResourcePool != null)
2013-02-21 01:33:05 +00:00
{
2013-03-14 19:52:53 +00:00
options.ResourcePool.Release();
2013-02-21 01:33:05 +00:00
}
}
2013-03-14 19:52:53 +00:00
}
2013-02-21 01:33:05 +00:00
private long? GetContentLength(HttpWebResponse response)
{
var length = response.ContentLength;
if (length == 0)
{
return null;
}
return length;
}
protected static readonly CultureInfo UsCulture = new CultureInfo("en-US");
2015-10-15 15:51:00 +00:00
private Exception GetException(Exception ex, HttpRequestOptions options, HttpClientInfo client)
2013-03-14 19:52:53 +00:00
{
2015-10-15 15:51:00 +00:00
if (ex is HttpException)
{
return ex;
}
2014-10-23 04:26:01 +00:00
var webException = ex as WebException
?? ex.InnerException as WebException;
2013-03-14 19:52:53 +00:00
2014-10-23 04:26:01 +00:00
if (webException != null)
2013-03-14 19:52:53 +00:00
{
2015-10-15 15:51:00 +00:00
if (options.LogErrors)
{
_logger.ErrorException("Error getting response from " + options.Url, ex);
}
var exception = new HttpException(ex.Message, ex);
var response = webException.Response as HttpWebResponse;
if (response != null)
{
exception.StatusCode = response.StatusCode;
if ((int)response.StatusCode == 429)
{
client.LastTimeout = DateTime.UtcNow;
}
}
return exception;
2013-02-21 01:33:05 +00:00
}
2013-03-14 19:52:53 +00:00
2014-10-23 04:26:01 +00:00
var operationCanceledException = ex as OperationCanceledException
?? ex.InnerException as OperationCanceledException;
2013-11-30 18:32:39 +00:00
2014-10-23 04:26:01 +00:00
if (operationCanceledException != null)
2013-03-14 19:52:53 +00:00
{
2015-10-15 15:51:00 +00:00
return GetCancellationException(options, client, options.CancellationToken, operationCanceledException);
2013-02-21 01:33:05 +00:00
}
2015-10-07 21:42:29 +00:00
if (options.LogErrors)
{
_logger.ErrorException("Error getting response from " + options.Url, ex);
}
2013-12-16 18:44:03 +00:00
2013-07-20 21:36:59 +00:00
return ex;
2013-03-14 19:52:53 +00:00
}
2013-02-21 01:33:05 +00:00
private void DeleteTempFile(string file)
{
try
{
_fileSystem.DeleteFile(file);
}
catch (IOException)
{
// Might not have been created at all. No need to worry.
}
}
2013-12-16 18:44:03 +00:00
private void ValidateParams(HttpRequestOptions options)
2013-02-21 01:33:05 +00:00
{
2013-12-16 18:44:03 +00:00
if (string.IsNullOrEmpty(options.Url))
2013-02-21 01:33:05 +00:00
{
2013-12-16 18:44:03 +00:00
throw new ArgumentNullException("options");
2013-02-21 01:33:05 +00:00
}
}
/// <summary>
/// Gets the host from URL.
/// </summary>
/// <param name="url">The URL.</param>
/// <returns>System.String.</returns>
private string GetHostFromUrl(string url)
{
2015-06-05 05:32:14 +00:00
var index = url.IndexOf("://", StringComparison.OrdinalIgnoreCase);
if (index != -1)
{
url = url.Substring(index + 3);
var host = url.Split(new[] { '/' }, StringSplitOptions.RemoveEmptyEntries).FirstOrDefault();
if (!string.IsNullOrWhiteSpace(host))
{
return host;
}
}
return url;
2013-02-21 01:33:05 +00:00
}
/// <summary>
/// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
/// </summary>
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Releases unmanaged and - optionally - managed resources.
/// </summary>
/// <param name="dispose"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
protected virtual void Dispose(bool dispose)
2013-02-21 01:33:05 +00:00
{
if (dispose)
{
_httpClients.Clear();
}
}
/// <summary>
/// Throws the cancellation exception.
/// </summary>
2015-10-07 21:42:29 +00:00
/// <param name="options">The options.</param>
2015-10-15 15:51:00 +00:00
/// <param name="client">The client.</param>
2013-02-21 01:33:05 +00:00
/// <param name="cancellationToken">The cancellation token.</param>
/// <param name="exception">The exception.</param>
/// <returns>Exception.</returns>
2015-10-15 15:51:00 +00:00
private Exception GetCancellationException(HttpRequestOptions options, HttpClientInfo client, CancellationToken cancellationToken, OperationCanceledException exception)
2013-02-21 01:33:05 +00:00
{
// If the HttpClient's timeout is reached, it will cancel the Task internally
if (!cancellationToken.IsCancellationRequested)
{
2015-10-07 21:42:29 +00:00
var msg = string.Format("Connection to {0} timed out", options.Url);
2013-02-21 01:33:05 +00:00
2015-10-07 21:42:29 +00:00
if (options.LogErrors)
{
_logger.Error(msg);
}
2013-02-21 01:33:05 +00:00
2015-10-15 15:51:00 +00:00
client.LastTimeout = DateTime.UtcNow;
2013-02-21 01:33:05 +00:00
// Throw an HttpException so that the caller doesn't think it was cancelled by user code
2014-09-16 03:33:30 +00:00
return new HttpException(msg, exception)
{
IsTimedOut = true
};
2013-02-21 01:33:05 +00:00
}
return exception;
}
2015-07-20 18:32:55 +00:00
private void EnsureSuccessStatusCode(HttpClientInfo client, HttpWebResponse response, HttpRequestOptions options)
{
var statusCode = response.StatusCode;
2015-07-20 18:32:55 +00:00
var isSuccessful = statusCode >= HttpStatusCode.OK && statusCode <= (HttpStatusCode)299;
if (!isSuccessful)
{
2014-04-08 12:27:22 +00:00
if (options.LogErrorResponseBody)
{
try
{
using (var stream = response.GetResponseStream())
{
if (stream != null)
{
using (var reader = new StreamReader(stream))
{
var msg = reader.ReadToEnd();
_logger.Error(msg);
}
}
}
}
catch
{
}
}
2014-09-16 03:33:30 +00:00
throw new HttpException(response.StatusDescription)
{
StatusCode = response.StatusCode
};
}
}
/// <summary>
/// Posts the specified URL.
/// </summary>
/// <param name="url">The URL.</param>
/// <param name="postData">The post data.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{Stream}.</returns>
public Task<Stream> Post(string url, Dictionary<string, string> postData, CancellationToken cancellationToken)
{
return Post(url, postData, null, cancellationToken);
}
2014-10-22 04:42:08 +00:00
private Task<WebResponse> GetResponseAsync(WebRequest request, TimeSpan timeout)
{
var taskCompletion = new TaskCompletionSource<WebResponse>();
Task<WebResponse> asyncTask = Task.Factory.FromAsync<WebResponse>(request.BeginGetResponse, request.EndGetResponse, null);
ThreadPool.RegisterWaitForSingleObject((asyncTask as IAsyncResult).AsyncWaitHandle, TimeoutCallback, request, timeout, true);
2015-09-14 12:50:37 +00:00
var callback = new TaskCallback { taskCompletion = taskCompletion };
asyncTask.ContinueWith(callback.OnSuccess, TaskContinuationOptions.NotOnFaulted);
2014-10-22 04:42:08 +00:00
// Handle errors
2015-09-14 12:50:37 +00:00
asyncTask.ContinueWith(callback.OnError, TaskContinuationOptions.OnlyOnFaulted);
2014-10-22 04:42:08 +00:00
return taskCompletion.Task;
}
private static void TimeoutCallback(object state, bool timedOut)
{
if (timedOut)
{
WebRequest request = (WebRequest)state;
if (state != null)
{
request.Abort();
}
}
}
2015-09-14 12:50:37 +00:00
private class TaskCallback
{
public TaskCompletionSource<WebResponse> taskCompletion;
public void OnSuccess(Task<WebResponse> task)
{
taskCompletion.TrySetResult(task.Result);
}
public void OnError(Task<WebResponse> task)
{
if (task.Exception != null)
{
taskCompletion.TrySetException(task.Exception);
}
else
{
taskCompletion.TrySetException(new List<Exception>());
}
}
}
2013-02-21 01:33:05 +00:00
}
}