Init

Author: azzlack

.gitignore

@@ -172,3 +172,5 @@ UpgradeLog*.htm
 
 # Microsoft Fakes
 FakesAssemblies/
+src/NuGetPackage/*.nupkg
+src/NuGetPackage/lib/

README.md

@@ -2,3 +2,24 @@ Microsoft.AspNet.WebApi.MessageHandlers.Compression
 ===================================================
 
 Drop-in module for ASP.Net WebAPI that enables `GZip` and `Deflate` support
+
+
+### How to use
+**Server side**:  
+You need to add the compression handler as the last applied message handler on outgoing requests, and the first one on incoming requests.  
+To do that, just add the following line to your `App_Start\WebApiConfig.cs` file after adding all your other message handlers:  
+```csharp
+config.MessageHandlers.Insert(0, new CompressionHandler(new GZipCompressor(), new DeflateCompressor()));
+```
+This will insert the `CompressionHandler` to the request pipeline as the first one on incoming requests, and the last one on outgoing requests.
+  
+**Client side**:  
+You need to apply the following code when creating your `HttpClient`:  
+```csharp
+var client =
+    new HttpClient(
+        new DecompressionHandler(new HttpClientHandler(), new GZipCompressor(), new DeflateCompressor()));
+
+client.DefaultRequestHeaders.AcceptEncoding.Add(new StringWithQualityHeaderValue("gzip"));
+client.DefaultRequestHeaders.AcceptEncoding.Add(new StringWithQualityHeaderValue("deflate"));
+```

dist/Microsoft.AspNet.WebApi.MessageHandlers.Compression.1.0.0-RC.nupkg

@@ -0,0 +1,28 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio 2013
+VisualStudioVersion = 12.0.30501.0
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NuGetPackage", "NuGetPackage\NuGetPackage.csproj", "{0451BAEF-DF2E-4B98-8644-94EE9415E389}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Microsoft.AspNet.WebApi.MessageHandlers.Compression", "Microsoft.AspNet.WebApi.MessageHandlers.Compression\Microsoft.AspNet.WebApi.MessageHandlers.Compression.csproj", "{56E19FF7-9AC7-48C5-9AC2-105F55AA16E1}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{0451BAEF-DF2E-4B98-8644-94EE9415E389}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{0451BAEF-DF2E-4B98-8644-94EE9415E389}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{0451BAEF-DF2E-4B98-8644-94EE9415E389}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{0451BAEF-DF2E-4B98-8644-94EE9415E389}.Release|Any CPU.Build.0 = Release|Any CPU
+		{56E19FF7-9AC7-48C5-9AC2-105F55AA16E1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{56E19FF7-9AC7-48C5-9AC2-105F55AA16E1}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{56E19FF7-9AC7-48C5-9AC2-105F55AA16E1}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{56E19FF7-9AC7-48C5-9AC2-105F55AA16E1}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+EndGlobal

dist/Microsoft.AspNet.WebApi.MessageHandlers.Compression.1.0.0-RC.symbols.nupkg

@@ -0,0 +1,35 @@
+<GhostDoc>
+  <SpellChecker>
+    <IncludeExtensions>
+    </IncludeExtensions>
+    <IgnoreExtensions>
+    </IgnoreExtensions>
+    <IgnoreFiles>
+    </IgnoreFiles>
+  </SpellChecker>
+<HelpConfigurations selected="HelpFile">
+  <HelpConfiguration name="HelpFile">
+    <OutputPath>.\Help</OutputPath>
+    <ImageFolderPath />
+    <HtmlFormats>
+      <HtmlHelp>true</HtmlHelp>
+      <MSHelpViewer>false</MSHelpViewer>
+      <MSHelp2>false</MSHelp2>
+      <Website>false</Website>
+    </HtmlFormats>
+    <IncludeScopes>
+      <Public>true</Public>
+      <Internal>false</Internal>
+      <Protected>false</Protected>
+      <Private>false</Private>
+      <Inherited>true</Inherited>
+      <EnableTags>false</EnableTags>
+      <TagList />
+    </IncludeScopes>
+    <ResolveCrefLinks>true</ResolveCrefLinks>
+    <HeaderText />
+    <FooterText />
+    <SelectedProjects />
+  </HelpConfiguration>
+</HelpConfigurations>
+</GhostDoc>

src/Microsoft.AspNet.WebApi.MessageHandlers.Compression.sln

@@ -0,0 +1,77 @@
+namespace Microsoft.AspNet.WebApi.MessageHandlers.Compression
+{
+    using System.Collections.Generic;
+    using System.Linq;
+    using System.Net.Http;
+    using System.Threading;
+    using System.Threading.Tasks;
+
+    using Microsoft.AspNet.WebApi.MessageHandlers.Compression.Interfaces;
+    using Microsoft.AspNet.WebApi.MessageHandlers.Compression.Models;
+
+    /// <summary>
+    /// Message handler for handling gzip/deflate requests/responses.
+    /// </summary>
+    public class CompressionHandler : DelegatingHandler
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CompressionHandler" /> class.
+        /// </summary>
+        /// <param name="compressors">The compressors.</param>
+        public CompressionHandler(params ICompressor[] compressors)
+        {
+            this.Compressors = compressors;
+        }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CompressionHandler" /> class.
+        /// </summary>
+        /// <param name="innerHandler">The inner handler.</param>
+        /// <param name="compressors">The compressors.</param>
+        public CompressionHandler(HttpMessageHandler innerHandler, params ICompressor[] compressors)
+        {
+            this.InnerHandler = innerHandler;
+            this.Compressors = compressors;
+        }
+
+        /// <summary>
+        /// Gets the compressors.
+        /// </summary>
+        /// <value>The compressors.</value>
+        public ICollection<ICompressor> Compressors { get; private set; }
+
+        /// <summary>
+        /// send as an asynchronous operation.
+        /// </summary>
+        /// <param name="request">The HTTP request message to send to the server.</param>
+        /// <param name="cancellationToken">A cancellation token to cancel operation.</param>
+        /// <returns>Returns <see cref="T:System.Threading.Tasks.Task`1" />. The task object representing the asynchronous operation.</returns>
+        protected override async Task<HttpResponseMessage> SendAsync(
+            HttpRequestMessage request,
+            CancellationToken cancellationToken)
+        {
+            var response = await base.SendAsync(request, cancellationToken);
+
+            if (request.Headers.AcceptEncoding.Any() && response.Content != null)
+            {
+                // As per RFC2616.14.3:
+                // Ignores encodings with quality == 0
+                // If multiple content-codings are acceptable, then the acceptable content-coding with the highest non-zero qvalue is preferred.
+                var compressor = (from encoding in request.Headers.AcceptEncoding
+                                  let quality = encoding.Quality ?? 1.0
+                                  where quality > 0
+                                  join c in this.Compressors on encoding.Value.ToLowerInvariant() equals
+                                      c.EncodingType.ToLowerInvariant()
+                                  orderby quality descending
+                                  select c).FirstOrDefault();
+
+                if (compressor != null)
+                {
+                    response.Content = new CompressedContent(response.Content, compressor);
+                }
+            }
+
+            return response;
+        }
+    }
+}

src/Microsoft.AspNet.WebApi.MessageHandlers.Compression.sln.GhostDoc.xml

@@ -0,0 +1,70 @@
+namespace Microsoft.AspNet.WebApi.MessageHandlers.Compression.Compressors
+{
+    using System.IO;
+    using System.Threading.Tasks;
+
+    using Microsoft.AspNet.WebApi.MessageHandlers.Compression.Interfaces;
+
+    /// <summary>
+    /// Base compressor for compressing streams.
+    /// </summary>
+    public abstract class BaseCompressor : ICompressor
+    {
+        /// <summary>
+        /// Gets the encoding type.
+        /// </summary>
+        /// <value>The encoding type.</value>
+        public abstract string EncodingType { get; }
+
+        /// <summary>
+        /// Creates the compression stream.
+        /// </summary>
+        /// <param name="output">The output stream.</param>
+        /// <returns>The compressed stream.</returns>
+        public abstract Stream CreateCompressionStream(Stream output);
+
+        /// <summary>
+        /// Creates the decompression stream.
+        /// </summary>
+        /// <param name="input">The input stream.</param>
+        /// <returns>The decompressed stream.</returns>
+        public abstract Stream CreateDecompressionStream(Stream input);
+
+        /// <summary>
+        /// Compresses the specified source stream onto the destination stream.
+        /// </summary>
+        /// <param name="source">The source.</param>
+        /// <param name="destination">The destination.</param>
+        /// <returns>An async void.</returns>
+        public virtual Task Compress(Stream source, Stream destination)
+        {
+            var compressed = this.CreateCompressionStream(destination);
+
+            return this.Pump(source, compressed).ContinueWith(task => compressed.Dispose());
+        }
+
+        /// <summary>
+        /// Decompresses the specified source stream onto the destination stream.
+        /// </summary>
+        /// <param name="source">The source.</param>
+        /// <param name="destination">The destination.</param>
+        /// <returns>An async void.</returns>
+        public virtual Task Decompress(Stream source, Stream destination)
+        {
+            var decompressed = this.CreateDecompressionStream(source);
+
+            return this.Pump(decompressed, destination).ContinueWith(task => decompressed.Dispose());
+        }
+
+        /// <summary>
+        /// Copies the specified input stream onto the output stream.
+        /// </summary>
+        /// <param name="input">The input.</param>
+        /// <param name="output">The output.</param>
+        /// <returns>An async void.</returns>
+        protected virtual Task Pump(Stream input, Stream output)
+        {
+            return input.CopyToAsync(output);
+        }
+    }
+}

src/Microsoft.AspNet.WebApi.MessageHandlers.Compression/CompressionHandler.cs

@@ -0,0 +1,40 @@
+namespace Microsoft.AspNet.WebApi.MessageHandlers.Compression.Compressors
+{
+    using System.IO;
+    using System.IO.Compression;
+
+    /// <summary>
+    /// Compressor for handling <c>deflate</c> encodings.
+    /// </summary>
+    public class DeflateCompressor : BaseCompressor
+    {
+        /// <summary>
+        /// Gets the encoding type.
+        /// </summary>
+        /// <value>The encoding type.</value>
+        public override string EncodingType
+        {
+            get { return "deflate"; }
+        }
+
+        /// <summary>
+        /// Creates the compression stream.
+        /// </summary>
+        /// <param name="output">The output stream.</param>
+        /// <returns>The compressed stream.</returns>
+        public override Stream CreateCompressionStream(Stream output)
+        {
+            return new DeflateStream(output, CompressionMode.Compress, true);
+        }
+
+        /// <summary>
+        /// Creates the decompression stream.
+        /// </summary>
+        /// <param name="input">The input stream.</param>
+        /// <returns>The decompressed stream.</returns>
+        public override Stream CreateDecompressionStream(Stream input)
+        {
+            return new DeflateStream(input, CompressionMode.Decompress, true);
+        }
+    }
+}

src/Microsoft.AspNet.WebApi.MessageHandlers.Compression/Compressors/BaseCompressor.cs

@@ -0,0 +1,40 @@
+namespace Microsoft.AspNet.WebApi.MessageHandlers.Compression.Compressors
+{
+    using System.IO;
+    using System.IO.Compression;
+
+    /// <summary>
+    /// Compressor for handling <c>gzip</c> encodings.
+    /// </summary>
+    public class GZipCompressor : BaseCompressor
+    {
+        /// <summary>
+        /// Gets the encoding type.
+        /// </summary>
+        /// <value>The encoding type.</value>
+        public override string EncodingType
+        {
+            get { return "gzip"; }
+        }
+
+        /// <summary>
+        /// Creates the compression stream.
+        /// </summary>
+        /// <param name="output">The output stream.</param>
+        /// <returns>The compressed stream.</returns>
+        public override Stream CreateCompressionStream(Stream output)
+        {
+            return new GZipStream(output, CompressionMode.Compress, true);
+        }
+
+        /// <summary>
+        /// Creates the decompression stream.
+        /// </summary>
+        /// <param name="input">The input stream.</param>
+        /// <returns>The decompressed stream.</returns>
+        public override Stream CreateDecompressionStream(Stream input)
+        {
+            return new GZipStream(input, CompressionMode.Decompress, true);
+        }
+    }
+}