From e2dcddc5ac43846baea0f9b1a0fc62844dd9ee1d Mon Sep 17 00:00:00 2001 From: Luke Pulverenti Date: Sat, 23 Mar 2013 22:45:00 -0400 Subject: made compression and caching available to plugin api endpoints --- .../HttpServer/BaseRestService.cs | 470 ----------------- .../HttpServer/HttpResultFactory.cs | 581 ++++++++++++++++++++- .../HttpServer/HttpServer.cs | 29 +- .../HttpServer/RangeRequestWriter.cs | 190 ++++--- .../HttpServer/StreamWriter.cs | 27 +- .../HttpServer/SwaggerService.cs | 17 +- 6 files changed, 748 insertions(+), 566 deletions(-) delete mode 100644 MediaBrowser.Server.Implementations/HttpServer/BaseRestService.cs (limited to 'MediaBrowser.Server.Implementations/HttpServer') diff --git a/MediaBrowser.Server.Implementations/HttpServer/BaseRestService.cs b/MediaBrowser.Server.Implementations/HttpServer/BaseRestService.cs deleted file mode 100644 index ff2273750..000000000 --- a/MediaBrowser.Server.Implementations/HttpServer/BaseRestService.cs +++ /dev/null @@ -1,470 +0,0 @@ -using MediaBrowser.Common.Extensions; -using MediaBrowser.Common.IO; -using MediaBrowser.Common.Net; -using MediaBrowser.Model.Logging; -using ServiceStack.Common; -using ServiceStack.Common.Web; -using ServiceStack.ServiceHost; -using ServiceStack.ServiceInterface; -using System; -using System.Collections.Generic; -using System.Globalization; -using System.IO; -using System.Net; -using System.Threading.Tasks; -using MimeTypes = MediaBrowser.Common.Net.MimeTypes; - -namespace MediaBrowser.Server.Implementations.HttpServer -{ - /// - /// Class BaseRestService - /// - public class BaseRestService : Service, IRestfulService - { - /// - /// Gets or sets the logger. - /// - /// The logger. - public ILogger Logger { get; set; } - - /// - /// Gets a value indicating whether this instance is range request. - /// - /// true if this instance is range request; otherwise, false. - protected bool IsRangeRequest - { - get - { - return !string.IsNullOrEmpty(RequestContext.GetHeader("Range")); - } - } - - /// - /// To the optimized result. - /// - /// - /// The result. - /// System.Object. - /// result - protected object ToOptimizedResult(T result) - where T : class - { - if (result == null) - { - throw new ArgumentNullException("result"); - } - - return RequestContext.ToOptimizedResult(result); - } - - /// - /// To the optimized result using cache. - /// - /// - /// The cache key. - /// The last date modified. - /// Duration of the cache. - /// The factory fn. - /// System.Object. - /// cacheKey - protected object ToOptimizedResultUsingCache(Guid cacheKey, DateTime lastDateModified, TimeSpan? cacheDuration, Func factoryFn) - where T : class - { - if (cacheKey == Guid.Empty) - { - throw new ArgumentNullException("cacheKey"); - } - if (factoryFn == null) - { - throw new ArgumentNullException("factoryFn"); - } - - var key = cacheKey.ToString("N"); - - var result = PreProcessCachedResult(cacheKey, key, lastDateModified, cacheDuration); - - if (result != null) - { - // Return null so that service stack won't do anything - return null; - } - - return ToOptimizedResult(factoryFn()); - } - - /// - /// To the cached result. - /// - /// - /// The cache key. - /// The last date modified. - /// Duration of the cache. - /// The factory fn. - /// Type of the content. - /// System.Object. - /// cacheKey - protected object ToCachedResult(Guid cacheKey, DateTime lastDateModified, TimeSpan? cacheDuration, Func factoryFn, string contentType) - where T : class - { - if (cacheKey == Guid.Empty) - { - throw new ArgumentNullException("cacheKey"); - } - if (factoryFn == null) - { - throw new ArgumentNullException("factoryFn"); - } - - Response.ContentType = contentType; - - var key = cacheKey.ToString("N"); - - var result = PreProcessCachedResult(cacheKey, key, lastDateModified, cacheDuration); - - if (result != null) - { - // Return null so that service stack won't do anything - return null; - } - - return factoryFn(); - } - - /// - /// To the static file result. - /// - /// The path. - /// if set to true [headers only]. - /// System.Object. - /// path - protected object ToStaticFileResult(string path, bool headersOnly = false) - { - if (string.IsNullOrEmpty(path)) - { - throw new ArgumentNullException("path"); - } - - var dateModified = File.GetLastWriteTimeUtc(path); - - var cacheKey = path + dateModified.Ticks; - - return ToStaticResult(cacheKey.GetMD5(), dateModified, null, MimeTypes.GetMimeType(path), () => Task.FromResult(GetFileStream(path)), headersOnly); - } - - /// - /// Gets the file stream. - /// - /// The path. - /// Stream. - private Stream GetFileStream(string path) - { - return new FileStream(path, FileMode.Open, FileAccess.Read, FileShare.Read, StreamDefaults.DefaultFileStreamBufferSize, FileOptions.Asynchronous); - } - - /// - /// To the static result. - /// - /// The cache key. - /// The last date modified. - /// Duration of the cache. - /// Type of the content. - /// The factory fn. - /// if set to true [headers only]. - /// System.Object. - /// cacheKey - protected object ToStaticResult(Guid cacheKey, DateTime? lastDateModified, TimeSpan? cacheDuration, string contentType, Func> factoryFn, bool headersOnly = false) - { - if (cacheKey == Guid.Empty) - { - throw new ArgumentNullException("cacheKey"); - } - if (factoryFn == null) - { - throw new ArgumentNullException("factoryFn"); - } - - var key = cacheKey.ToString("N"); - - Response.ContentType = contentType; - - var result = PreProcessCachedResult(cacheKey, key, lastDateModified, cacheDuration); - - if (result != null) - { - // Return null so that service stack won't do anything - return null; - } - - var compress = ShouldCompressResponse(contentType); - - return ToStaticResult(contentType, factoryFn, compress, headersOnly).Result; - } - - /// - /// Shoulds the compress response. - /// - /// Type of the content. - /// true if XXXX, false otherwise - private bool ShouldCompressResponse(string contentType) - { - // It will take some work to support compression with byte range requests - if (IsRangeRequest) - { - return false; - } - - // Don't compress media - if (contentType.StartsWith("audio/", StringComparison.OrdinalIgnoreCase) || contentType.StartsWith("video/", StringComparison.OrdinalIgnoreCase)) - { - return false; - } - - // Don't compress images - if (contentType.StartsWith("image/", StringComparison.OrdinalIgnoreCase)) - { - return false; - } - - if (contentType.StartsWith("font/", StringComparison.OrdinalIgnoreCase)) - { - return false; - } - if (contentType.StartsWith("application/", StringComparison.OrdinalIgnoreCase)) - { - return false; - } - - return true; - } - - /// - /// To the static result. - /// - /// Type of the content. - /// The factory fn. - /// if set to true [compress]. - /// if set to true [headers only]. - /// System.Object. - private async Task ToStaticResult(string contentType, Func> factoryFn, bool compress, bool headersOnly = false) - { - if (!compress || string.IsNullOrEmpty(RequestContext.CompressionType)) - { - Response.ContentType = contentType; - - var stream = await factoryFn().ConfigureAwait(false); - - var httpListenerResponse = (HttpListenerResponse) Response.OriginalResponse; - httpListenerResponse.SendChunked = false; - - if (IsRangeRequest) - { - return new RangeRequestWriter(RequestContext.GetHeader("Range"), httpListenerResponse, stream, headersOnly); - } - - httpListenerResponse.ContentLength64 = stream.Length; - return headersOnly ? null : new StreamWriter(stream, Logger); - } - - if (headersOnly) - { - return null; - } - - string content; - - using (var stream = await factoryFn().ConfigureAwait(false)) - { - using (var reader = new StreamReader(stream)) - { - content = await reader.ReadToEndAsync().ConfigureAwait(false); - } - } - - var contents = content.Compress(RequestContext.CompressionType); - - return new CompressedResult(contents, RequestContext.CompressionType, contentType); - } - - /// - /// Pres the process optimized result. - /// - /// The cache key. - /// The cache key string. - /// The last date modified. - /// Duration of the cache. - /// System.Object. - private object PreProcessCachedResult(Guid cacheKey, string cacheKeyString, DateTime? lastDateModified, TimeSpan? cacheDuration) - { - Response.AddHeader("ETag", cacheKeyString); - - if (IsNotModified(cacheKey, lastDateModified, cacheDuration)) - { - AddAgeHeader(lastDateModified); - AddExpiresHeader(cacheKeyString, cacheDuration); - //ctx.Response.SendChunked = false; - - Response.StatusCode = 304; - - return new byte[]{}; - } - - SetCachingHeaders(cacheKeyString, lastDateModified, cacheDuration); - - return null; - } - - /// - /// Determines whether [is not modified] [the specified cache key]. - /// - /// The cache key. - /// The last date modified. - /// Duration of the cache. - /// true if [is not modified] [the specified cache key]; otherwise, false. - private bool IsNotModified(Guid? cacheKey, DateTime? lastDateModified, TimeSpan? cacheDuration) - { - var isNotModified = true; - - var ifModifiedSinceHeader = RequestContext.GetHeader("If-Modified-Since"); - - if (!string.IsNullOrEmpty(ifModifiedSinceHeader)) - { - DateTime ifModifiedSince; - - if (DateTime.TryParse(ifModifiedSinceHeader, out ifModifiedSince)) - { - isNotModified = IsNotModified(ifModifiedSince.ToUniversalTime(), cacheDuration, lastDateModified); - } - } - - var ifNoneMatchHeader = RequestContext.GetHeader("If-None-Match"); - - // Validate If-None-Match - if (isNotModified && (cacheKey.HasValue || !string.IsNullOrEmpty(ifNoneMatchHeader))) - { - Guid ifNoneMatch; - - if (Guid.TryParse(ifNoneMatchHeader ?? string.Empty, out ifNoneMatch)) - { - if (cacheKey.HasValue && cacheKey.Value == ifNoneMatch) - { - return true; - } - } - } - - return false; - } - - /// - /// Determines whether [is not modified] [the specified if modified since]. - /// - /// If modified since. - /// Duration of the cache. - /// The date modified. - /// true if [is not modified] [the specified if modified since]; otherwise, false. - 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; - } - - - /// - /// When the browser sends the IfModifiedDate, it's precision is limited to seconds, so this will account for that - /// - /// The date. - /// DateTime. - private DateTime NormalizeDateForComparison(DateTime date) - { - return new DateTime(date.Year, date.Month, date.Day, date.Hour, date.Minute, date.Second, date.Kind); - } - - /// - /// Sets the caching headers. - /// - /// The cache key. - /// The last date modified. - /// Duration of the cache. - private void SetCachingHeaders(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(lastDateModified); - Response.AddHeader("LastModified", lastDateModified.Value.ToString("r")); - } - - if (cacheDuration.HasValue) - { - Response.AddHeader("Cache-Control", "public, max-age=" + Convert.ToInt32(cacheDuration.Value.TotalSeconds)); - } - else if (!string.IsNullOrEmpty(cacheKey)) - { - Response.AddHeader("Cache-Control", "public"); - } - else - { - Response.AddHeader("Cache-Control", "no-cache, no-store, must-revalidate"); - Response.AddHeader("pragma", "no-cache, no-store, must-revalidate"); - } - - AddExpiresHeader(cacheKey, cacheDuration); - } - - /// - /// Adds the expires header. - /// - /// The cache key. - /// Duration of the cache. - private void AddExpiresHeader(string cacheKey, TimeSpan? cacheDuration) - { - if (cacheDuration.HasValue) - { - Response.AddHeader("Expires", DateTime.UtcNow.Add(cacheDuration.Value).ToString("r")); - } - else if (string.IsNullOrEmpty(cacheKey)) - { - Response.AddHeader("Expires", "-1"); - } - } - - /// - /// Adds the age header. - /// - /// The last date modified. - private void AddAgeHeader(DateTime? lastDateModified) - { - if (lastDateModified.HasValue) - { - Response.AddHeader("Age", Convert.ToInt64((DateTime.UtcNow - lastDateModified.Value).TotalSeconds).ToString(CultureInfo.InvariantCulture)); - } - } - - /// - /// Gets the routes. - /// - /// IEnumerable{RouteInfo}. - public virtual IEnumerable GetRoutes() - { - return new RouteInfo[] {}; - } - } -} diff --git a/MediaBrowser.Server.Implementations/HttpServer/HttpResultFactory.cs b/MediaBrowser.Server.Implementations/HttpServer/HttpResultFactory.cs index 2dd968988..78b883d34 100644 --- a/MediaBrowser.Server.Implementations/HttpServer/HttpResultFactory.cs +++ b/MediaBrowser.Server.Implementations/HttpServer/HttpResultFactory.cs @@ -1,14 +1,589 @@ -using MediaBrowser.Common.Net; +using MediaBrowser.Common.Extensions; +using MediaBrowser.Common.IO; +using MediaBrowser.Common.Net; +using MediaBrowser.Model.Logging; +using ServiceStack.Common; using ServiceStack.Common.Web; +using ServiceStack.ServiceHost; +using System; +using System.Collections.Generic; +using System.Globalization; using System.IO; +using System.Net; +using System.Threading.Tasks; +using MimeTypes = MediaBrowser.Common.Net.MimeTypes; namespace MediaBrowser.Server.Implementations.HttpServer { + /// + /// Class HttpResultFactory + /// public class HttpResultFactory : IHttpResultFactory { - public object GetResult(Stream stream, string contentType) + /// + /// The _logger + /// + private readonly ILogger _logger; + + /// + /// Initializes a new instance of the class. + /// + /// The log manager. + public HttpResultFactory(ILogManager logManager) + { + _logger = logManager.GetLogger("HttpResultFactory"); + } + + /// + /// Gets the result. + /// + /// The content. + /// Type of the content. + /// The response headers. + /// System.Object. + public object GetResult(object content, string contentType, IDictionary responseHeaders = null) + { + var result = new HttpResult(content, contentType); + + if (responseHeaders != null) + { + AddResponseHeaders(result, responseHeaders); + } + + return result; + } + + /// + /// Gets the optimized result. + /// + /// + /// The request context. + /// The result. + /// The response headers. + /// System.Object. + /// result + public object GetOptimizedResult(IRequestContext requestContext, T result, IDictionary responseHeaders = null) + where T : class + { + if (result == null) + { + throw new ArgumentNullException("result"); + } + + var optimizedResult = requestContext.ToOptimizedResult(result); + + if (responseHeaders != null) + { + // Apply headers + var hasOptions = optimizedResult as IHasOptions; + + if (hasOptions != null) + { + AddResponseHeaders(hasOptions, responseHeaders); + } + } + + return optimizedResult; + } + + /// + /// Gets the optimized result using cache. + /// + /// + /// The request context. + /// The cache key. + /// The last date modified. + /// Duration of the cache. + /// The factory fn. + /// The response headers. + /// System.Object. + /// + /// cacheKey + /// or + /// factoryFn + /// + public object GetOptimizedResultUsingCache(IRequestContext requestContext, Guid cacheKey, DateTime lastDateModified, TimeSpan? cacheDuration, Func factoryFn, IDictionary responseHeaders = null) + where T : class + { + if (cacheKey == Guid.Empty) + { + throw new ArgumentNullException("cacheKey"); + } + if (factoryFn == null) + { + throw new ArgumentNullException("factoryFn"); + } + + var key = cacheKey.ToString("N"); + + if (responseHeaders == null) + { + responseHeaders = new Dictionary(); + } + + // See if the result is already cached in the browser + var result = GetCachedResult(requestContext, responseHeaders, cacheKey, key, lastDateModified, cacheDuration, null); + + if (result != null) + { + return result; + } + + return GetOptimizedResult(requestContext, factoryFn(), responseHeaders); + } + + /// + /// To the cached result. + /// + /// + /// The request context. + /// The cache key. + /// The last date modified. + /// Duration of the cache. + /// The factory fn. + /// Type of the content. + /// The response headers. + /// System.Object. + /// cacheKey + public object GetCachedResult(IRequestContext requestContext, Guid cacheKey, DateTime lastDateModified, TimeSpan? cacheDuration, Func factoryFn, string contentType, IDictionary responseHeaders = null) + where T : class + { + if (cacheKey == Guid.Empty) + { + throw new ArgumentNullException("cacheKey"); + } + if (factoryFn == null) + { + throw new ArgumentNullException("factoryFn"); + } + + var key = cacheKey.ToString("N"); + + if (responseHeaders == null) + { + responseHeaders = new Dictionary(); + } + + // See if the result is already cached in the browser + var result = GetCachedResult(requestContext, responseHeaders, cacheKey, key, lastDateModified, cacheDuration, contentType); + + if (result != null) + { + return result; + } + + result = factoryFn(); + + // Apply caching headers + var hasOptions = result as IHasOptions; + + if (hasOptions != null) + { + AddResponseHeaders(hasOptions, responseHeaders); + return hasOptions; + } + + // Otherwise wrap into an HttpResult + var httpResult = new HttpResult(result, contentType ?? "text/html", HttpStatusCode.NotModified); + + AddResponseHeaders(httpResult, responseHeaders); + + return httpResult; + } + + /// + /// Pres the process optimized result. + /// + /// The request context. + /// The responseHeaders. + /// The cache key. + /// The cache key string. + /// The last date modified. + /// Duration of the cache. + /// Type of the content. + /// System.Object. + private object GetCachedResult(IRequestContext requestContext, IDictionary responseHeaders, Guid cacheKey, string cacheKeyString, DateTime? lastDateModified, TimeSpan? cacheDuration, string contentType) + { + responseHeaders["ETag"] = cacheKeyString; + + if (IsNotModified(requestContext, cacheKey, lastDateModified, cacheDuration)) + { + AddAgeHeader(responseHeaders, lastDateModified); + AddExpiresHeader(responseHeaders, cacheKeyString, cacheDuration); + + var result = new HttpResult(new byte[] { }, contentType ?? "text/html", HttpStatusCode.NotModified); + + AddResponseHeaders(result, responseHeaders); + + return result; + } + + AddCachingHeaders(responseHeaders, cacheKeyString, lastDateModified, cacheDuration); + + return null; + } + + /// + /// Gets the static file result. + /// + /// The request context. + /// The path. + /// The response headers. + /// if set to true [is head request]. + /// System.Object. + /// path + public object GetStaticFileResult(IRequestContext requestContext, string path, IDictionary responseHeaders = null, bool isHeadRequest = false) { - return new HttpResult(stream, contentType); + if (string.IsNullOrEmpty(path)) + { + throw new ArgumentNullException("path"); + } + + var dateModified = File.GetLastWriteTimeUtc(path); + + var cacheKey = path + dateModified.Ticks; + + return GetStaticResult(requestContext, cacheKey.GetMD5(), dateModified, null, MimeTypes.GetMimeType(path), () => Task.FromResult(GetFileStream(path)), responseHeaders, isHeadRequest); + } + + /// + /// Gets the file stream. + /// + /// The path. + /// Stream. + private Stream GetFileStream(string path) + { + return new FileStream(path, FileMode.Open, FileAccess.Read, FileShare.Read, StreamDefaults.DefaultFileStreamBufferSize, FileOptions.Asynchronous); + } + + /// + /// Gets the static result. + /// + /// The request context. + /// The cache key. + /// The last date modified. + /// Duration of the cache. + /// Type of the content. + /// The factory fn. + /// The response headers. + /// if set to true [is head request]. + /// System.Object. + /// cacheKey + /// or + /// factoryFn + public object GetStaticResult(IRequestContext requestContext, Guid cacheKey, DateTime? lastDateModified, TimeSpan? cacheDuration, string contentType, Func> factoryFn, IDictionary responseHeaders = null, bool isHeadRequest = false) + { + if (cacheKey == Guid.Empty) + { + throw new ArgumentNullException("cacheKey"); + } + if (factoryFn == null) + { + throw new ArgumentNullException("factoryFn"); + } + + var key = cacheKey.ToString("N"); + + if (responseHeaders == null) + { + responseHeaders = new Dictionary(); + } + + // See if the result is already cached in the browser + var result = GetCachedResult(requestContext, responseHeaders, cacheKey, key, lastDateModified, cacheDuration, contentType); + + if (result != null) + { + return result; + } + + var compress = ShouldCompressResponse(requestContext, contentType); + + var hasOptions = GetStaticResult(requestContext, responseHeaders, contentType, factoryFn, compress, isHeadRequest).Result; + + AddResponseHeaders(hasOptions, responseHeaders); + + return hasOptions; + } + + /// + /// Shoulds the compress response. + /// + /// The request context. + /// Type of the content. + /// true if XXXX, false otherwise + private bool ShouldCompressResponse(IRequestContext requestContext, string contentType) + { + // It will take some work to support compression with byte range requests + if (!string.IsNullOrEmpty(requestContext.GetHeader("Range"))) + { + return false; + } + + // Don't compress media + if (contentType.StartsWith("audio/", StringComparison.OrdinalIgnoreCase) || contentType.StartsWith("video/", StringComparison.OrdinalIgnoreCase)) + { + return false; + } + + // Don't compress images + if (contentType.StartsWith("image/", StringComparison.OrdinalIgnoreCase)) + { + return false; + } + + if (contentType.StartsWith("font/", StringComparison.OrdinalIgnoreCase)) + { + return false; + } + if (contentType.StartsWith("application/", StringComparison.OrdinalIgnoreCase)) + { + return false; + } + + return true; + } + + /// + /// The us culture + /// + private static readonly CultureInfo UsCulture = new CultureInfo("en-US"); + + /// + /// Gets the static result. + /// + /// The request context. + /// The response headers. + /// Type of the content. + /// The factory fn. + /// if set to true [compress]. + /// if set to true [is head request]. + /// Task{IHasOptions}. + private async Task GetStaticResult(IRequestContext requestContext, IDictionary responseHeaders, string contentType, Func> factoryFn, bool compress, bool isHeadRequest) + { + if (!compress || string.IsNullOrEmpty(requestContext.CompressionType)) + { + var stream = await factoryFn().ConfigureAwait(false); + + var rangeHeader = requestContext.GetHeader("Range"); + + if (!string.IsNullOrEmpty(rangeHeader)) + { + return new RangeRequestWriter(rangeHeader, stream, contentType, isHeadRequest); + } + + responseHeaders["Content-Length"] = stream.Length.ToString(UsCulture); + + if (isHeadRequest) + { + return new HttpResult(new byte[] { }, contentType); + } + + return new StreamWriter(stream, contentType, _logger); + } + + if (isHeadRequest) + { + return new HttpResult(new byte[] { }, contentType); + } + + string content; + + using (var stream = await factoryFn().ConfigureAwait(false)) + { + using (var reader = new StreamReader(stream)) + { + content = await reader.ReadToEndAsync().ConfigureAwait(false); + } + } + + var contents = content.Compress(requestContext.CompressionType); + + return new CompressedResult(contents, requestContext.CompressionType, contentType); + } + + /// + /// Adds the caching responseHeaders. + /// + /// The responseHeaders. + /// The cache key. + /// The last date modified. + /// Duration of the cache. + private void AddCachingHeaders(IDictionary 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); + responseHeaders["LastModified"] = lastDateModified.Value.ToString("r"); + } + + if (cacheDuration.HasValue) + { + responseHeaders["Cache-Control"] = "public, max-age=" + Convert.ToInt32(cacheDuration.Value.TotalSeconds); + } + 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"; + } + + AddExpiresHeader(responseHeaders, cacheKey, cacheDuration); + } + + /// + /// Adds the expires header. + /// + /// The responseHeaders. + /// The cache key. + /// Duration of the cache. + private void AddExpiresHeader(IDictionary responseHeaders, string cacheKey, TimeSpan? cacheDuration) + { + if (cacheDuration.HasValue) + { + responseHeaders["Expires"] = DateTime.UtcNow.Add(cacheDuration.Value).ToString("r"); + } + else if (string.IsNullOrEmpty(cacheKey)) + { + responseHeaders["Expires"] = "-1"; + } + } + + /// + /// Adds the age header. + /// + /// The responseHeaders. + /// The last date modified. + private void AddAgeHeader(IDictionary responseHeaders, DateTime? lastDateModified) + { + if (lastDateModified.HasValue) + { + responseHeaders["Age"] = Convert.ToInt64((DateTime.UtcNow - lastDateModified.Value).TotalSeconds).ToString(CultureInfo.InvariantCulture); + } + } + /// + /// Determines whether [is not modified] [the specified cache key]. + /// + /// The request context. + /// The cache key. + /// The last date modified. + /// Duration of the cache. + /// true if [is not modified] [the specified cache key]; otherwise, false. + private bool IsNotModified(IRequestContext requestContext, Guid? cacheKey, DateTime? lastDateModified, TimeSpan? cacheDuration) + { + var isNotModified = true; + + var ifModifiedSinceHeader = requestContext.GetHeader("If-Modified-Since"); + + if (!string.IsNullOrEmpty(ifModifiedSinceHeader)) + { + DateTime ifModifiedSince; + + if (DateTime.TryParse(ifModifiedSinceHeader, out ifModifiedSince)) + { + isNotModified = IsNotModified(ifModifiedSince.ToUniversalTime(), cacheDuration, lastDateModified); + } + } + + var ifNoneMatchHeader = requestContext.GetHeader("If-None-Match"); + + // Validate If-None-Match + if (isNotModified && (cacheKey.HasValue || !string.IsNullOrEmpty(ifNoneMatchHeader))) + { + Guid ifNoneMatch; + + if (Guid.TryParse(ifNoneMatchHeader ?? string.Empty, out ifNoneMatch)) + { + if (cacheKey.HasValue && cacheKey.Value == ifNoneMatch) + { + return true; + } + } + } + + return false; + } + + /// + /// Determines whether [is not modified] [the specified if modified since]. + /// + /// If modified since. + /// Duration of the cache. + /// The date modified. + /// true if [is not modified] [the specified if modified since]; otherwise, false. + 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; + } + + + /// + /// When the browser sends the IfModifiedDate, it's precision is limited to seconds, so this will account for that + /// + /// The date. + /// DateTime. + private DateTime NormalizeDateForComparison(DateTime date) + { + return new DateTime(date.Year, date.Month, date.Day, date.Hour, date.Minute, date.Second, date.Kind); + } + + /// + /// Adds the response headers. + /// + /// The has options. + /// The response headers. + private void AddResponseHeaders(IHasOptions hasOptions, IDictionary responseHeaders) + { + foreach (var item in responseHeaders) + { + hasOptions.Options[item.Key] = item.Value; + } + } + + /// + /// Gets the error result. + /// + /// The status code. + /// The error message. + /// The response headers. + /// System.Object. + public void ThrowError(int statusCode, string errorMessage, IDictionary responseHeaders = null) + { + var error = new HttpError + { + Status = statusCode, + ErrorCode = errorMessage + }; + + if (responseHeaders != null) + { + AddResponseHeaders(error, responseHeaders); + } + + throw error; } } } diff --git a/MediaBrowser.Server.Implementations/HttpServer/HttpServer.cs b/MediaBrowser.Server.Implementations/HttpServer/HttpServer.cs index 79663dca9..d22605cb3 100644 --- a/MediaBrowser.Server.Implementations/HttpServer/HttpServer.cs +++ b/MediaBrowser.Server.Implementations/HttpServer/HttpServer.cs @@ -174,6 +174,30 @@ namespace MediaBrowser.Server.Implementations.HttpServer // This is a good choice for applications that are singly homed and depend on public proxies for user locality. res.AddHeader("Vary", "Accept-Encoding"); } + + var hasOptions = dto as IHasOptions; + + if (hasOptions != null) + { + // Content length has to be explicitly set on on HttpListenerResponse or it won't be happy + string contentLength; + + if (hasOptions.Options.TryGetValue("Content-Length", out contentLength) && !string.IsNullOrEmpty(contentLength)) + { + var length = long.Parse(contentLength); + + if (length > 0) + { + var response = (HttpListenerResponse) res.OriginalResponse; + + response.ContentLength64 = length; + + // Disable chunked encoding. Technically this is only needed when using Content-Range, but + // anytime we know the content length there's no need for it + response.SendChunked = false; + } + } + } }); } @@ -532,11 +556,6 @@ namespace MediaBrowser.Server.Implementations.HttpServer EndpointHost.ConfigureHost(this, ServerName, CreateServiceManager()); ContentTypeFilters.Register(ContentType.ProtoBuf, (reqCtx, res, stream) => ProtobufSerializer.SerializeToStream(res, stream), (type, stream) => ProtobufSerializer.DeserializeFromStream(stream, type)); - - foreach (var route in services.SelectMany(i => i.GetRoutes())) - { - Routes.Add(route.RequestType, route.Path, route.Verbs); - } Init(); } diff --git a/MediaBrowser.Server.Implementations/HttpServer/RangeRequestWriter.cs b/MediaBrowser.Server.Implementations/HttpServer/RangeRequestWriter.cs index b61e05d0b..a355a2db5 100644 --- a/MediaBrowser.Server.Implementations/HttpServer/RangeRequestWriter.cs +++ b/MediaBrowser.Server.Implementations/HttpServer/RangeRequestWriter.cs @@ -1,6 +1,8 @@ using ServiceStack.Service; +using ServiceStack.ServiceHost; using System; using System.Collections.Generic; +using System.Globalization; using System.IO; using System.Linq; using System.Net; @@ -8,30 +10,105 @@ using System.Threading.Tasks; namespace MediaBrowser.Server.Implementations.HttpServer { - public class RangeRequestWriter : IStreamWriter + public class RangeRequestWriter : IStreamWriter, IHttpResult { /// /// Gets or sets the source stream. /// /// The source stream. private Stream SourceStream { get; set; } - private HttpListenerResponse Response { get; set; } private string RangeHeader { get; set; } private bool IsHeadRequest { get; set; } + private long RangeStart { get; set; } + private long RangeEnd { get; set; } + private long RangeLength { get; set; } + private long TotalContentLength { get; set; } + + /// + /// The _options + /// + private readonly Dictionary _options = new Dictionary(); + + /// + /// The us culture + /// + private static readonly CultureInfo UsCulture = new CultureInfo("en-US"); + + /// + /// Additional HTTP Headers + /// + /// The headers. + public Dictionary Headers + { + get { return _options; } + } + + /// + /// Gets the options. + /// + /// The options. + public IDictionary Options + { + get { return Headers; } + } + /// /// Initializes a new instance of the class. /// /// The range header. - /// The response. /// The source. + /// Type of the content. /// if set to true [is head request]. - public RangeRequestWriter(string rangeHeader, HttpListenerResponse response, Stream source, bool isHeadRequest) + public RangeRequestWriter(string rangeHeader, Stream source, string contentType, bool isHeadRequest) { + if (string.IsNullOrEmpty(contentType)) + { + throw new ArgumentNullException("contentType"); + } + RangeHeader = rangeHeader; - Response = response; SourceStream = source; IsHeadRequest = isHeadRequest; + + ContentType = contentType; + Options["Content-Type"] = contentType; + Options["Accept-Ranges"] = "bytes"; + StatusCode = HttpStatusCode.PartialContent; + + SetRangeValues(); + } + + /// + /// Sets the range values. + /// + private void SetRangeValues() + { + var requestedRange = RequestedRanges.First(); + + TotalContentLength = SourceStream.Length; + + // If the requested range is "0-", we can optimize by just doing a stream copy + if (!requestedRange.Value.HasValue) + { + RangeEnd = TotalContentLength - 1; + } + else + { + RangeEnd = requestedRange.Value.Value; + } + + RangeStart = requestedRange.Key; + RangeLength = 1 + RangeEnd - RangeStart; + + // Content-Length is the length of what we're serving, not the original content + Options["Content-Length"] = RangeLength.ToString(UsCulture); + Options["Content-Range"] = string.Format("bytes {0}-{1}/{2}", RangeStart, RangeEnd, TotalContentLength); + + if (RangeStart > 0) + { + SourceStream.Position = RangeStart; + } } /// @@ -42,7 +119,7 @@ namespace MediaBrowser.Server.Implementations.HttpServer /// Gets the requested ranges. /// /// The requested ranges. - protected IEnumerable> RequestedRanges + protected List> RequestedRanges { get { @@ -83,9 +160,6 @@ namespace MediaBrowser.Server.Implementations.HttpServer /// The response stream. public void WriteTo(Stream responseStream) { - Response.Headers["Accept-Ranges"] = "bytes"; - Response.StatusCode = 206; - var task = WriteToAsync(responseStream); Task.WaitAll(task); @@ -98,94 +172,46 @@ namespace MediaBrowser.Server.Implementations.HttpServer /// Task. private async Task WriteToAsync(Stream responseStream) { - using (var source = SourceStream) + // Headers only + if (IsHeadRequest) { - var requestedRange = RequestedRanges.First(); - - var totalLength = SourceStream.Length; + return; + } + using (var source = SourceStream) + { // If the requested range is "0-", we can optimize by just doing a stream copy - if (!requestedRange.Value.HasValue) + if (RangeEnd == TotalContentLength - 1) { - await ServeCompleteRangeRequest(source, requestedRange, responseStream, totalLength).ConfigureAwait(false); + await source.CopyToAsync(responseStream).ConfigureAwait(false); } + else + { + // Read the bytes we need + var buffer = new byte[Convert.ToInt32(RangeLength)]; + await source.ReadAsync(buffer, 0, buffer.Length).ConfigureAwait(false); - // This will have to buffer a portion of the content into memory - await ServePartialRangeRequest(source, requestedRange.Key, requestedRange.Value.Value, responseStream, totalLength).ConfigureAwait(false); + await responseStream.WriteAsync(buffer, 0, Convert.ToInt32(RangeLength)).ConfigureAwait(false); + } } } - /// - /// Handles a range request of "bytes=0-" - /// This will serve the complete content and add the content-range header - /// - /// The source stream. - /// The requested range. - /// The response stream. - /// Total length of the content. - /// Task. - private Task ServeCompleteRangeRequest(Stream sourceStream, KeyValuePair requestedRange, Stream responseStream, long totalContentLength) - { - var rangeStart = requestedRange.Key; - var rangeEnd = totalContentLength - 1; - var rangeLength = 1 + rangeEnd - rangeStart; + public string ContentType { get; set; } - // Content-Length is the length of what we're serving, not the original content - Response.ContentLength64 = rangeLength; - Response.Headers["Content-Range"] = string.Format("bytes {0}-{1}/{2}", rangeStart, rangeEnd, totalContentLength); + public IRequestContext RequestContext { get; set; } - // Headers only - if (IsHeadRequest) - { - return Task.FromResult(true); - } + public object Response { get; set; } - if (rangeStart > 0) - { - sourceStream.Position = rangeStart; - } + public IContentTypeWriter ResponseFilter { get; set; } - return sourceStream.CopyToAsync(responseStream); - } + public int Status { get; set; } - /// - /// Serves a partial range request - /// - /// The source stream. - /// The range start. - /// The range end. - /// The response stream. - /// Total length of the content. - /// Task. - private async Task ServePartialRangeRequest(Stream sourceStream, long rangeStart, long rangeEnd, Stream responseStream, long totalContentLength) + public HttpStatusCode StatusCode { - var rangeLength = 1 + rangeEnd - rangeStart; - - // Content-Length is the length of what we're serving, not the original content - Response.ContentLength64 = rangeLength; - Response.Headers["Content-Range"] = string.Format("bytes {0}-{1}/{2}", rangeStart, rangeEnd, totalContentLength); - - // Headers only - if (IsHeadRequest) - { - return; - } - - sourceStream.Position = rangeStart; - - // Fast track to just copy the stream to the end - if (rangeEnd == totalContentLength - 1) - { - await sourceStream.CopyToAsync(responseStream).ConfigureAwait(false); - } - else - { - // Read the bytes we need - var buffer = new byte[Convert.ToInt32(rangeLength)]; - await sourceStream.ReadAsync(buffer, 0, buffer.Length).ConfigureAwait(false); - - await responseStream.WriteAsync(buffer, 0, Convert.ToInt32(rangeLength)).ConfigureAwait(false); - } + get { return (HttpStatusCode)Status; } + set { Status = (int)value; } } + + public string StatusDescription { get; set; } } } diff --git a/MediaBrowser.Server.Implementations/HttpServer/StreamWriter.cs b/MediaBrowser.Server.Implementations/HttpServer/StreamWriter.cs index 6f5d6e25f..da84a51cd 100644 --- a/MediaBrowser.Server.Implementations/HttpServer/StreamWriter.cs +++ b/MediaBrowser.Server.Implementations/HttpServer/StreamWriter.cs @@ -1,6 +1,8 @@ using MediaBrowser.Model.Logging; using ServiceStack.Service; +using ServiceStack.ServiceHost; using System; +using System.Collections.Generic; using System.IO; using System.Threading.Tasks; @@ -9,7 +11,7 @@ namespace MediaBrowser.Server.Implementations.HttpServer /// /// Class StreamWriter /// - public class StreamWriter : IStreamWriter + public class StreamWriter : IStreamWriter, IHasOptions { private ILogger Logger { get; set; } @@ -19,15 +21,36 @@ namespace MediaBrowser.Server.Implementations.HttpServer /// The source stream. public Stream SourceStream { get; set; } + /// + /// The _options + /// + private readonly IDictionary _options = new Dictionary(); + /// + /// Gets the options. + /// + /// The options. + public IDictionary Options + { + get { return _options; } + } + /// /// Initializes a new instance of the class. /// /// The source. + /// Type of the content. /// The logger. - public StreamWriter(Stream source, ILogger logger) + public StreamWriter(Stream source, string contentType, ILogger logger) { + if (string.IsNullOrEmpty(contentType)) + { + throw new ArgumentNullException("contentType"); + } + SourceStream = source; Logger = logger; + + Options["Content-Type"] = contentType; } /// diff --git a/MediaBrowser.Server.Implementations/HttpServer/SwaggerService.cs b/MediaBrowser.Server.Implementations/HttpServer/SwaggerService.cs index 18ab40d93..8772176a0 100644 --- a/MediaBrowser.Server.Implementations/HttpServer/SwaggerService.cs +++ b/MediaBrowser.Server.Implementations/HttpServer/SwaggerService.cs @@ -1,4 +1,5 @@ -using ServiceStack.ServiceHost; +using MediaBrowser.Common.Net; +using ServiceStack.ServiceHost; using System.Diagnostics; using System.IO; @@ -16,9 +17,11 @@ namespace MediaBrowser.Server.Implementations.HttpServer /// The name. public string ResourceName { get; set; } } - - public class SwaggerService : BaseRestService + + public class SwaggerService : IRequiresRequestContext, IRestfulService { + public IHttpResultFactory HttpResultFactory { get; set; } + /// /// Gets the specified request. /// @@ -32,7 +35,13 @@ namespace MediaBrowser.Server.Implementations.HttpServer var requestedFile = Path.Combine(swaggerDirectory, request.ResourceName.Replace('/', '\\')); - return ToStaticFileResult(requestedFile); + return HttpResultFactory.GetStaticFileResult(RequestContext, requestedFile); } + + /// + /// Gets or sets the request context. + /// + /// The request context. + public IRequestContext RequestContext { get; set; } } } -- cgit v1.2.3