ActiveRecord/Castle.ActiveRecord/Framework/SessionScopeWebModule.cs

   1 // Copyright 2004-2007 Castle Project - http://www.castleproject.org/
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License");
   4 // you may not use this file except in compliance with the License.
   5 // You may obtain a copy of the License at
   6 //
   7 //     http://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS,
  11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 // See the License for the specific language governing permissions and
  13 // limitations under the License.
  14
  15 namespace Castle.ActiveRecord.Framework
  16 {
  17         using System;
  18         using System.Web;
  19         using Castle.ActiveRecord.Framework.Scopes;
  20
  21         /// <summary>
  22         /// HttpModule to set up a session for the request lifetime.
  23         /// <seealso cref="SessionScope"/>
  24         /// </summary>
  25         /// <remarks>
  26         /// To install the module, you must:
  27         /// <para>
  28         ///    <list type="number">
  29         ///      <item>
  30         ///        <description>
  31         ///        Add the module to the <c>httpModules</c> configuration section within <c>system.web</c>
  32         ///        </description>
  33         ///      </item>
  34         ///    </list>
  35         /// </para>
  36         /// </remarks>
  37         public class SessionScopeWebModule : IHttpModule
  38         {
  39                 /// <summary>
  40                 /// The key used to store the session in the context items
  41                 /// </summary>
  42                 protected static readonly String SessionKey = "SessionScopeWebModule.session";
  43
  44                 /// <summary>
  45                 /// Used to check whether the ThreadScopeInfo being used is suitable for a web environment
  46                 /// </summary>
  47                 private static bool isWebConfigured;
  48
  49                 /// <summary>
  50                 /// Initialize the module.
  51                 /// </summary>
  52                 /// <param name="app">The app.</param>
  53                 public void Init(HttpApplication app)
  54                 {
  55                         if (ActiveRecordBase.holder == null)
  56                         {
  57                                 // Not properly initialized, most probably due to a container initialization failure
  58                                 // We cannot throw an exception as it will hide the original error, so we just
  59                                 // skip our process completely
  60
  61                                 return;
  62                         }
  63
  64                         app.BeginRequest += new EventHandler(OnBeginRequest);
  65                         app.EndRequest += new EventHandler(OnEndRequest);
  66
  67                         isWebConfigured = (ActiveRecordBase.holder.ThreadScopeInfo is WebThreadScopeInfo);
  68                 }
  69
  70                 /// <summary>
  71                 /// Disposes of the resources (other than memory) used by the module that implements <see cref="T:System.Web.IHttpModule"></see>.
  72                 /// </summary>
  73                 public void Dispose()
  74                 {
  75                 }
  76
  77                 /// <summary>
  78                 /// Called when request is started, create a session for the request
  79                 /// </summary>
  80                 /// <param name="sender">The sender.</param>
  81                 /// <param name="e">The <see cref="System.EventArgs"/> instance containing the event data.</param>
  82                 private void OnBeginRequest(object sender, EventArgs e)
  83                 {
  84                         if (isWebConfigured)
  85                         {
  86                                 HttpContext.Current.Items.Add(SessionKey, new SessionScope());
  87                         }
  88                         else
  89                         {
  90                                 throw new ActiveRecordException("Seems that the framework isn't configured properly. (isWeb != true and SessionScopeWebModule is in use) Check the documentation for further information");
  91                         }
  92                 }
  93
  94                 /// <summary>
  95                 /// Called when the request ends, dipose of the scope
  96                 /// </summary>
  97                 /// <param name="sender">The sender.</param>
  98                 /// <param name="e">The <see cref="System.EventArgs"/> instance containing the event data.</param>
  99                 private void OnEndRequest(object sender, EventArgs e)
 100                 {
 101                         SessionScope session = (SessionScope) HttpContext.Current.Items[SessionKey];
 102
 103                         if (session != null)
 104                         {
 105                                 session.Dispose();
 106                         }
 107                 }
 108         }
 109 }