From 1c9141a9888fd6f9d12354fbdc1f0bd2cca1a3b2 Mon Sep 17 00:00:00 2001
From: Nathan Heskew <nathan.heskew@microsoft.com>
Date: Wed, 1 Sep 2010 15:35:13 -0700
Subject: [PATCH] Refactoring framework (action) filters to use
 IWorkContextAccessor instead of BaseViewModel

--HG--
branch : dev
---
 src/Orchard/Mvc/Html/LayoutExtensions.cs      |  2 +-
 .../Mvc/ViewEngines/LayoutViewEngine.cs       |  4 +-
 src/Orchard/Orchard.Framework.csproj          |  2 +
 src/Orchard/Security/SecurityFilter.cs        | 24 ++---------
 src/Orchard/Themes/ThemeFilter.cs             | 24 +++--------
 .../Admin/Notification/NotificationFilter.cs  |  7 ++--
 src/Orchard/UI/IPage.cs                       |  6 ++-
 src/Orchard/UI/Navigation/MenuFilter.cs       | 20 ++++------
 src/Orchard/UI/Notify/NotifyFilter.cs         | 30 ++++++++------
 src/Orchard/UI/Resources/ResourceFilter.cs    | 40 +++++++++----------
 src/Orchard/WorkContextExtensions.cs          |  9 +++++
 11 files changed, 75 insertions(+), 93 deletions(-)
 create mode 100644 src/Orchard/WorkContextExtensions.cs

diff --git a/src/Orchard/Mvc/Html/LayoutExtensions.cs b/src/Orchard/Mvc/Html/LayoutExtensions.cs
index 87fc99438..43e6c2490 100644
--- a/src/Orchard/Mvc/Html/LayoutExtensions.cs
+++ b/src/Orchard/Mvc/Html/LayoutExtensions.cs
@@ -86,7 +86,7 @@ namespace Orchard.Mvc.Html {
             manager.Render(html, html.ViewData.Model.Zones, null, null, except);
         }
 
-        //public static void ZoneBody<TModel>(this HtmlHelper<TModel> html, string zoneName) where TModel : BaseViewModel {
+        //public static void ZoneBody<TModel>(this HtmlHelper<TModel> html, string zoneName) where TModel  {
         //    html.Zone(zoneName, () => html.RenderBody());
         //}
 
