Files
mono/mcs/class/System.Web/System.Web.Caching/OutputCacheModule.cs
T
Marek Habersack 73c3bfba56 2010-02-03 Marek Habersack <[email protected]>
* AssemblyInfo.cs: added back InternalsVisibleTo for the test
        assembly - it's needed to access CacheItemPriorityQueue

2010-02-03  Marek Habersack  <[email protected]>

        * OutputCache.cs: DefaultProviderName checks if there was any
        provider configured and, if not, returns a built-in provider's
        name.

        * SqlCacheDependencyAdmin.cs: added

        * OutputCacheProviderCollection.cs: added

        * OutputCacheProvider.cs: added

        * OutputCacheModule.cs: uses the 4.0 extensible output cache
        provider model now (also internally in the 2.0 profile)
        OutputCacheProvider is retrieved on every request using
        HttpApplication.GetOutputCacheProviderName (4.0+). In the 2.0
        profile an instance of InMemoryOutputCacheProvider is always
        returned.

        * InMemoryOutputCacheProvider.cs: default output cache provider
        for ASP.NET 4.0, also used internally in the  2.0 profile.

        * CachedVaryBy.cs: made the generated key shorter

        * CacheItemPriorityQueueDebug.cs: debugging support for
        CacheItemPriorityQueue. Most of the code is compiled only when the
        DEBUG macro is defined. Debugging support includes recording of
        the queue operations sequence which is output to an XML file on
        appdomain shutdown. The recorded sequence files can be used to
        generate NUnit test cases for the priority queue (see
        ../Test/tools/README)

        * CacheItemPriorityQueue.cs: rewritten using an array based heap
        instead of a binary tree based one - implementation is simpler,
        faster and more elegant. Heap is initially 32 entries long and
        its size is doubled every time it fills up. After reaching a
        threshold (8192 entries currently) it is shrunk to the number of
        items + 1/3 of item count in order to preserve memory.

        * CacheItem.cs: added a Guid field to easier distinguish items
        (mostly for debugging purposes)

        * CacheDependency.cs: minor performance improvements

        * Cache.cs: better handling of timer periods

2010-02-03  Marek Habersack  <[email protected]>

        * HttpApplication.cs: GetOutputCacheProviderName returns the value
        of OutputCache.DefaultProviderName

        * HttpRuntime.cs: internal cache is used to hold the dependencies
        now.

2010-02-03  Marek Habersack  <[email protected]>

        * CacheItemPriorityQueueTest_generated.cs: added

        * CacheItemPriorityQueueTest.cs: added

2010-02-04  Marek Habersack  <[email protected]>

        * Helpers.cs: added a helper method for checking of HTML mentions
        any .NET exceptions.

2010-02-03  Marek Habersack  <[email protected]>

        * Makefile: added targets to compile cache priority queue tests
        generator and to generate the tests themselves

svn path=/trunk/mcs/; revision=150855
2010-02-04 13:53:55 +00:00

323 lines
9.6 KiB
C#

