File: DynamicDataRouteHandler.cs

package info (click to toggle)
mono 6.12.0.199%2Bdfsg-6
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 1,296,836 kB
  • sloc: cs: 11,181,803; xml: 2,850,076; ansic: 699,709; cpp: 123,344; perl: 59,361; javascript: 30,841; asm: 21,853; makefile: 20,405; sh: 15,009; python: 4,839; pascal: 925; sql: 859; sed: 16; php: 1
file content (226 lines) | stat: -rw-r--r-- 9,994 bytes parent folder | download | duplicates (9)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
using System.Collections.Generic;
using System.Diagnostics;
using System.Globalization;
using System.Web.Compilation;
using System.Web.Hosting;
using System.Web.Routing;
using System.Web.UI;

namespace System.Web.DynamicData {
    /// <summary>
    /// Route handler used for Dynamic Data
    /// </summary>
    public class DynamicDataRouteHandler : IRouteHandler {

        private static object s_requestContextKey = new object();
        private static object s_metaTableKey = new object();

        private object _requestItemsKey = new object();

        /// <summary>
        /// ctor
        /// </summary>
        public DynamicDataRouteHandler() {
            VirtualPathProvider = HostingEnvironment.VirtualPathProvider;
            CreateHandlerCallback = delegate(string s) {
                return (Page)BuildManager.CreateInstanceFromVirtualPath(s, typeof(Page));
            };
        }

        /// <summary>
        /// The MetaModel that the handler is associated with
        /// </summary>
        public MetaModel Model { get; internal set; }

        // the following properties are for mocking purposes
        internal VirtualPathProvider VirtualPathProvider { get; set; }
        private HttpContextBase _context;
        internal HttpContextBase HttpContext {
            get {
                return _context ?? new HttpContextWrapper(System.Web.HttpContext.Current);
            }
            set { _context = value; }
        }
        internal Func<string, IHttpHandler> CreateHandlerCallback { get; set; }

        /// <summary>
        /// Create a handler to process a Dynamic Data request
        /// </summary>
        /// <param name="route">The Route that was matched</param>
        /// <param name="table">The MetaTable found in the route</param>
        /// <param name="action">The Action found in the route</param>
        /// <returns></returns>
        public virtual IHttpHandler CreateHandler(DynamicDataRoute route, MetaTable table, string action) {
            // First, get the path to the page (could be custom, shared, or null)
            string virtualPath = GetPageVirtualPath(route, table, action);

            if (virtualPath != null) {
                // Gets called only for custom pages that we know exist or templates that may or may not
                // exist. This method will throw if virtualPath does not exist, which is fine for templates
                // but is not fine for custom pages.
                return CreateHandlerCallback(virtualPath);
            } else {
                // This should only occur in the event that scaffolding is disabled and the custom page
                // virtual path does not exist.
                return null;
            }
        }

        private string GetPageVirtualPath(DynamicDataRoute route, MetaTable table, string action) {
            long cacheKey = Misc.CombineHashCodes(table, route.ViewName ?? action);

            Dictionary<long, string> virtualPathCache = GetVirtualPathCache();

            string virtualPath;
            if (!virtualPathCache.TryGetValue(cacheKey, out virtualPath)) {
                virtualPath = GetPageVirtualPathNoCache(route, table, action);
                lock (virtualPathCache) {
                    virtualPathCache[cacheKey] = virtualPath;
                }
            }
            return virtualPath;
        }

        private Dictionary<long, string> GetVirtualPathCache() {
            var httpContext = HttpContext;
            Dictionary<long, string> virtualPathCache = (Dictionary<long, string>)httpContext.Items[_requestItemsKey];
            if (virtualPathCache == null) {
                virtualPathCache = new Dictionary<long, string>();
                httpContext.Items[_requestItemsKey] = virtualPathCache;
            }
            return virtualPathCache;
        }

        private string GetPageVirtualPathNoCache(DynamicDataRoute route, MetaTable table, string action) {
            // The view name defaults to the action
            string viewName = route.ViewName ?? action;

            // First, get the path to the custom page
            string customPageVirtualPath = GetCustomPageVirtualPath(table, viewName);

            if (VirtualPathProvider.FileExists(customPageVirtualPath)) {
                return customPageVirtualPath;
            } else {
                if (table.Scaffold) {
                    // If it doesn't exist, try the scaffolded page, but only if scaffolding is enabled on this table
                    return GetScaffoldPageVirtualPath(table, viewName);
                } else {
                    // If scaffolding is disabled, null the path so BuildManager doesn't get called.
                    return null;
                }
            }
        }

