jellyfin/Emby.Server.Implementations/HttpServer/HttpResultFactory.cs

798 lines
29 KiB
C#
Raw Normal View History

using MediaBrowser.Common.Extensions;
2013-12-07 15:52:38 +00:00
using MediaBrowser.Controller.Net;
using Microsoft.Extensions.Logging;
using MediaBrowser.Model.Serialization;
using System;
using System.Collections.Generic;
using System.Globalization;
2013-03-08 17:25:25 +00:00
using System.IO;
2018-09-12 17:26:21 +00:00
using System.IO.Compression;
using System.Net;
2016-11-10 14:41:24 +00:00
using System.Runtime.Serialization;
2013-03-25 12:46:38 +00:00
using System.Text;
using System.Threading.Tasks;
2016-11-10 14:41:24 +00:00
using System.Xml;
2017-02-13 01:07:48 +00:00
using Emby.Server.Implementations.Services;
2016-10-25 19:02:04 +00:00
using MediaBrowser.Model.IO;
using MediaBrowser.Model.Services;
using IRequest = MediaBrowser.Model.Services.IRequest;
2014-12-26 17:45:06 +00:00
using MimeTypes = MediaBrowser.Model.Net.MimeTypes;
2013-03-08 17:25:25 +00:00
2016-11-11 01:37:20 +00:00
namespace Emby.Server.Implementations.HttpServer
2013-03-08 17:25:25 +00:00
{
/// <summary>
/// Class HttpResultFactory
/// </summary>
2013-03-08 17:25:25 +00:00
public class HttpResultFactory : IHttpResultFactory
{
/// <summary>
/// The _logger
/// </summary>
private readonly ILogger _logger;
private readonly IFileSystem _fileSystem;
private readonly IJsonSerializer _jsonSerializer;
2018-09-12 17:26:21 +00:00
private IBrotliCompressor _brotliCompressor;
/// <summary>
/// Initializes a new instance of the <see cref="HttpResultFactory" /> class.
/// </summary>
public HttpResultFactory(ILoggerFactory loggerfactory, IFileSystem fileSystem, IJsonSerializer jsonSerializer, IBrotliCompressor brotliCompressor)
{
_fileSystem = fileSystem;
_jsonSerializer = jsonSerializer;
2018-09-12 17:26:21 +00:00
_brotliCompressor = brotliCompressor;
_logger = loggerfactory.CreateLogger("HttpResultFactory");
}
/// <summary>
/// Gets the result.
/// </summary>
/// <param name="content">The content.</param>
/// <param name="contentType">Type of the content.</param>
/// <param name="responseHeaders">The response headers.</param>
/// <returns>System.Object.</returns>
2018-09-12 17:26:21 +00:00
public object GetResult(IRequest requestContext, byte[] content, string contentType, IDictionary<string, string> responseHeaders = null)
{
return GetHttpResult(requestContext, content, contentType, true, responseHeaders);
}
public object GetResult(string content, string contentType, IDictionary<string, string> responseHeaders = null)
{
2018-09-12 17:26:21 +00:00
return GetHttpResult(null, content, contentType, true, responseHeaders);
}
public object GetResult(IRequest requestContext, Stream content, string contentType, IDictionary<string, string> responseHeaders = null)
{
return GetHttpResult(requestContext, content, contentType, true, responseHeaders);
}
public object GetResult(IRequest requestContext, string content, string contentType, IDictionary<string, string> responseHeaders = null)
{
return GetHttpResult(requestContext, content, contentType, true, responseHeaders);
2013-03-25 02:41:27 +00:00
}
2017-05-31 19:21:32 +00:00
public object GetRedirectResult(string url)
{
var responseHeaders = new Dictionary<string, string>();
responseHeaders["Location"] = url;
2018-09-12 17:26:21 +00:00
var result = new HttpResult(Array.Empty<byte>(), "text/plain", HttpStatusCode.Redirect);
2017-05-31 19:21:32 +00:00
AddResponseHeaders(result, responseHeaders);
return result;
}
2013-03-25 02:41:27 +00:00
/// <summary>
/// Gets the HTTP result.
/// </summary>
2018-09-12 17:26:21 +00:00
private IHasHeaders GetHttpResult(IRequest requestContext, Stream content, string contentType, bool addCachePrevention, IDictionary<string, string> responseHeaders = null)
2013-03-25 02:41:27 +00:00
{
2018-09-12 17:26:21 +00:00
var result = new StreamWriter(content, contentType, _logger);
2013-03-25 02:41:27 +00:00
2018-09-12 17:26:21 +00:00
if (responseHeaders == null)
{
responseHeaders = new Dictionary<string, string>();
}
2013-03-25 02:41:27 +00:00
2018-09-12 17:26:21 +00:00
string expires;
if (addCachePrevention && !responseHeaders.TryGetValue("Expires", out expires))
2013-03-25 02:41:27 +00:00
{
2018-09-12 17:26:21 +00:00
responseHeaders["Expires"] = "-1";
2013-03-25 02:41:27 +00:00
}
2018-09-12 17:26:21 +00:00
AddResponseHeaders(result, responseHeaders);
return result;
}
/// <summary>
/// Gets the HTTP result.
/// </summary>
private IHasHeaders GetHttpResult(IRequest requestContext, byte[] content, string contentType, bool addCachePrevention, IDictionary<string, string> responseHeaders = null)
{
2018-12-29 16:26:36 +00:00
string compressionType = null;
bool isHeadRequest = false;
2018-09-12 17:26:21 +00:00
2018-12-29 16:26:36 +00:00
if (requestContext != null) {
compressionType = GetCompressionType(requestContext, content, contentType);
isHeadRequest = string.Equals(requestContext.Verb, "head", StringComparison.OrdinalIgnoreCase);
}
2018-09-12 17:26:21 +00:00
2018-12-29 16:26:36 +00:00
IHasHeaders result;
2018-09-12 17:26:21 +00:00
if (string.IsNullOrEmpty(compressionType))
2013-03-25 02:41:27 +00:00
{
2018-09-12 17:26:21 +00:00
var contentLength = content.Length;
2013-03-25 02:41:27 +00:00
2018-09-12 17:26:21 +00:00
if (isHeadRequest)
2013-03-25 02:41:27 +00:00
{
2018-09-12 17:26:21 +00:00
content = Array.Empty<byte>();
2013-03-25 02:41:27 +00:00
}
2013-03-25 12:46:38 +00:00
2018-09-12 17:26:21 +00:00
result = new StreamWriter(content, contentType, contentLength, _logger);
}
else
{
result = GetCompressedResult(content, compressionType, responseHeaders, isHeadRequest, contentType);
}
if (responseHeaders == null)
{
responseHeaders = new Dictionary<string, string>();
}
string expires;
if (addCachePrevention && !responseHeaders.TryGetValue("Expires", out expires))
{
responseHeaders["Expires"] = "-1";
}
AddResponseHeaders(result, responseHeaders);
return result;
}
/// <summary>
/// Gets the HTTP result.
/// </summary>
private IHasHeaders GetHttpResult(IRequest requestContext, string content, string contentType, bool addCachePrevention, IDictionary<string, string> responseHeaders = null)
{
IHasHeaders result;
var bytes = Encoding.UTF8.GetBytes(content);
var compressionType = requestContext == null ? null : GetCompressionType(requestContext, bytes, contentType);
var isHeadRequest = requestContext == null ? false : string.Equals(requestContext.Verb, "head", StringComparison.OrdinalIgnoreCase);
if (string.IsNullOrEmpty(compressionType))
{
var contentLength = bytes.Length;
if (isHeadRequest)
{
bytes = Array.Empty<byte>();
2013-03-25 02:41:27 +00:00
}
2018-09-12 17:26:21 +00:00
result = new StreamWriter(bytes, contentType, contentLength, _logger);
2013-03-25 02:41:27 +00:00
}
2018-09-12 17:26:21 +00:00
else
{
result = GetCompressedResult(bytes, compressionType, responseHeaders, isHeadRequest, contentType);
}
2016-10-02 02:09:33 +00:00
if (responseHeaders == null)
{
2016-10-02 02:09:33 +00:00
responseHeaders = new Dictionary<string, string>();
}
2013-09-15 17:34:37 +00:00
string expires;
if (addCachePrevention && !responseHeaders.TryGetValue("Expires", out expires))
2016-11-12 06:58:50 +00:00
{
responseHeaders["Expires"] = "-1";
}
2016-10-02 02:09:33 +00:00
AddResponseHeaders(result, responseHeaders);
return result;
}
/// <summary>
/// Gets the optimized result.
/// </summary>
/// <typeparam name="T"></typeparam>
2018-09-12 17:26:21 +00:00
public object GetResult<T>(IRequest requestContext, T result, IDictionary<string, string> responseHeaders = null)
where T : class
{
if (result == null)
{
throw new ArgumentNullException("result");
}
2015-12-01 05:22:52 +00:00
if (responseHeaders == null)
{
2015-12-01 05:22:52 +00:00
responseHeaders = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
}
2018-09-12 17:26:21 +00:00
responseHeaders["Expires"] = "-1";
return ToOptimizedResultInternal(requestContext, result, responseHeaders);
}
private string GetCompressionType(IRequest request, byte[] content, string responseContentType)
{
if (responseContentType == null)
2015-12-01 05:22:52 +00:00
{
2018-09-12 17:26:21 +00:00
return null;
2015-12-01 05:22:52 +00:00
}
2018-09-12 17:26:21 +00:00
// Per apple docs, hls manifests must be compressed
if (!responseContentType.StartsWith("text/", StringComparison.OrdinalIgnoreCase) &&
responseContentType.IndexOf("json", StringComparison.OrdinalIgnoreCase) == -1 &&
responseContentType.IndexOf("javascript", StringComparison.OrdinalIgnoreCase) == -1 &&
responseContentType.IndexOf("xml", StringComparison.OrdinalIgnoreCase) == -1 &&
responseContentType.IndexOf("application/x-mpegURL", StringComparison.OrdinalIgnoreCase) == -1)
{
return null;
}
if (content.Length < 1024)
{
return null;
}
return GetCompressionType(request);
}
2016-11-10 14:41:24 +00:00
2018-09-12 17:26:21 +00:00
private string GetCompressionType(IRequest request)
2016-11-10 14:41:24 +00:00
{
2016-11-11 01:37:20 +00:00
var acceptEncoding = request.Headers["Accept-Encoding"];
2016-11-10 14:41:24 +00:00
2018-09-12 17:26:21 +00:00
if (acceptEncoding != null)
2016-11-11 01:37:20 +00:00
{
2018-09-12 17:26:21 +00:00
//if (_brotliCompressor != null && acceptEncoding.IndexOf("br", StringComparison.OrdinalIgnoreCase) != -1)
// return "br";
if (acceptEncoding.IndexOf("deflate", StringComparison.OrdinalIgnoreCase) != -1)
2016-11-11 01:37:20 +00:00
return "deflate";
2016-11-10 14:41:24 +00:00
2018-09-12 17:26:21 +00:00
if (acceptEncoding.IndexOf("gzip", StringComparison.OrdinalIgnoreCase) != -1)
2016-11-11 01:37:20 +00:00
return "gzip";
}
2016-11-10 14:41:24 +00:00
return null;
}
/// <summary>
/// Returns the optimized result for the IRequestContext.
/// Does not use or store results in any cache.
/// </summary>
/// <param name="request"></param>
/// <param name="dto"></param>
/// <returns></returns>
public object ToOptimizedResult<T>(IRequest request, T dto)
2017-09-28 17:05:10 +00:00
{
2018-09-12 17:26:21 +00:00
return ToOptimizedResultInternal(request, dto);
2017-09-28 17:05:10 +00:00
}
private object ToOptimizedResultInternal<T>(IRequest request, T dto, IDictionary<string, string> responseHeaders = null)
2016-11-10 14:41:24 +00:00
{
2017-08-01 16:45:57 +00:00
var contentType = request.ResponseContentType;
2016-11-10 14:41:24 +00:00
2017-08-01 16:45:57 +00:00
switch (GetRealContentType(contentType))
2016-11-10 14:41:24 +00:00
{
2017-08-01 16:45:57 +00:00
case "application/xml":
case "text/xml":
case "text/xml; charset=utf-8": //"text/xml; charset=utf-8" also matches xml
2018-09-12 17:26:21 +00:00
return GetHttpResult(request, SerializeToXmlString(dto), contentType, false, responseHeaders);
2017-02-13 01:07:48 +00:00
2017-08-01 16:45:57 +00:00
case "application/json":
case "text/json":
2018-09-12 17:26:21 +00:00
return GetHttpResult(request, _jsonSerializer.SerializeToString(dto), contentType, false, responseHeaders);
2017-08-01 16:45:57 +00:00
default:
2018-09-12 17:26:21 +00:00
break;
}
2016-11-10 14:41:24 +00:00
2018-09-12 17:26:21 +00:00
var isHeadRequest = string.Equals(request.Verb, "head", StringComparison.OrdinalIgnoreCase);
2016-11-10 14:41:24 +00:00
2018-09-12 17:26:21 +00:00
var ms = new MemoryStream();
var writerFn = RequestHelper.GetResponseWriter(HttpListenerHost.Instance, contentType);
2017-09-28 17:05:10 +00:00
2018-09-12 17:26:21 +00:00
writerFn(dto, ms);
2016-11-10 14:41:24 +00:00
2018-09-12 17:26:21 +00:00
ms.Position = 0;
2016-11-11 01:37:20 +00:00
2018-09-12 17:26:21 +00:00
if (isHeadRequest)
2016-11-10 14:41:24 +00:00
{
2018-09-12 17:26:21 +00:00
using (ms)
2016-11-10 14:41:24 +00:00
{
2018-09-12 17:26:21 +00:00
return GetHttpResult(request, Array.Empty<byte>(), contentType, true, responseHeaders);
2016-11-10 14:41:24 +00:00
}
}
2018-09-12 17:26:21 +00:00
return GetHttpResult(request, ms, contentType, true, responseHeaders);
2016-11-10 14:41:24 +00:00
}
2018-09-12 17:26:21 +00:00
private IHasHeaders GetCompressedResult(byte[] content,
string requestedCompressionType,
IDictionary<string, string> responseHeaders,
bool isHeadRequest,
string contentType)
{
if (responseHeaders == null)
{
2015-12-01 05:22:52 +00:00
responseHeaders = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
}
2018-09-12 17:26:21 +00:00
content = Compress(content, requestedCompressionType);
responseHeaders["Content-Encoding"] = requestedCompressionType;
2018-09-12 17:26:21 +00:00
responseHeaders["Vary"] = "Accept-Encoding";
2018-09-12 17:26:21 +00:00
var contentLength = content.Length;
2018-09-12 17:26:21 +00:00
if (isHeadRequest)
{
2018-09-12 17:26:21 +00:00
var result = new StreamWriter(Array.Empty<byte>(), contentType, contentLength, _logger);
AddResponseHeaders(result, responseHeaders);
return result;
}
2018-09-12 17:26:21 +00:00
else
{
2018-09-12 17:26:21 +00:00
var result = new StreamWriter(content, contentType, contentLength, _logger);
AddResponseHeaders(result, responseHeaders);
return result;
}
2018-09-12 17:26:21 +00:00
}
2018-09-12 17:26:21 +00:00
private byte[] Compress(byte[] bytes, string compressionType)
{
if (string.Equals(compressionType, "br", StringComparison.OrdinalIgnoreCase))
return CompressBrotli(bytes);
2018-09-12 17:26:21 +00:00
if (string.Equals(compressionType, "deflate", StringComparison.OrdinalIgnoreCase))
return Deflate(bytes);
if (string.Equals(compressionType, "gzip", StringComparison.OrdinalIgnoreCase))
return GZip(bytes);
2018-09-12 17:26:21 +00:00
throw new NotSupportedException(compressionType);
}
private byte[] CompressBrotli(byte[] bytes)
{
return _brotliCompressor.Compress(bytes);
}
2018-09-12 17:26:21 +00:00
private byte[] Deflate(byte[] bytes)
{
// In .NET FX incompat-ville, you can't access compressed bytes without closing DeflateStream
// Which means we must use MemoryStream since you have to use ToArray() on a closed Stream
using (var ms = new MemoryStream())
using (var zipStream = new DeflateStream(ms, CompressionMode.Compress))
{
2018-09-12 17:26:21 +00:00
zipStream.Write(bytes, 0, bytes.Length);
zipStream.Dispose();
return ms.ToArray();
}
2018-09-12 17:26:21 +00:00
}
2018-09-12 17:26:21 +00:00
private byte[] GZip(byte[] buffer)
{
using (var ms = new MemoryStream())
using (var zipStream = new GZipStream(ms, CompressionMode.Compress))
{
zipStream.Write(buffer, 0, buffer.Length);
zipStream.Dispose();
2018-09-12 17:26:21 +00:00
return ms.ToArray();
}
}
2018-09-12 17:26:21 +00:00
public static string GetRealContentType(string contentType)
{
return contentType == null
? null
: contentType.Split(';')[0].ToLower().Trim();
}
private string SerializeToXmlString(object from)
{
using (var ms = new MemoryStream())
{
2018-09-12 17:26:21 +00:00
var xwSettings = new XmlWriterSettings();
xwSettings.Encoding = new UTF8Encoding(false);
xwSettings.OmitXmlDeclaration = false;
2018-09-12 17:26:21 +00:00
using (var xw = XmlWriter.Create(ms, xwSettings))
{
var serializer = new DataContractSerializer(from.GetType());
serializer.WriteObject(xw, from);
xw.Flush();
ms.Seek(0, SeekOrigin.Begin);
var reader = new StreamReader(ms);
return reader.ReadToEnd();
}
}
}
/// <summary>
/// Pres the process optimized result.
/// </summary>
2013-12-07 15:52:38 +00:00
private object GetCachedResult(IRequest requestContext, IDictionary<string, string> responseHeaders, Guid cacheKey, string cacheKeyString, DateTime? lastDateModified, TimeSpan? cacheDuration, string contentType)
{
responseHeaders["ETag"] = string.Format("\"{0}\"", cacheKeyString);
2017-05-09 18:51:26 +00:00
var noCache = (requestContext.Headers.Get("Cache-Control") ?? string.Empty).IndexOf("no-cache", StringComparison.OrdinalIgnoreCase) != -1;
if (!noCache)
{
2017-05-09 18:51:26 +00:00
if (IsNotModified(requestContext, cacheKey, lastDateModified, cacheDuration))
{
AddAgeHeader(responseHeaders, lastDateModified);
2017-09-22 20:33:01 +00:00
AddExpiresHeader(responseHeaders, cacheKeyString, cacheDuration);
2018-09-12 17:26:21 +00:00
var result = new HttpResult(Array.Empty<byte>(), contentType ?? "text/html", HttpStatusCode.NotModified);
2017-05-09 18:51:26 +00:00
AddResponseHeaders(result, responseHeaders);
2017-05-09 18:51:26 +00:00
return result;
}
}
2017-09-22 20:33:01 +00:00
AddCachingHeaders(responseHeaders, cacheKeyString, lastDateModified, cacheDuration);
return null;
}
2016-06-19 06:18:29 +00:00
public Task<object> GetStaticFileResult(IRequest requestContext,
2014-08-29 12:14:41 +00:00
string path,
2016-10-25 19:02:04 +00:00
FileShareMode fileShare = FileShareMode.Read)
2013-03-08 17:25:25 +00:00
{
if (string.IsNullOrEmpty(path))
{
throw new ArgumentNullException("path");
}
2014-08-30 14:26:29 +00:00
return GetStaticFileResult(requestContext, new StaticFileResultOptions
{
Path = path,
FileShare = fileShare
});
}
2016-06-19 06:18:29 +00:00
public Task<object> GetStaticFileResult(IRequest requestContext,
2014-08-30 14:26:29 +00:00
StaticFileResultOptions options)
{
2014-08-30 14:26:29 +00:00
var path = options.Path;
var fileShare = options.FileShare;
if (string.IsNullOrEmpty(path))
{
throw new ArgumentNullException("path");
}
2016-10-25 19:02:04 +00:00
if (fileShare != FileShareMode.Read && fileShare != FileShareMode.ReadWrite)
2013-09-15 17:34:37 +00:00
{
throw new ArgumentException("FileShare must be either Read or ReadWrite");
}
2018-09-12 17:26:21 +00:00
if (string.IsNullOrEmpty(options.ContentType))
2014-08-30 14:26:29 +00:00
{
options.ContentType = MimeTypes.GetMimeType(path);
}
2016-07-17 16:59:40 +00:00
if (!options.DateLastModified.HasValue)
{
options.DateLastModified = _fileSystem.GetLastWriteTimeUtc(path);
}
2014-08-30 14:26:29 +00:00
var cacheKey = path + options.DateLastModified.Value.Ticks;
2014-08-30 14:26:29 +00:00
options.CacheKey = cacheKey.GetMD5();
options.ContentFactory = () => Task.FromResult(GetFileStream(path, fileShare));
2017-07-18 17:34:56 +00:00
options.ResponseHeaders = options.ResponseHeaders ?? new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
2014-08-30 14:26:29 +00:00
return GetStaticResult(requestContext, options);
}
/// <summary>
/// Gets the file stream.
/// </summary>
/// <param name="path">The path.</param>
2013-09-15 17:34:37 +00:00
/// <param name="fileShare">The file share.</param>
/// <returns>Stream.</returns>
2016-10-25 19:02:04 +00:00
private Stream GetFileStream(string path, FileShareMode fileShare)
{
2016-10-25 19:02:04 +00:00
return _fileSystem.GetFileStream(path, FileOpenMode.Open, FileAccessMode.Read, fileShare);
}
2016-06-19 06:18:29 +00:00
public Task<object> GetStaticResult(IRequest requestContext,
2014-08-29 12:14:41 +00:00
Guid cacheKey,
DateTime? lastDateModified,
TimeSpan? cacheDuration,
string contentType,
Func<Task<Stream>> factoryFn,
IDictionary<string, string> responseHeaders = null,
bool isHeadRequest = false)
{
2014-08-30 14:26:29 +00:00
return GetStaticResult(requestContext, new StaticResultOptions
{
CacheDuration = cacheDuration,
CacheKey = cacheKey,
ContentFactory = factoryFn,
ContentType = contentType,
DateLastModified = lastDateModified,
IsHeadRequest = isHeadRequest,
ResponseHeaders = responseHeaders
});
2014-08-29 12:14:41 +00:00
}
2016-06-19 06:18:29 +00:00
public async Task<object> GetStaticResult(IRequest requestContext, StaticResultOptions options)
{
2014-08-30 14:26:29 +00:00
var cacheKey = options.CacheKey;
2015-12-01 05:22:52 +00:00
options.ResponseHeaders = options.ResponseHeaders ?? new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
2014-08-30 14:26:29 +00:00
var contentType = options.ContentType;
2018-09-12 17:26:21 +00:00
if (!cacheKey.Equals(Guid.Empty))
{
2018-09-12 17:26:21 +00:00
var key = cacheKey.ToString("N");
2018-09-12 17:26:21 +00:00
// See if the result is already cached in the browser
var result = GetCachedResult(requestContext, options.ResponseHeaders, cacheKey, key, options.DateLastModified, options.CacheDuration, contentType);
2018-09-12 17:26:21 +00:00
if (result != null)
{
return result;
}
}
// TODO: We don't really need the option value
var isHeadRequest = options.IsHeadRequest || string.Equals(requestContext.Verb, "HEAD", StringComparison.OrdinalIgnoreCase);
2014-08-30 14:26:29 +00:00
var factoryFn = options.ContentFactory;
var responseHeaders = options.ResponseHeaders;
2017-08-01 16:45:57 +00:00
//var requestedCompressionType = GetCompressionType(requestContext);
2013-12-07 15:52:38 +00:00
2017-08-01 16:45:57 +00:00
var rangeHeader = requestContext.Headers.Get("Range");
2018-09-12 17:26:21 +00:00
if (!isHeadRequest && !string.IsNullOrEmpty(options.Path))
{
2017-08-30 18:06:54 +00:00
var hasHeaders = new FileWriter(options.Path, contentType, rangeHeader, _logger, _fileSystem)
2017-08-01 16:45:57 +00:00
{
OnComplete = options.OnComplete,
OnError = options.OnError,
FileShare = options.FileShare
};
2017-08-30 18:06:54 +00:00
AddResponseHeaders(hasHeaders, options.ResponseHeaders);
return hasHeaders;
2016-12-22 16:47:43 +00:00
}
2018-09-12 17:26:21 +00:00
var stream = await factoryFn().ConfigureAwait(false);
var totalContentLength = options.ContentLength;
if (!totalContentLength.HasValue)
2016-12-22 16:47:43 +00:00
{
2018-09-12 17:26:21 +00:00
try
{
totalContentLength = stream.Length;
}
catch (NotSupportedException)
{
2016-12-22 16:47:43 +00:00
2018-09-12 17:26:21 +00:00
}
}
if (!string.IsNullOrWhiteSpace(rangeHeader) && totalContentLength.HasValue)
{
var hasHeaders = new RangeRequestWriter(rangeHeader, totalContentLength.Value, stream, contentType, isHeadRequest, _logger)
2014-02-19 05:21:03 +00:00
{
2017-08-01 16:45:57 +00:00
OnComplete = options.OnComplete
};
2017-08-30 18:06:54 +00:00
AddResponseHeaders(hasHeaders, options.ResponseHeaders);
return hasHeaders;
2017-08-01 16:45:57 +00:00
}
else
{
2018-09-12 17:26:21 +00:00
if (totalContentLength.HasValue)
{
responseHeaders["Content-Length"] = totalContentLength.Value.ToString(UsCulture);
}
2016-12-22 16:47:43 +00:00
if (isHeadRequest)
{
2018-09-12 17:26:21 +00:00
using (stream)
{
return GetHttpResult(requestContext, Array.Empty<byte>(), contentType, true, responseHeaders);
}
2016-12-22 16:47:43 +00:00
}
2014-02-19 05:21:03 +00:00
2017-08-30 18:06:54 +00:00
var hasHeaders = new StreamWriter(stream, contentType, _logger)
2017-08-01 16:45:57 +00:00
{
OnComplete = options.OnComplete,
OnError = options.OnError
};
2017-08-30 18:06:54 +00:00
AddResponseHeaders(hasHeaders, options.ResponseHeaders);
return hasHeaders;
2016-11-10 14:41:24 +00:00
}
}
2017-08-30 18:06:54 +00:00
/// <summary>
/// The us culture
/// </summary>
private static readonly CultureInfo UsCulture = new CultureInfo("en-US");
/// <summary>
/// Adds the caching responseHeaders.
/// </summary>
2017-09-22 20:33:01 +00:00
private void AddCachingHeaders(IDictionary<string, string> responseHeaders, string cacheKey, DateTime? lastDateModified, TimeSpan? cacheDuration)
{
// Don't specify both last modified and Etag, unless caching unconditionally. They are redundant
// https://developers.google.com/speed/docs/best-practices/caching#LeverageBrowserCaching
if (lastDateModified.HasValue && (string.IsNullOrEmpty(cacheKey) || cacheDuration.HasValue))
{
AddAgeHeader(responseHeaders, lastDateModified);
2016-08-14 00:52:32 +00:00
responseHeaders["Last-Modified"] = lastDateModified.Value.ToString("r");
}
2017-09-22 20:33:01 +00:00
if (cacheDuration.HasValue)
{
responseHeaders["Cache-Control"] = "public, max-age=" + Convert.ToInt32(cacheDuration.Value.TotalSeconds);
}
2017-09-22 20:33:01 +00:00
else if (!string.IsNullOrEmpty(cacheKey))
{
responseHeaders["Cache-Control"] = "public";
}
else
{
responseHeaders["Cache-Control"] = "no-cache, no-store, must-revalidate";
responseHeaders["pragma"] = "no-cache, no-store, must-revalidate";
}
2017-09-22 20:33:01 +00:00
AddExpiresHeader(responseHeaders, cacheKey, cacheDuration);
}
/// <summary>
/// Adds the expires header.
/// </summary>
2017-09-22 20:33:01 +00:00
private void AddExpiresHeader(IDictionary<string, string> responseHeaders, string cacheKey, TimeSpan? cacheDuration)
{
2017-09-22 20:33:01 +00:00
if (cacheDuration.HasValue)
{
responseHeaders["Expires"] = DateTime.UtcNow.Add(cacheDuration.Value).ToString("r");
}
else if (string.IsNullOrEmpty(cacheKey))
{
responseHeaders["Expires"] = "-1";
}
}
/// <summary>
/// Adds the age header.
/// </summary>
/// <param name="responseHeaders">The responseHeaders.</param>
/// <param name="lastDateModified">The last date modified.</param>
private void AddAgeHeader(IDictionary<string, string> responseHeaders, DateTime? lastDateModified)
{
if (lastDateModified.HasValue)
{
responseHeaders["Age"] = Convert.ToInt64((DateTime.UtcNow - lastDateModified.Value).TotalSeconds).ToString(CultureInfo.InvariantCulture);
}
}
/// <summary>
/// Determines whether [is not modified] [the specified cache key].
/// </summary>
/// <param name="requestContext">The request context.</param>
/// <param name="cacheKey">The cache key.</param>
/// <param name="lastDateModified">The last date modified.</param>
/// <param name="cacheDuration">Duration of the cache.</param>
/// <returns><c>true</c> if [is not modified] [the specified cache key]; otherwise, <c>false</c>.</returns>
2018-09-12 17:26:21 +00:00
private bool IsNotModified(IRequest requestContext, Guid cacheKey, DateTime? lastDateModified, TimeSpan? cacheDuration)
{
2016-11-27 19:36:56 +00:00
//var isNotModified = true;
2016-11-11 01:37:20 +00:00
var ifModifiedSinceHeader = requestContext.Headers.Get("If-Modified-Since");
if (!string.IsNullOrEmpty(ifModifiedSinceHeader))
{
DateTime ifModifiedSince;
if (DateTime.TryParse(ifModifiedSinceHeader, out ifModifiedSince))
{
2016-11-27 19:36:56 +00:00
if (IsNotModified(ifModifiedSince.ToUniversalTime(), cacheDuration, lastDateModified))
{
return true;
}
}
}
2016-11-11 01:37:20 +00:00
var ifNoneMatchHeader = requestContext.Headers.Get("If-None-Match");
2018-09-12 17:26:21 +00:00
var hasCacheKey = !cacheKey.Equals(Guid.Empty);
// Validate If-None-Match
2018-09-12 17:26:21 +00:00
if ((hasCacheKey || !string.IsNullOrEmpty(ifNoneMatchHeader)))
{
Guid ifNoneMatch;
2016-11-27 19:36:56 +00:00
ifNoneMatchHeader = (ifNoneMatchHeader ?? string.Empty).Trim('\"');
if (Guid.TryParse(ifNoneMatchHeader, out ifNoneMatch))
{
2018-09-12 17:26:21 +00:00
if (hasCacheKey && cacheKey.Equals(ifNoneMatch))
{
return true;
}
}
}
return false;
}
/// <summary>
/// Determines whether [is not modified] [the specified if modified since].
/// </summary>
/// <param name="ifModifiedSince">If modified since.</param>
/// <param name="cacheDuration">Duration of the cache.</param>
/// <param name="dateModified">The date modified.</param>
/// <returns><c>true</c> if [is not modified] [the specified if modified since]; otherwise, <c>false</c>.</returns>
private bool IsNotModified(DateTime ifModifiedSince, TimeSpan? cacheDuration, DateTime? dateModified)
{
if (dateModified.HasValue)
{
var lastModified = NormalizeDateForComparison(dateModified.Value);
ifModifiedSince = NormalizeDateForComparison(ifModifiedSince);
return lastModified <= ifModifiedSince;
}
if (cacheDuration.HasValue)
{
var cacheExpirationDate = ifModifiedSince.Add(cacheDuration.Value);
if (DateTime.UtcNow < cacheExpirationDate)
{
return true;
}
}
return false;
}
/// <summary>
/// When the browser sends the IfModifiedDate, it's precision is limited to seconds, so this will account for that
/// </summary>
/// <param name="date">The date.</param>
/// <returns>DateTime.</returns>
private DateTime NormalizeDateForComparison(DateTime date)
{
return new DateTime(date.Year, date.Month, date.Day, date.Hour, date.Minute, date.Second, date.Kind);
}
/// <summary>
/// Adds the response headers.
/// </summary>
2016-10-25 19:02:04 +00:00
/// <param name="hasHeaders">The has options.</param>
/// <param name="responseHeaders">The response headers.</param>
2016-10-25 19:02:04 +00:00
private void AddResponseHeaders(IHasHeaders hasHeaders, IEnumerable<KeyValuePair<string, string>> responseHeaders)
{
foreach (var item in responseHeaders)
{
2016-10-25 19:02:04 +00:00
hasHeaders.Headers[item.Key] = item.Value;
}
}
2013-03-08 17:25:25 +00:00
}
2018-09-12 17:26:21 +00:00
public interface IBrotliCompressor
{
byte[] Compress(byte[] content);
}
2018-12-29 16:26:36 +00:00
}