jellyfin/Emby.Server.Implementations/HttpClientManager/HttpClientManager.cs

340 lines
12 KiB
C#
Raw Normal View History

using System;
2016-10-29 05:40:15 +00:00
using System.Collections.Concurrent;
2019-07-02 19:47:36 +00:00
using System.Globalization;
2016-10-29 05:40:15 +00:00
using System.IO;
using System.Linq;
using System.Net;
using System.Net.Http;
2016-10-29 05:40:15 +00:00
using System.Threading.Tasks;
using MediaBrowser.Common.Configuration;
using MediaBrowser.Common.Extensions;
using MediaBrowser.Common.Net;
2016-10-29 05:40:15 +00:00
using MediaBrowser.Model.IO;
using MediaBrowser.Model.Net;
using Microsoft.Extensions.Logging;
using Microsoft.Net.Http.Headers;
2016-10-29 05:40:15 +00:00
namespace Emby.Server.Implementations.HttpClientManager
2016-10-29 05:40:15 +00:00
{
/// <summary>
/// Class HttpClientManager.
2016-10-29 05:40:15 +00:00
/// </summary>
public class HttpClientManager : IHttpClient
{
private readonly ILogger _logger;
private readonly IApplicationPaths _appPaths;
private readonly IFileSystem _fileSystem;
2017-02-09 03:58:04 +00:00
private readonly Func<string> _defaultUserAgentFn;
2016-10-29 05:40:15 +00:00
2019-07-01 17:24:42 +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>();
2016-10-29 05:40:15 +00:00
/// <summary>
/// Initializes a new instance of the <see cref="HttpClientManager" /> class.
/// </summary>
public HttpClientManager(
IApplicationPaths appPaths,
2019-06-14 14:32:37 +00:00
ILogger<HttpClientManager> logger,
IFileSystem fileSystem,
Func<string> defaultUserAgentFn)
2016-10-29 05:40:15 +00:00
{
_logger = logger ?? throw new ArgumentNullException(nameof(logger));
2016-10-29 05:40:15 +00:00
_fileSystem = fileSystem;
_appPaths = appPaths ?? throw new ArgumentNullException(nameof(appPaths));
2017-02-09 03:58:04 +00:00
_defaultUserAgentFn = defaultUserAgentFn;
2016-10-29 05:40:15 +00:00
}
/// <summary>
2019-07-01 17:24:42 +00:00
/// Gets the correct http client for the given url.
2016-10-29 05:40:15 +00:00
/// </summary>
2019-07-01 17:24:42 +00:00
/// <param name="url">The url.</param>
2016-10-29 05:40:15 +00:00
/// <returns>HttpClient.</returns>
2019-06-14 14:32:37 +00:00
private HttpClient GetHttpClient(string url)
2016-10-29 05:40:15 +00:00
{
2019-06-14 14:32:37 +00:00
var key = GetHostFromUrl(url);
2016-10-29 05:40:15 +00:00
if (!_httpClients.TryGetValue(key, out var client))
2016-10-29 05:40:15 +00:00
{
client = new HttpClient()
{
BaseAddress = new Uri(url)
};
2016-10-29 05:40:15 +00:00
_httpClients.TryAdd(key, client);
}
return client;
}
private HttpRequestMessage GetRequestMessage(HttpRequestOptions options, HttpMethod method)
2016-10-29 05:40:15 +00:00
{
2018-12-30 12:01:52 +00:00
string url = options.Url;
2019-01-13 20:37:13 +00:00
var uriAddress = new Uri(url);
2018-12-30 12:01:52 +00:00
string userInfo = uriAddress.UserInfo;
2016-10-29 05:40:15 +00:00
if (!string.IsNullOrWhiteSpace(userInfo))
{
_logger.LogWarning("Found userInfo in url: {0} ... url: {1}", userInfo, url);
url = url.Replace(userInfo + '@', string.Empty, StringComparison.Ordinal);
2016-10-29 05:40:15 +00:00
}
var request = new HttpRequestMessage(method, url);
2016-10-29 05:40:15 +00:00
2019-09-08 19:07:29 +00:00
foreach (var header in options.RequestHeaders)
{
request.Headers.TryAddWithoutValidation(header.Key, header.Value);
}
if (options.EnableDefaultUserAgent
&& !request.Headers.TryGetValues(HeaderNames.UserAgent, out _))
{
request.Headers.Add(HeaderNames.UserAgent, _defaultUserAgentFn());
}
2016-10-29 05:40:15 +00:00
2019-06-14 14:32:37 +00:00
switch (options.DecompressionMethod)
{
2019-06-14 14:32:37 +00:00
case CompressionMethod.Deflate | CompressionMethod.Gzip:
request.Headers.Add(HeaderNames.AcceptEncoding, new[] { "gzip", "deflate" });
2019-06-14 14:32:37 +00:00
break;
case CompressionMethod.Deflate:
request.Headers.Add(HeaderNames.AcceptEncoding, "deflate");
2019-06-14 14:32:37 +00:00
break;
case CompressionMethod.Gzip:
request.Headers.Add(HeaderNames.AcceptEncoding, "gzip");
break;
default:
break;
}
2016-10-29 05:40:15 +00:00
if (options.EnableKeepAlive)
{
request.Headers.Add(HeaderNames.Connection, "Keep-Alive");
}
2016-10-29 05:40:15 +00:00
// request.Headers.Add(HeaderNames.CacheControl, "no-cache");
/*
2016-10-29 05:40:15 +00:00
if (!string.IsNullOrWhiteSpace(userInfo))
{
var parts = userInfo.Split(':');
if (parts.Length == 2)
{
request.Headers.Add(HeaderNames., GetCredential(url, parts[0], parts[1]);
2016-10-29 05:40:15 +00:00
}
}
*/
2016-10-29 05:40:15 +00:00
return request;
}
/// <summary>
/// Gets the response internal.
/// </summary>
/// <param name="options">The options.</param>
/// <returns>Task{HttpResponseInfo}.</returns>
public Task<HttpResponseInfo> GetResponse(HttpRequestOptions options)
2019-06-14 14:32:37 +00:00
=> SendAsync(options, HttpMethod.Get);
2016-10-29 05:40:15 +00:00
/// <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>
/// send as an asynchronous operation.
/// </summary>
/// <param name="options">The options.</param>
/// <param name="httpMethod">The HTTP method.</param>
/// <returns>Task{HttpResponseInfo}.</returns>
public Task<HttpResponseInfo> SendAsync(HttpRequestOptions options, string httpMethod)
=> SendAsync(options, new HttpMethod(httpMethod));
/// <summary>
/// send as an asynchronous operation.
/// </summary>
/// <param name="options">The options.</param>
/// <param name="httpMethod">The HTTP method.</param>
/// <returns>Task{HttpResponseInfo}.</returns>
public async Task<HttpResponseInfo> SendAsync(HttpRequestOptions options, HttpMethod httpMethod)
2016-10-29 05:40:15 +00:00
{
if (options.CacheMode == CacheMode.None)
{
return await SendAsyncInternal(options, httpMethod).ConfigureAwait(false);
}
var url = options.Url;
var urlHash = url.ToUpperInvariant().GetMD5().ToString("N", CultureInfo.InvariantCulture);
2016-10-29 05:40:15 +00:00
var responseCachePath = Path.Combine(_appPaths.CachePath, "httpclient", urlHash);
var response = GetCachedResponse(responseCachePath, options.CacheLength, url);
2016-10-29 05:40:15 +00:00
if (response != null)
{
return response;
}
response = await SendAsyncInternal(options, httpMethod).ConfigureAwait(false);
if (response.StatusCode == HttpStatusCode.OK)
{
await CacheResponse(response, responseCachePath).ConfigureAwait(false);
}
return response;
}
private HttpResponseInfo GetCachedResponse(string responseCachePath, TimeSpan cacheLength, string url)
2016-10-29 05:40:15 +00:00
{
if (File.Exists(responseCachePath)
&& _fileSystem.GetLastWriteTimeUtc(responseCachePath).Add(cacheLength) > DateTime.UtcNow)
2016-10-29 05:40:15 +00:00
{
2020-01-08 16:52:50 +00:00
var stream = new FileStream(responseCachePath, FileMode.Open, FileAccess.Read, FileShare.Read, IODefaults.FileStreamBufferSize, true);
2016-10-29 05:40:15 +00:00
return new HttpResponseInfo
{
ResponseUrl = url,
Content = stream,
StatusCode = HttpStatusCode.OK,
ContentLength = stream.Length
};
2016-10-29 05:40:15 +00:00
}
return null;
}
private async Task CacheResponse(HttpResponseInfo response, string responseCachePath)
{
Directory.CreateDirectory(Path.GetDirectoryName(responseCachePath));
2016-10-29 05:40:15 +00:00
using (var fileStream = new FileStream(
responseCachePath,
FileMode.Create,
FileAccess.Write,
FileShare.None,
2020-01-08 16:52:50 +00:00
IODefaults.FileStreamBufferSize,
true))
2016-10-29 05:40:15 +00:00
{
await response.Content.CopyToAsync(fileStream).ConfigureAwait(false);
2016-10-29 05:40:15 +00:00
response.Content.Position = 0;
2016-10-29 05:40:15 +00:00
}
}
private async Task<HttpResponseInfo> SendAsyncInternal(HttpRequestOptions options, HttpMethod httpMethod)
2016-10-29 05:40:15 +00:00
{
ValidateParams(options);
options.CancellationToken.ThrowIfCancellationRequested();
2019-06-14 14:32:37 +00:00
var client = GetHttpClient(options.Url);
2016-10-29 05:40:15 +00:00
var httpWebRequest = GetRequestMessage(options, httpMethod);
2016-10-29 05:40:15 +00:00
2019-06-14 14:32:37 +00:00
if (options.RequestContentBytes != null
|| !string.IsNullOrEmpty(options.RequestContent)
|| httpMethod == HttpMethod.Post)
2016-10-29 05:40:15 +00:00
{
2019-06-14 15:31:56 +00:00
if (options.RequestContentBytes != null)
{
httpWebRequest.Content = new ByteArrayContent(options.RequestContentBytes);
}
else if (options.RequestContent != null)
{
2019-07-07 16:04:06 +00:00
httpWebRequest.Content = new StringContent(
options.RequestContent,
null,
options.RequestContentType);
2017-02-09 23:25:10 +00:00
}
2019-06-14 15:31:56 +00:00
else
{
httpWebRequest.Content = new ByteArrayContent(Array.Empty<byte>());
}
2016-10-29 05:40:15 +00:00
}
2019-06-14 15:31:56 +00:00
options.CancellationToken.ThrowIfCancellationRequested();
2016-10-29 05:40:15 +00:00
var response = await client.SendAsync(
httpWebRequest,
options.BufferContent || options.CacheMode == CacheMode.Unconditional ? HttpCompletionOption.ResponseContentRead : HttpCompletionOption.ResponseHeadersRead,
options.CancellationToken).ConfigureAwait(false);
2016-10-29 05:40:15 +00:00
await EnsureSuccessStatusCode(response, options).ConfigureAwait(false);
2016-10-29 05:40:15 +00:00
options.CancellationToken.ThrowIfCancellationRequested();
2016-10-29 05:40:15 +00:00
var stream = await response.Content.ReadAsStreamAsync().ConfigureAwait(false);
return new HttpResponseInfo(response.Headers, response.Content.Headers)
2016-10-29 05:40:15 +00:00
{
Content = stream,
StatusCode = response.StatusCode,
ContentType = response.Content.Headers.ContentType?.MediaType,
ContentLength = response.Content.Headers.ContentLength,
ResponseUrl = response.Content.Headers.ContentLocation?.ToString()
};
2016-10-29 05:40:15 +00:00
}
2019-11-01 17:38:54 +00:00
/// <inheritdoc />
2016-10-29 05:40:15 +00:00
public Task<HttpResponseInfo> Post(HttpRequestOptions options)
2019-06-14 14:32:37 +00:00
=> SendAsync(options, HttpMethod.Post);
2016-10-29 05:40:15 +00:00
private void ValidateParams(HttpRequestOptions options)
{
if (string.IsNullOrEmpty(options.Url))
{
throw new ArgumentNullException(nameof(options));
2016-10-29 05:40:15 +00:00
}
}
/// <summary>
/// Gets the host from URL.
/// </summary>
/// <param name="url">The URL.</param>
/// <returns>System.String.</returns>
private static string GetHostFromUrl(string url)
2016-10-29 05:40:15 +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;
}
private async Task EnsureSuccessStatusCode(HttpResponseMessage response, HttpRequestOptions options)
2016-10-29 05:40:15 +00:00
{
if (response.IsSuccessStatusCode)
{
return;
}
if (options.LogErrorResponseBody)
{
2019-11-01 19:24:16 +00:00
string msg = await response.Content.ReadAsStringAsync().ConfigureAwait(false);
_logger.LogError("HTTP request failed with message: {Message}", msg);
}
throw new HttpException(response.ReasonPhrase)
{
StatusCode = response.StatusCode
};
2016-10-29 05:40:15 +00:00
}
}
}