jellyfin-server/MediaBrowser.Common/Net/Handlers/BaseHandler.cs
LukePulverenti Luke Pulverenti luke pulverenti dc90725d61 Added DisposeResponseStream method to BaseHandler
2012-08-09 08:41:54 -04:00

154 lines
3.9 KiB
C#

using System;
using System.Collections.Generic;
using System.Collections.Specialized;
using System.IO;
using System.IO.Compression;
namespace MediaBrowser.Common.Net.Handlers
{
public abstract class BaseHandler
{
/// <summary>
/// Response headers
/// </summary>
public IDictionary<string, string> Headers = new Dictionary<string, string>();
private Stream CompressedStream { get; set; }
public virtual bool UseChunkedEncoding
{
get
{
return true;
}
}
public virtual long? ContentLength
{
get
{
return null;
}
}
/// <summary>
/// Returns true or false indicating if the handler writes to the stream asynchronously.
/// If so the subclass will be responsible for disposing the stream when complete.
/// </summary>
protected virtual bool IsAsyncHandler
{
get
{
return false;
}
}
/// <summary>
/// The action to write the response to the output stream
/// </summary>
public virtual Action<Stream> WriteStream
{
get
{
return s =>
{
WriteReponse(s);
if (!IsAsyncHandler)
{
DisposeResponseStream();
}
};
}
}
/// <summary>
/// The original RequestContext
/// </summary>
public RequestContext RequestContext { get; set; }
/// <summary>
/// The original QueryString
/// </summary>
protected NameValueCollection QueryString
{
get
{
return RequestContext.Request.QueryString;
}
}
/// <summary>
/// Gets the MIME type to include in the response headers
/// </summary>
public abstract string ContentType { get; }
/// <summary>
/// Gets the status code to include in the response headers
/// </summary>
public virtual int StatusCode
{
get
{
return 200;
}
}
/// <summary>
/// Gets the cache duration to include in the response headers
/// </summary>
public virtual TimeSpan CacheDuration
{
get
{
return TimeSpan.FromTicks(0);
}
}
/// <summary>
/// Gets the last date modified of the content being returned, if this can be determined.
/// This will be used to invalidate the cache, so it's not needed if CacheDuration is 0.
/// </summary>
public virtual DateTime? LastDateModified
{
get
{
return null;
}
}
public virtual bool CompressResponse
{
get
{
return true;
}
}
private void WriteReponse(Stream stream)
{
if (CompressResponse)
{
CompressedStream = new DeflateStream(stream, CompressionLevel.Fastest, false);
WriteResponseToOutputStream(CompressedStream);
}
else
{
WriteResponseToOutputStream(stream);
}
}
protected abstract void WriteResponseToOutputStream(Stream stream);
protected void DisposeResponseStream()
{
if (CompressedStream != null)
{
CompressedStream.Dispose();
}
RequestContext.Response.OutputStream.Dispose();
}
}
}