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

547 lines
20 KiB
C#
Raw Normal View History

2013-03-04 05:43:06 +00:00
using MediaBrowser.Common.Configuration;
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;
using System.IO;
using System.Linq;
using System.Net.Cache;
using System.Net.Http;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
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-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-02-21 01:33:05 +00:00
/// <summary>
2013-02-26 21:05:52 +00:00
/// Initializes a new instance of the <see cref="HttpClientManager" /> class.
2013-02-21 01:33:05 +00:00
/// </summary>
2013-02-25 00:13:45 +00:00
/// <param name="appPaths">The kernel.</param>
2013-02-21 21:39:53 +00:00
/// <param name="logger">The logger.</param>
2013-02-26 21:05:52 +00:00
public HttpClientManager(IApplicationPaths appPaths, ILogger logger)
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-02-21 21:39:53 +00:00
_logger = logger;
2013-02-25 00:13:45 +00:00
_appPaths = appPaths;
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>
private readonly ConcurrentDictionary<string, HttpClient> _httpClients = new ConcurrentDictionary<string, HttpClient>();
/// <summary>
/// Gets
/// </summary>
/// <param name="host">The host.</param>
/// <returns>HttpClient.</returns>
/// <exception cref="System.ArgumentNullException">host</exception>
private HttpClient GetHttpClient(string host)
{
if (string.IsNullOrEmpty(host))
{
throw new ArgumentNullException("host");
}
HttpClient client;
if (!_httpClients.TryGetValue(host, out client))
{
var handler = new WebRequestHandler
{
2013-03-04 01:46:06 +00:00
//AutomaticDecompression = DecompressionMethods.Deflate,
2013-02-21 01:33:05 +00:00
CachePolicy = new RequestCachePolicy(RequestCacheLevel.Revalidate)
};
client = new HttpClient(handler);
client.DefaultRequestHeaders.Add("Accept", "application/json,image/*");
client.Timeout = TimeSpan.FromSeconds(15);
_httpClients.TryAdd(host, client);
}
return client;
}
/// <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>
/// <exception cref="MediaBrowser.Model.Net.HttpException"></exception>
public async Task<Stream> Get(string url, SemaphoreSlim resourcePool, CancellationToken cancellationToken)
{
ValidateParams(url, cancellationToken);
2013-02-21 01:33:05 +00:00
cancellationToken.ThrowIfCancellationRequested();
if (resourcePool != null)
{
await resourcePool.WaitAsync(cancellationToken).ConfigureAwait(false);
}
2013-02-21 01:33:05 +00:00
2013-02-26 21:05:52 +00:00
_logger.Info("HttpClientManager.Get url: {0}", url);
2013-02-21 01:33:05 +00:00
try
{
cancellationToken.ThrowIfCancellationRequested();
var msg = await GetHttpClient(GetHostFromUrl(url)).GetAsync(url, cancellationToken).ConfigureAwait(false);
EnsureSuccessStatusCode(msg);
return await msg.Content.ReadAsStreamAsync().ConfigureAwait(false);
}
catch (OperationCanceledException ex)
{
throw GetCancellationException(url, cancellationToken, ex);
}
catch (HttpRequestException ex)
{
2013-02-21 21:39:53 +00:00
_logger.ErrorException("Error getting response from " + url, ex);
2013-02-21 01:33:05 +00:00
throw new HttpException(ex.Message, ex);
}
finally
{
if (resourcePool != null)
{
resourcePool.Release();
}
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>
/// <exception cref="System.ArgumentNullException">postData</exception>
/// <exception cref="MediaBrowser.Model.Net.HttpException"></exception>
public async Task<Stream> Post(string url, Dictionary<string, string> postData, SemaphoreSlim resourcePool, CancellationToken cancellationToken)
{
ValidateParams(url, cancellationToken);
2013-02-21 01:33:05 +00:00
if (postData == null)
{
throw new ArgumentNullException("postData");
}
cancellationToken.ThrowIfCancellationRequested();
var strings = postData.Keys.Select(key => string.Format("{0}={1}", key, postData[key]));
var postContent = string.Join("&", strings.ToArray());
var content = new StringContent(postContent, Encoding.UTF8, "application/x-www-form-urlencoded");
if (resourcePool != null)
{
await resourcePool.WaitAsync(cancellationToken).ConfigureAwait(false);
}
2013-02-21 01:33:05 +00:00
2013-02-26 21:05:52 +00:00
_logger.Info("HttpClientManager.Post url: {0}", url);
2013-02-21 01:33:05 +00:00
try
{
cancellationToken.ThrowIfCancellationRequested();
var msg = await GetHttpClient(GetHostFromUrl(url)).PostAsync(url, content, cancellationToken).ConfigureAwait(false);
EnsureSuccessStatusCode(msg);
return await msg.Content.ReadAsStreamAsync().ConfigureAwait(false);
}
catch (OperationCanceledException ex)
{
throw GetCancellationException(url, cancellationToken, ex);
}
catch (HttpRequestException ex)
{
2013-02-21 21:39:53 +00:00
_logger.ErrorException("Error getting response from " + url, ex);
2013-02-21 01:33:05 +00:00
throw new HttpException(ex.Message, ex);
}
finally
{
if (resourcePool != null)
{
resourcePool.Release();
}
2013-02-21 01:33:05 +00:00
}
}
/// <summary>
/// Downloads the contents of a given url into a temporary location
/// </summary>
/// <param name="url">The URL.</param>
/// <param name="resourcePool">The resource pool.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <param name="progress">The progress.</param>
/// <param name="userAgent">The user agent.</param>
/// <returns>Task{System.String}.</returns>
/// <exception cref="System.ArgumentNullException">progress</exception>
/// <exception cref="MediaBrowser.Model.Net.HttpException"></exception>
2013-02-25 00:13:45 +00:00
public async Task<string> GetTempFile(string url, SemaphoreSlim resourcePool, CancellationToken cancellationToken, IProgress<double> progress, string userAgent = null)
2013-02-21 01:33:05 +00:00
{
ValidateParams(url, cancellationToken);
2013-02-21 01:33:05 +00:00
if (progress == null)
{
throw new ArgumentNullException("progress");
}
cancellationToken.ThrowIfCancellationRequested();
2013-02-25 00:13:45 +00:00
var tempFile = Path.Combine(_appPaths.TempDirectory, Guid.NewGuid() + ".tmp");
2013-02-21 01:33:05 +00:00
var message = new HttpRequestMessage(HttpMethod.Get, url);
if (!string.IsNullOrEmpty(userAgent))
{
message.Headers.Add("User-Agent", userAgent);
}
if (resourcePool != null)
{
await resourcePool.WaitAsync(cancellationToken).ConfigureAwait(false);
}
2013-02-21 01:33:05 +00:00
2013-02-26 21:05:52 +00:00
_logger.Info("HttpClientManager.GetTempFile url: {0}, temp file: {1}", url, tempFile);
2013-02-21 01:33:05 +00:00
try
{
cancellationToken.ThrowIfCancellationRequested();
using (var response = await GetHttpClient(GetHostFromUrl(url)).SendAsync(message, HttpCompletionOption.ResponseHeadersRead, cancellationToken).ConfigureAwait(false))
{
EnsureSuccessStatusCode(response);
cancellationToken.ThrowIfCancellationRequested();
IEnumerable<string> lengthValues;
if (!response.Headers.TryGetValues("content-length", out lengthValues) &&
!response.Content.Headers.TryGetValues("content-length", out lengthValues))
{
// We're not able to track progress
using (var stream = await response.Content.ReadAsStreamAsync().ConfigureAwait(false))
{
using (var fs = new FileStream(tempFile, FileMode.Create, FileAccess.Write, FileShare.Read, StreamDefaults.DefaultFileStreamBufferSize, FileOptions.Asynchronous))
{
await stream.CopyToAsync(fs, StreamDefaults.DefaultCopyToBufferSize, cancellationToken).ConfigureAwait(false);
}
}
}
else
{
var length = long.Parse(string.Join(string.Empty, lengthValues.ToArray()));
using (var stream = ProgressStream.CreateReadProgressStream(await response.Content.ReadAsStreamAsync().ConfigureAwait(false), progress.Report, length))
{
using (var fs = new FileStream(tempFile, FileMode.Create, FileAccess.Write, FileShare.Read, StreamDefaults.DefaultFileStreamBufferSize, FileOptions.Asynchronous))
{
await stream.CopyToAsync(fs, StreamDefaults.DefaultCopyToBufferSize, cancellationToken).ConfigureAwait(false);
}
}
}
progress.Report(100);
cancellationToken.ThrowIfCancellationRequested();
}
return tempFile;
}
catch (OperationCanceledException ex)
{
// Cleanup
if (File.Exists(tempFile))
{
File.Delete(tempFile);
}
throw GetCancellationException(url, cancellationToken, ex);
}
catch (HttpRequestException ex)
{
2013-02-21 21:39:53 +00:00
_logger.ErrorException("Error getting response from " + url, ex);
2013-02-21 01:33:05 +00:00
// Cleanup
if (File.Exists(tempFile))
{
File.Delete(tempFile);
}
throw new HttpException(ex.Message, ex);
}
catch (Exception ex)
{
2013-02-21 21:39:53 +00:00
_logger.ErrorException("Error getting response from " + url, ex);
2013-02-21 01:33:05 +00:00
// Cleanup
if (File.Exists(tempFile))
{
File.Delete(tempFile);
}
throw;
}
finally
{
if (resourcePool != null)
{
resourcePool.Release();
}
2013-02-21 01:33:05 +00:00
}
}
/// <summary>
/// Downloads the contents of a given url into a MemoryStream
/// </summary>
/// <param name="url">The URL.</param>
/// <param name="resourcePool">The resource pool.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{MemoryStream}.</returns>
/// <exception cref="MediaBrowser.Model.Net.HttpException"></exception>
2013-02-25 00:13:45 +00:00
public async Task<MemoryStream> GetMemoryStream(string url, SemaphoreSlim resourcePool, CancellationToken cancellationToken)
2013-02-21 01:33:05 +00:00
{
ValidateParams(url, cancellationToken);
2013-02-21 01:33:05 +00:00
cancellationToken.ThrowIfCancellationRequested();
var message = new HttpRequestMessage(HttpMethod.Get, url);
if (resourcePool != null)
{
await resourcePool.WaitAsync(cancellationToken).ConfigureAwait(false);
}
2013-02-21 01:33:05 +00:00
var ms = new MemoryStream();
2013-02-26 21:05:52 +00:00
_logger.Info("HttpClientManager.GetMemoryStream url: {0}", url);
2013-02-21 01:33:05 +00:00
try
{
cancellationToken.ThrowIfCancellationRequested();
using (var response = await GetHttpClient(GetHostFromUrl(url)).SendAsync(message, HttpCompletionOption.ResponseHeadersRead, cancellationToken).ConfigureAwait(false))
{
EnsureSuccessStatusCode(response);
cancellationToken.ThrowIfCancellationRequested();
using (var stream = await response.Content.ReadAsStreamAsync().ConfigureAwait(false))
{
await stream.CopyToAsync(ms, StreamDefaults.DefaultCopyToBufferSize, cancellationToken).ConfigureAwait(false);
}
cancellationToken.ThrowIfCancellationRequested();
}
ms.Position = 0;
return ms;
}
catch (OperationCanceledException ex)
{
ms.Dispose();
throw GetCancellationException(url, cancellationToken, ex);
}
catch (HttpRequestException ex)
{
2013-02-21 21:39:53 +00:00
_logger.ErrorException("Error getting response from " + url, ex);
2013-02-21 01:33:05 +00:00
ms.Dispose();
throw new HttpException(ex.Message, ex);
}
catch (Exception ex)
{
2013-02-21 21:39:53 +00:00
_logger.ErrorException("Error getting response from " + url, ex);
2013-02-21 01:33:05 +00:00
ms.Dispose();
throw;
}
finally
{
if (resourcePool != null)
{
resourcePool.Release();
}
2013-02-21 01:33:05 +00:00
}
}
/// <summary>
/// Validates the params.
/// </summary>
/// <param name="url">The URL.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <exception cref="System.ArgumentNullException">url</exception>
private void ValidateParams(string url, CancellationToken cancellationToken)
2013-02-21 01:33:05 +00:00
{
if (string.IsNullOrEmpty(url))
{
throw new ArgumentNullException("url");
}
if (cancellationToken == null)
{
throw new ArgumentNullException("cancellationToken");
}
}
/// <summary>
/// Gets the host from URL.
/// </summary>
/// <param name="url">The URL.</param>
/// <returns>System.String.</returns>
private string GetHostFromUrl(string url)
{
var start = url.IndexOf("://", StringComparison.OrdinalIgnoreCase) + 3;
var len = url.IndexOf('/', start) - start;
return url.Substring(start, len);
}
/// <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)
{
foreach (var client in _httpClients.Values.ToList())
{
client.Dispose();
}
_httpClients.Clear();
}
}
/// <summary>
/// Throws the cancellation exception.
/// </summary>
/// <param name="url">The URL.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <param name="exception">The exception.</param>
/// <returns>Exception.</returns>
private Exception GetCancellationException(string url, CancellationToken cancellationToken, OperationCanceledException exception)
{
// If the HttpClient's timeout is reached, it will cancel the Task internally
if (!cancellationToken.IsCancellationRequested)
{
var msg = string.Format("Connection to {0} timed out", url);
2013-02-21 21:39:53 +00:00
_logger.Error(msg);
2013-02-21 01:33:05 +00:00
// Throw an HttpException so that the caller doesn't think it was cancelled by user code
return new HttpException(msg, exception) { IsTimedOut = true };
}
return exception;
}
/// <summary>
/// Ensures the success status code.
/// </summary>
/// <param name="response">The response.</param>
/// <exception cref="MediaBrowser.Model.Net.HttpException"></exception>
private void EnsureSuccessStatusCode(HttpResponseMessage response)
{
if (!response.IsSuccessStatusCode)
{
throw new HttpException(response.ReasonPhrase) { StatusCode = response.StatusCode };
}
}
/// <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>
/// 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);
}
/// <summary>
/// Gets the temp file.
/// </summary>
/// <param name="url">The URL.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <param name="progress">The progress.</param>
/// <param name="userAgent">The user agent.</param>
/// <returns>Task{System.String}.</returns>
public Task<string> GetTempFile(string url, CancellationToken cancellationToken, IProgress<double> progress, string userAgent = null)
{
return GetTempFile(url, null, cancellationToken, progress, userAgent);
}
/// <summary>
/// Gets the memory stream.
/// </summary>
/// <param name="url">The URL.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{MemoryStream}.</returns>
public Task<MemoryStream> GetMemoryStream(string url, CancellationToken cancellationToken)
{
return GetMemoryStream(url, null, cancellationToken);
}
2013-02-21 01:33:05 +00:00
}
}