        /// <summary>
        /// Build the path to a custom page. By default, it looks like ~/DynamicData/CustomPages/[tablename]/[viewname].aspx
        /// </summary>
        /// <param name="table">The MetaTable that the page is for</param>
        /// <param name="viewName">The view name</param>
        /// <returns></returns>
        protected virtual string GetCustomPageVirtualPath(MetaTable table, string viewName) {
            string pathPattern = "{0}CustomPages/{1}/{2}.aspx";
            return String.Format(CultureInfo.InvariantCulture, pathPattern, Model.DynamicDataFolderVirtualPath, table.Name, viewName);
        }

        /// <summary>
        /// Build the path to a page template. By default, it looks like ~/DynamicData/PageTemplates/[tablename]/[viewname].aspx
        /// </summary>
        /// <param name="table">The MetaTable that the page is for</param>
        /// <param name="viewName">The view name</param>
        /// <returns></returns>
        protected virtual string GetScaffoldPageVirtualPath(MetaTable table, string viewName) {
            string pathPattern = "{0}PageTemplates/{1}.aspx";
            return String.Format(CultureInfo.InvariantCulture, pathPattern, Model.DynamicDataFolderVirtualPath, viewName);
        }

        /// <summary>
        /// Return the RequestContext for this request. A new one is created if needed (can happen if the current request
        /// is not a Dynamic Data request)
        /// </summary>
        /// <param name="httpContext">The current HttpContext</param>
        /// <returns>The RequestContext</returns>
        public static RequestContext GetRequestContext(HttpContext httpContext) {
            if (httpContext == null) {
                throw new ArgumentNullException("httpContext");
            }

            return GetRequestContext(new HttpContextWrapper(httpContext));
        }

        internal static RequestContext GetRequestContext(HttpContextBase httpContext) {
            Debug.Assert(httpContext != null);

            // Look for the RequestContext in the HttpContext
            var requestContext = httpContext.Items[s_requestContextKey] as RequestContext;

            // If the current request didn't go through the routing engine (e.g. normal page),
            // there won't be a RequestContext.  If so, create a new one and save it
            if (requestContext == null) {
                var routeData = new RouteData();
                requestContext = new RequestContext(httpContext, routeData);

                // Add the query string params to the route data.  This allows non routed pages to support filtering.
                DynamicDataRoute.AddQueryStringParamsToRouteData(httpContext, routeData);

                httpContext.Items[s_requestContextKey] = requestContext;
            }

            return requestContext;
        }

        /// <summary>
        /// The MetaTable associated with the current HttpRequest. Can be null for non-Dynamic Data requests.
        /// </summary>
        /// <param name="httpContext">The current HttpContext</param>
        public static MetaTable GetRequestMetaTable(HttpContext httpContext) {
            if (httpContext == null) {
                throw new ArgumentNullException("httpContext");
            }

            return GetRequestMetaTable(new HttpContextWrapper(httpContext));
        }

        internal static MetaTable GetRequestMetaTable(HttpContextBase httpContext) {
            Debug.Assert(httpContext != null);

            return (MetaTable)httpContext.Items[s_metaTableKey];
        }

        /// <summary>
        /// Set the MetaTable associated with the current HttpRequest.  Normally, this is set automatically from the
        /// route, but this method is useful to set the table when used outside of routing.
        /// </summary>
        public static void SetRequestMetaTable(HttpContext httpContext, MetaTable table) {
            SetRequestMetaTable(new HttpContextWrapper(httpContext), table);
        }

        internal static void SetRequestMetaTable(HttpContextBase httpContext, MetaTable table) {
            Debug.Assert(httpContext != null);

            httpContext.Items[s_metaTableKey] = table;
        }

        #region IRouteHandler Members
        IHttpHandler IRouteHandler.GetHttpHandler(RequestContext requestContext) {
            // Save the RequestContext
            Debug.Assert(requestContext.HttpContext.Items[s_requestContextKey] == null);
            requestContext.HttpContext.Items[s_requestContextKey] = requestContext;

            // Get the dynamic route
            var route = (DynamicDataRoute)requestContext.RouteData.Route;

            // Get the Model from the route
            MetaModel model = route.Model;

            // Get the MetaTable and save it in the HttpContext
            MetaTable table = route.GetTableFromRouteData(requestContext.RouteData);
            requestContext.HttpContext.Items[s_metaTableKey] = table;

            // Get the action from the request context
            string action = route.GetActionFromRouteData(requestContext.RouteData);

            return CreateHandler(route, table, action);
        }
        #endregion
    }
}