//
// System.Web.Caching.OutputCacheModule
//
// Authors:
// Jackson Harper ([email protected])
// Marek Habersack <[email protected]>
//
// (C) 2003-2009 Novell, Inc (http://www.novell.com)
//
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
using System;
using System.Collections;
using System.Collections.Generic;
using System.Configuration.Provider;
using System.IO;
using System.Text;
using System.Web;
using System.Web.Hosting;
using System.Web.UI;
using System.Web.Util;
using System.Web.Compilation;
namespace System.Web.Caching
{
sealed class OutputCacheModule : IHttpModule
{
OutputCacheProvider provider;
CacheItemRemovedCallback response_removed;
static object keysCacheLock = new object ();
Dictionary <string, string> keysCache;
Dictionary <string, string> entriesToInvalidate;
public OutputCacheModule ()
{
}
OutputCacheProvider FindCacheProvider (HttpApplication app)
{
#if NET_4_0
HttpContext ctx = HttpContext.Current;
if (app == null) {
app = ctx != null ? ctx.ApplicationInstance : null;
if (app == null)
throw new InvalidOperationException ("Unable to find output cache provider.");
}
string providerName = app.GetOutputCacheProviderName (ctx);
if (String.IsNullOrEmpty (providerName))
throw new ProviderException ("Invalid OutputCacheProvider name. Name must not be null or an empty string.");
if (String.Compare (providerName, OutputCache.DEFAULT_PROVIDER_NAME, StringComparison.Ordinal) == 0) {
if (provider == null)
provider = new InMemoryOutputCacheProvider ();
return provider;
}
OutputCacheProviderCollection providers = OutputCache.Providers;
OutputCacheProvider ret = providers != null ? providers [providerName] : null;
if (ret == null)
throw new ProviderException (String.Format ("OutputCacheProvider named '{0}' cannot be found.", providerName));
return ret;
#else
if (provider == null)
provider = new InMemoryOutputCacheProvider ();
return provider;
#endif
}
public void Dispose ()
{
}
public void Init (HttpApplication context)
{
context.ResolveRequestCache += new EventHandler(OnResolveRequestCache);
context.UpdateRequestCache += new EventHandler(OnUpdateRequestCache);
response_removed = new CacheItemRemovedCallback (OnRawResponseRemoved);
}
void OnBuildManagerRemoveEntry (BuildManagerRemoveEntryEventArgs args)
{
string entry = args.EntryName;
HttpContext context = args.Context;
string cacheValue;
lock (keysCacheLock) {
if (!keysCache.TryGetValue (entry, out cacheValue))
return;
keysCache.Remove (entry);
if (context == null) {
if (entriesToInvalidate == null) {
entriesToInvalidate = new Dictionary <string, string> (StringComparer.Ordinal);
entriesToInvalidate.Add (entry, cacheValue);
return;
} else if (!entriesToInvalidate.ContainsKey (entry)) {
entriesToInvalidate.Add (entry, cacheValue);
return;
}
}
}
OutputCacheProvider provider = FindCacheProvider (context != null ? context.ApplicationInstance : null);
provider.Remove (entry);
if (!String.IsNullOrEmpty (cacheValue))
provider.Remove (cacheValue);
}
void OnResolveRequestCache (object o, EventArgs args)
{
HttpApplication app = o as HttpApplication;
HttpContext context = app != null ? app.Context : null;
if (context == null)
return;
OutputCacheProvider provider = FindCacheProvider (app);
string vary_key = context.Request.FilePath;
CachedVaryBy varyby = provider.Get (vary_key) as CachedVaryBy;
string key;
CachedRawResponse c;
if (varyby == null)
return;
key = varyby.CreateKey (vary_key, context);
c = provider.Get (key) as CachedRawResponse;
if (c == null)
return;
lock (keysCacheLock) {
string invValue;
if (entriesToInvalidate != null && entriesToInvalidate.TryGetValue (vary_key, out invValue) && String.Compare (invValue, key, StringComparison.Ordinal) == 0) {
provider.Remove (vary_key);
provider.Remove (key);
entriesToInvalidate.Remove (vary_key);
return;
}
}
ArrayList callbacks = c.Policy.ValidationCallbacks;
if (callbacks != null && callbacks.Count > 0) {
bool isValid = true;
bool isIgnored = false;
foreach (Pair p in callbacks) {
HttpCacheValidateHandler validate = (HttpCacheValidateHandler)p.First;
object data = p.Second;
HttpValidationStatus status = HttpValidationStatus.Valid;
try {
validate (context, data, ref status);
} catch {
// MS.NET hides the exception
isValid = false;
break;
}
if (status == HttpValidationStatus.Invalid) {
isValid = false;
break;
} else if (status == HttpValidationStatus.IgnoreThisRequest) {
isIgnored = true;
}
}
if (!isValid) {
OnRawResponseRemoved (key, c, CacheItemRemovedReason.Removed);
return;
} else if (isIgnored)
return;
}
HttpResponse response = context.Response;
response.ClearContent ();
IList cachedData = c.GetData ();
if (cachedData != null) {
Encoding outEnc = WebEncoding.ResponseEncoding;
foreach (CachedRawResponse.DataItem d in cachedData) {
if (d.Length > 0) {
response.BinaryWrite (d.Buffer, 0, (int)d.Length);
continue;
}
if (d.Callback == null)
continue;
string s = d.Callback (context);
if (s == null || s.Length == 0)
continue;
byte[] bytes = outEnc.GetBytes (s);
response.BinaryWrite (bytes, 0, bytes.Length);
}
}
response.ClearHeaders ();
response.SetCachedHeaders (c.Headers);
response.StatusCode = c.StatusCode;
response.StatusDescription = c.StatusDescription;
app.CompleteRequest ();
}
void OnUpdateRequestCache (object o, EventArgs args)
{
HttpApplication app = o as HttpApplication;
HttpContext context = app != null ? app.Context : null;
HttpResponse response = context != null ? context.Response : null;
if (response != null && response.IsCached && response.StatusCode == 200 && !context.Trace.IsEnabled)
DoCacheInsert (context, app, response);
}
void DoCacheInsert (HttpContext context, HttpApplication app, HttpResponse response)
{
string vary_key = context.Request.FilePath;
string key;
OutputCacheProvider provider = FindCacheProvider (app);
CachedVaryBy varyby = provider.Get (vary_key) as CachedVaryBy;
CachedRawResponse prev = null;
bool lookup = true;
string cacheKey = null, cacheValue = null;
HttpCachePolicy cachePolicy = response.Cache;
if (varyby == null) {
varyby = new CachedVaryBy (cachePolicy, vary_key);
provider.Add (vary_key, varyby, Cache.NoAbsoluteExpiration);
lookup = false;
cacheKey = vary_key;
}
key = varyby.CreateKey (vary_key, context);
if (lookup)
prev = provider.Get (key) as CachedRawResponse;
if (prev == null) {
CachedRawResponse c = response.GetCachedResponse ();
if (c != null) {
string [] keys = new string [] { vary_key };
DateTime utcExpiry, absoluteExpiration;
TimeSpan slidingExpiration;
c.VaryBy = varyby;
varyby.ItemList.Add (key);
if (cachePolicy.Sliding) {
slidingExpiration = TimeSpan.FromSeconds (cachePolicy.Duration);
absoluteExpiration = Cache.NoAbsoluteExpiration;
utcExpiry = DateTime.UtcNow + slidingExpiration;
} else {
slidingExpiration = Cache.NoSlidingExpiration;
absoluteExpiration = cachePolicy.Expires;
utcExpiry = absoluteExpiration.ToUniversalTime ();
}
provider.Set (key, c, utcExpiry);
HttpRuntime.InternalCache.Insert (key, c, new CacheDependency (null, keys), absoluteExpiration, slidingExpiration,
CacheItemPriority.Normal, response_removed);
cacheValue = key;
}
}
if (cacheKey != null) {
lock (keysCacheLock) {
if (keysCache == null) {
BuildManager.RemoveEntry += new BuildManagerRemoveEntryEventHandler (OnBuildManagerRemoveEntry);
keysCache = new Dictionary <string, string> (StringComparer.Ordinal);
keysCache.Add (cacheKey, cacheValue);
} else if (!keysCache.ContainsKey (cacheKey))
keysCache.Add (cacheKey, cacheValue);
}
}
}
void OnRawResponseRemoved (string key, object value, CacheItemRemovedReason reason)
{
CachedRawResponse c = value as CachedRawResponse;
CachedVaryBy varyby = c != null ? c.VaryBy : null;
if (varyby == null)
return;
List <string> itemList = varyby.ItemList;
OutputCacheProvider provider = FindCacheProvider (null);
itemList.Remove (key);
provider.Remove (key);
if (itemList.Count != 0)
return;
provider.Remove (varyby.Key);
}
}
}