diff --git a/src/Orchard/Mvc/ViewEngines/LayoutViewEngine.cs b/src/Orchard/Mvc/ViewEngines/LayoutViewEngine.cs
index 43f6590b5..de6401aa6 100644
--- a/src/Orchard/Mvc/ViewEngines/LayoutViewEngine.cs
+++ b/src/Orchard/Mvc/ViewEngines/LayoutViewEngine.cs
@@ -24,8 +24,8 @@ namespace Orchard.Mvc.ViewEngines {
             var skipLayoutViewEngine = false;
             if (string.IsNullOrEmpty(masterName) == false)
                 skipLayoutViewEngine = true;
-            //if (!ThemeFilter.IsApplied(controllerContext.RequestContext))
-            //    skipLayoutViewEngine = true;
+            if (!ThemeFilter.IsApplied(controllerContext.RequestContext))
+                skipLayoutViewEngine = true;
             if (_viewEngines == null || _viewEngines.Count == 0)
                 skipLayoutViewEngine = true;
             if (skipLayoutViewEngine)
diff --git a/src/Orchard/Orchard.Framework.csproj b/src/Orchard/Orchard.Framework.csproj
index e9a4ba3e7..372a9cd79 100644
--- a/src/Orchard/Orchard.Framework.csproj
+++ b/src/Orchard/Orchard.Framework.csproj
@@ -407,6 +407,7 @@
     <Compile Include="Environment\IShellContainerRegistrations.cs" />
     <Compile Include="FileSystems\Dependencies\DynamicModuleVirtualPathProvider.cs" />
     <Compile Include="IWorkContextAccessor.cs" />
+    <Compile Include="WorkContextExtensions.cs" />
     <Compile Include="Mvc\Html\Shapes.cs" />
     <Compile Include="Mvc\ViewEngines\Razor\RazorCompilationEventsShim.cs" />
     <Compile Include="Mvc\ViewEngines\Razor\RazorViewEngineProvider.cs" />
@@ -827,6 +828,7 @@
       <Name>ClaySharp</Name>
     </ProjectReference>
   </ItemGroup>
+  <ItemGroup />
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
   <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
        Other similar extension points exist, see Microsoft.Common.targets.
diff --git a/src/Orchard/Security/SecurityFilter.cs b/src/Orchard/Security/SecurityFilter.cs
index 058cebf8f..5f182086e 100644
--- a/src/Orchard/Security/SecurityFilter.cs
+++ b/src/Orchard/Security/SecurityFilter.cs
@@ -2,39 +2,21 @@
 using JetBrains.Annotations;
 using Orchard.Logging;
 using Orchard.Mvc.Filters;
-using Orchard.Mvc.ViewModels;
 
 namespace Orchard.Security {
     [UsedImplicitly]
-    public class SecurityFilter : FilterProvider, IResultFilter, IExceptionFilter {
-        private readonly IAuthenticationService _authenticationService;
-
-        public SecurityFilter(IAuthenticationService authenticationService) {
-            _authenticationService = authenticationService;
+    public class SecurityFilter : FilterProvider, IExceptionFilter {
+        public SecurityFilter() {
             Logger = NullLogger.Instance;
         }
 
         public ILogger Logger { get; set; }
 
-        public void OnResultExecuting(ResultExecutingContext filterContext) {
 #if REFACTORING
-            var baseViewModel = BaseViewModel.From(filterContext.Result);
-            if (baseViewModel == null)
-                return;
-
-            if (baseViewModel.CurrentUser == null)
-                baseViewModel.CurrentUser = _authenticationService.GetAuthenticatedUser();
 #endif
-        }
-
-        public void OnResultExecuted(ResultExecutedContext filterContext) {
-
-        }
-
         public void OnException(ExceptionContext filterContext) {
-            if (!(filterContext.Exception is OrchardSecurityException)) {
+            if (!(filterContext.Exception is OrchardSecurityException))
                 return;
-            }
 
             try {
                 Logger.Information(filterContext.Exception, "Security exception converted to access denied result");
diff --git a/src/Orchard/Themes/ThemeFilter.cs b/src/Orchard/Themes/ThemeFilter.cs
index cca0f9d8d..05923980d 100644
--- a/src/Orchard/Themes/ThemeFilter.cs
+++ b/src/Orchard/Themes/ThemeFilter.cs
@@ -2,12 +2,9 @@ using System.Linq;
 using System.Web.Mvc;
 using System.Web.Routing;
 using Orchard.Mvc.Filters;
-using Orchard.Mvc.ViewModels;
 
 namespace Orchard.Themes {
     public class ThemeFilter : FilterProvider, IActionFilter, IResultFilter {
-
-
         public void OnActionExecuting(ActionExecutingContext filterContext) {
             var attribute = GetThemedAttribute(filterContext.ActionDescriptor);
             if (attribute != null && attribute.Enabled) {
@@ -15,8 +12,7 @@ namespace Orchard.Themes {
             }
         }
 
-        public void OnActionExecuted(ActionExecutedContext filterContext) {
-        }
+        public void OnActionExecuted(ActionExecutedContext filterContext) {}
 
         public void OnResultExecuting(ResultExecutingContext filterContext) {
 #if REFACTORING
@@ -24,34 +20,26 @@ namespace Orchard.Themes {
             if (viewResult == null)
                 return;
 
-            var model = viewResult.ViewData.Model as BaseViewModel;
-            if (model == null)
-                return;
-
             Apply(filterContext.RequestContext);
 #endif
         }
 
-        public void OnResultExecuted(ResultExecutedContext filterContext) {
-            
-        }
+        public void OnResultExecuted(ResultExecutedContext filterContext) {}
 
         public static void Apply(RequestContext context) {
             // the value isn't important
-            context.HttpContext.Items[typeof(ThemeFilter)] = null;
+            context.HttpContext.Items[typeof (ThemeFilter)] = null;
         }
 
         public static bool IsApplied(RequestContext context) {
-            return context.HttpContext.Items.Contains(typeof(ThemeFilter));
+            return context.HttpContext.Items.Contains(typeof (ThemeFilter));
         }
 
-
         private static ThemedAttribute GetThemedAttribute(ActionDescriptor descriptor) {
-            return descriptor.GetCustomAttributes(typeof(ThemedAttribute), true)
-                .Concat(descriptor.ControllerDescriptor.GetCustomAttributes(typeof(ThemedAttribute), true))
+            return descriptor.GetCustomAttributes(typeof (ThemedAttribute), true)
+                .Concat(descriptor.ControllerDescriptor.GetCustomAttributes(typeof (ThemedAttribute), true))
                 .OfType<ThemedAttribute>()
                 .FirstOrDefault();
         }
-
     }
 }
\ No newline at end of file
diff --git a/src/Orchard/UI/Admin/Notification/NotificationFilter.cs b/src/Orchard/UI/Admin/Notification/NotificationFilter.cs
index d838ad92f..8cfb89a6d 100644
--- a/src/Orchard/UI/Admin/Notification/NotificationFilter.cs
+++ b/src/Orchard/UI/Admin/Notification/NotificationFilter.cs
@@ -28,10 +28,9 @@ namespace Orchard.UI.Admin.Notification {
                 return;
 
             var shape = _shapeHelperFactory.CreateHelper();
-            foreach(var messageEntry in messageEntries) {
-                _workContextAccessor.GetContext(filterContext.RequestContext.HttpContext).CurrentPage.Zones["Messages"].Add(shape.Message(messageEntry));
-                // need extension to enable -> _workContextAccessor.GetContext(filterContext).CurrentPage.Zones["Messages"].Add(shape.Message());
-            }
+            var messagesZone = _workContextAccessor.GetContext(filterContext).CurrentPage.Zones["Messages"];
+            foreach(var messageEntry in messageEntries)
+                messagesZone.Add(shape.Message(messageEntry));
         }
 
         public void OnResultExecuted(ResultExecutedContext filterContext) {}
diff --git a/src/Orchard/UI/IPage.cs b/src/Orchard/UI/IPage.cs
index 2e5045bbc..b62983724 100644
--- a/src/Orchard/UI/IPage.cs
+++ b/src/Orchard/UI/IPage.cs
@@ -1,8 +1,8 @@
-using Orchard.UI.Zones;
+using System;
+using System.Web.Mvc;
 
 namespace Orchard.UI {
     public interface IPage {
-
         IZoneCollection Zones { get; }
     }
 
@@ -13,5 +13,7 @@ namespace Orchard.UI {
     public interface IZone {
         void Add(object item);
         void Add(object item, string position);
+        void Add(Action<HtmlHelper> action);
+        void Add(Action<HtmlHelper> action, string position);
     }
 }
\ No newline at end of file
diff --git a/src/Orchard/UI/Navigation/MenuFilter.cs b/src/Orchard/UI/Navigation/MenuFilter.cs
index 40042ecb5..e8cd8e683 100644
--- a/src/Orchard/UI/Navigation/MenuFilter.cs
+++ b/src/Orchard/UI/Navigation/MenuFilter.cs
@@ -1,34 +1,30 @@
 using System.Web.Mvc;
+using Orchard.DisplayManagement;
 using Orchard.Mvc.Filters;
-using Orchard.Mvc.ViewModels;
 using Orchard.UI.Admin;
 
 namespace Orchard.UI.Navigation {
     public class MenuFilter : FilterProvider, IResultFilter {
         private readonly INavigationManager _navigationManager;
         private readonly IWorkContextAccessor _workContextAccessor;
+        private readonly IShapeHelperFactory _shapeHelperFactory;
 
-        public MenuFilter(INavigationManager navigationManager, IWorkContextAccessor workContextAccessor) {
+        public MenuFilter(INavigationManager navigationManager, IWorkContextAccessor workContextAccessor, IShapeHelperFactory shapeHelperFactory) {
             _navigationManager = navigationManager;
             _workContextAccessor = workContextAccessor;
+            _shapeHelperFactory = shapeHelperFactory;
         }
 
         public void OnResultExecuting(ResultExecutingContext filterContext) {
-#if REFACTORING
-            var baseViewModel = BaseViewModel.From(filterContext.Result);
-            if (baseViewModel == null)
-                return;
-
             var menuName = "main";
             if (AdminFilter.IsApplied(filterContext.RequestContext))
                 menuName = "admin";
 
-            baseViewModel.Menu = _navigationManager.BuildMenu(menuName);
-#endif
+            //todo: (heskew) does the menu need to be on Page?
+            var shape = _shapeHelperFactory.CreateHelper();
+            _workContextAccessor.GetContext(filterContext).CurrentPage.Zones["Navigation"].Add(shape.Menu(_navigationManager.BuildMenu(menuName)));
         }
 
-        public void OnResultExecuted(ResultExecutedContext filterContext) {
-
-        }
+        public void OnResultExecuted(ResultExecutedContext filterContext) {}
     }
 }
\ No newline at end of file
diff --git a/src/Orchard/UI/Notify/NotifyFilter.cs b/src/Orchard/UI/Notify/NotifyFilter.cs
index 5e8276202..142b7b02b 100644
--- a/src/Orchard/UI/Notify/NotifyFilter.cs
+++ b/src/Orchard/UI/Notify/NotifyFilter.cs
@@ -3,17 +3,21 @@ using System.Collections.Generic;
 using System.Linq;
 using System.Text;
 using System.Web.Mvc;
+using Orchard.DisplayManagement;
 using Orchard.Localization;
 using Orchard.Mvc.Filters;
-using Orchard.Mvc.ViewModels;
 
 namespace Orchard.UI.Notify {
     public class NotifyFilter : FilterProvider, IActionFilter, IResultFilter {
         private const string TempDataMessages = "messages";
         private readonly INotifier _notifier;
+        private readonly IWorkContextAccessor _workContextAccessor;
+        private readonly IShapeHelperFactory _shapeHelperFactory;
 
-        public NotifyFilter(INotifier notifier) {
+        public NotifyFilter(INotifier notifier, IWorkContextAccessor workContextAccessor, IShapeHelperFactory shapeHelperFactory) {
             _notifier = notifier;
+            _workContextAccessor = workContextAccessor;
+            _shapeHelperFactory = shapeHelperFactory;
         }
 
         public void OnActionExecuting(ActionExecutingContext filterContext) {
@@ -54,11 +58,6 @@ namespace Orchard.UI.Notify {
             if (viewResult == null)
                 return;
 
-            var baseViewModel = BaseViewModel.From(viewResult);
-            // if it's not a view model that holds messages, don't touch temp data either
-            if (baseViewModel == null)
-                return;
-
             var messages = Convert.ToString(viewResult.TempData[TempDataMessages]);
             if (string.IsNullOrEmpty(messages))
                 return;// nothing to do, really
@@ -81,13 +80,20 @@ namespace Orchard.UI.Notify {
                 }
             }
 
-            baseViewModel.Messages = baseViewModel.Messages == null ? messageEntries : baseViewModel.Messages.Union(messageEntries).ToList();
-            baseViewModel.Zones.AddRenderPartial("content:before", "Messages", baseViewModel.Messages);
+            if (!messageEntries.Any())
+                return;
 #endif
+
+            var shape = _shapeHelperFactory.CreateHelper();
+            var messagesZone = _workContextAccessor.GetContext(filterContext).CurrentPage.Zones["Messages"];
+            foreach(var messageEntry in messageEntries)
+                messagesZone.Add(shape.Message(messageEntry));
+
+            //todo: (heskew) probably need to keep duplicate messages from being pushed into the zone like the previous behavior
+            //baseViewModel.Messages = baseViewModel.Messages == null ? messageEntries .Messages.Union(messageEntries).ToList();
+            //baseViewModel.Zones.AddRenderPartial("content:before", "Messages", baseViewModel.Messages);
         }
 
-        public void OnResultExecuted(ResultExecutedContext filterContext) {
-
-        }
+        public void OnResultExecuted(ResultExecutedContext filterContext) {}
     }
 }
\ No newline at end of file
diff --git a/src/Orchard/UI/Resources/ResourceFilter.cs b/src/Orchard/UI/Resources/ResourceFilter.cs
index d5f604259..5e36e0bff 100644
--- a/src/Orchard/UI/Resources/ResourceFilter.cs
+++ b/src/Orchard/UI/Resources/ResourceFilter.cs
@@ -2,38 +2,36 @@ using System.IO;
 using System.Web.Mvc;
 using Orchard.Mvc.Filters;
 using Orchard.Mvc.ViewEngines;
-using Orchard.Mvc.ViewModels;
 
 namespace Orchard.UI.Resources {
 #if REFACTORING
     public class ResourceFilter : FilterProvider, IResultFilter {
         private readonly IResourceManager _resourceManager;
+        private readonly IWorkContextAccessor _workContextAccessor;
 
-        public ResourceFilter(IResourceManager resourceManager) {
+        public ResourceFilter(IResourceManager resourceManager, IWorkContextAccessor workContextAccessor) {
             _resourceManager = resourceManager;
+            _workContextAccessor = workContextAccessor;
         }
 
         public void OnResultExecuting(ResultExecutingContext filterContext) {
-            var model = BaseViewModel.From(filterContext.Result);
-            if (model == null) {
-                return;
-            }
+            var headZone = _workContextAccessor.GetContext().CurrentPage.Zones["Head"];
+            headZone.Add(html => html.ViewContext.Writer.Write(_resourceManager.GetMetas()), ":metas");
+            headZone.Add(html => html.ViewContext.Writer.Write(_resourceManager.GetStyles()), ":styles");
+            headZone.Add(html => html.ViewContext.Writer.Write(_resourceManager.GetLinks(html)), ":links");
+            headZone.Add(html => html.ViewContext.Writer.Write(_resourceManager.GetHeadScripts()), ":scripts");
 
-            model.Zones.AddAction("head:metas", html => html.ViewContext.Writer.Write(_resourceManager.GetMetas()));
-            model.Zones.AddAction("head:styles", html => html.ViewContext.Writer.Write(_resourceManager.GetStyles()));
-            model.Zones.AddAction("head:links", html => html.ViewContext.Writer.Write(_resourceManager.GetLinks(html)));
-            model.Zones.AddAction("head:scripts", html => html.ViewContext.Writer.Write(_resourceManager.GetHeadScripts()));
-            model.Zones.AddAction("body:after", html => {
-                html.ViewContext.Writer.Write(_resourceManager.GetFootScripts());
-                TextWriter captured;
-                if (LayoutViewContext.From(html.ViewContext).Contents.TryGetValue("end-of-page-scripts", out captured)) {
-                    html.ViewContext.Writer.Write(captured);
-                }
-            });
+            _workContextAccessor.GetContext().CurrentPage.Zones["Body"].Add(
+                html => {
+                    html.ViewContext.Writer.Write(_resourceManager.GetFootScripts());
+                    TextWriter captured;
+                    if (LayoutViewContext.From(html.ViewContext).Contents.TryGetValue("end-of-page-scripts", out captured))
+                        html.ViewContext.Writer.Write(captured);
+                },
+                ":after");
         }
 
-        public void OnResultExecuted(ResultExecutedContext filterContext) {
-        }
+        public void OnResultExecuted(ResultExecutedContext filterContext) {}
     }
-#endif
-}
\ No newline at end of file
+}
+#endif
\ No newline at end of file
diff --git a/src/Orchard/WorkContextExtensions.cs b/src/Orchard/WorkContextExtensions.cs
new file mode 100644
index 000000000..ea2c9589e
--- /dev/null
+++ b/src/Orchard/WorkContextExtensions.cs
@@ -0,0 +1,9 @@
+using System.Web.Mvc;
+
+namespace Orchard {
+    public static class WorkContextExtensions {
+        public static WorkContext GetContext(this IWorkContextAccessor workContextAccessor, ControllerContext controllerContext) {
+            return workContextAccessor.GetContext(controllerContext.RequestContext.HttpContext);
+        }
+    }
+}