private string GetPathFromGeneralName(ControllerContext controllerContext, IEnumerable <ViewLocation> locations, IDisplayMode displayMode, string name, string controllerName, string areaName, string cacheKey, out IList <string> searchedLocations)
{
searchedLocations = new List <string>();
// Iterate through the locations.
foreach (var location in locations)
{
var virtualPath = location.Format(name, controllerName, areaName);
var virtualPathDisplayInfo = DisplayModeProvider.GetDisplayInfoForVirtualPath(virtualPath, controllerContext.HttpContext, path => FileExists(controllerContext, path), controllerContext.DisplayMode);
if (virtualPathDisplayInfo != null)
{
// Found a path for a view for a display mode. Cache it against the most specific display mode.
var resolvedVirtualPath = virtualPathDisplayInfo.FilePath;
ViewLocationCache.InsertViewLocation(controllerContext.HttpContext, AppendDisplayModeToCacheKey(cacheKey, displayMode.DisplayModeId), resolvedVirtualPath);
if (controllerContext.DisplayMode == null)
{
controllerContext.DisplayMode = virtualPathDisplayInfo.DisplayMode;
}
searchedLocations.Clear();
return(resolvedVirtualPath);
}
searchedLocations.Add(virtualPath);
}
// Even though it does not exist add it to the cache so that all subsequent lookups don't have to check again.
ViewLocationCache.InsertViewLocation(controllerContext.HttpContext, AppendDisplayModeToCacheKey(cacheKey, displayMode.DisplayModeId), DoesNotExist);
return(string.Empty);
}
public void GetDisplayInfoForVirtualPathWithConsistentDisplayModeBeginsSearchAtCurrentDisplayMode()
{
// Arrange
Mock<HttpContextBase> httpContext = new Mock<HttpContextBase>(MockBehavior.Strict);
var displayModeProvider = new DisplayModeProvider();
displayModeProvider.Modes.Clear();
var displayMode1 = new Mock<IDisplayMode>(MockBehavior.Strict);
displayMode1.Setup(d => d.CanHandleContext(It.IsAny<HttpContextBase>())).Returns(true);
displayModeProvider.Modes.Add(displayMode1.Object);
var displayMode2 = new Mock<IDisplayMode>(MockBehavior.Strict);
displayMode2.Setup(d => d.CanHandleContext(It.IsAny<HttpContextBase>())).Returns(false);
displayModeProvider.Modes.Add(displayMode2.Object);
var displayMode3 = new Mock<IDisplayMode>(MockBehavior.Strict);
displayMode3.Setup(d => d.CanHandleContext(It.IsAny<HttpContextBase>())).Returns(true);
displayModeProvider.Modes.Add(displayMode3.Object);
var displayInfo = new DisplayInfo("Foo", displayMode3.Object);
Func<string, bool> fileExists = path => true;
displayMode3.Setup(d => d.GetDisplayInfo(httpContext.Object, "path", fileExists)).Returns(displayInfo);
// Act
DisplayInfo result = displayModeProvider.GetDisplayInfoForVirtualPath("path", httpContext.Object, fileExists, currentDisplayMode: displayMode2.Object,
requireConsistentDisplayMode: true);
// Assert
Assert.Same(displayInfo, result);
}
public void GetDisplayInfoForVirtualPathWithoutConsistentDisplayModeIgnoresCurrentDisplayMode()
{
// Arrange
Mock <HttpContextBase> httpContext = new Mock <HttpContextBase>(MockBehavior.Strict);
var displayModeProvider = new DisplayModeProvider();
displayModeProvider.Modes.Clear();
var displayMode1 = new Mock <IDisplayMode>(MockBehavior.Strict);
displayMode1.Setup(d => d.CanHandleContext(It.IsAny <HttpContextBase>())).Returns(true);
displayModeProvider.Modes.Add(displayMode1.Object);
var displayMode2 = new Mock <IDisplayMode>(MockBehavior.Strict);
displayMode2.Setup(d => d.CanHandleContext(It.IsAny <HttpContextBase>())).Returns(false);
displayModeProvider.Modes.Add(displayMode2.Object);
var displayMode3 = new Mock <IDisplayMode>(MockBehavior.Strict);
displayMode3.Setup(d => d.CanHandleContext(It.IsAny <HttpContextBase>())).Returns(true);
displayModeProvider.Modes.Add(displayMode3.Object);
var displayInfo = new DisplayInfo("Foo", displayMode3.Object);
Func <string, bool> fileExists = path => true;
displayMode1.Setup(d => d.GetDisplayInfo(httpContext.Object, "path", fileExists)).Returns(displayInfo);
// Act
DisplayInfo result = displayModeProvider.GetDisplayInfoForVirtualPath("path", httpContext.Object, fileExists, currentDisplayMode: displayMode1.Object,
requireConsistentDisplayMode: false);
// Assert
Assert.Same(displayInfo, result);
}
public void GetDisplayInfoForVirtualPathReturnsDisplayInfoFromFirstDisplayModeToHandleRequest()
{
// Arrange
var displayModeProvider = new DisplayModeProvider();
displayModeProvider.Modes.Clear();
var displayMode1 = new Mock<IDisplayMode>(MockBehavior.Strict);
displayMode1.Setup(d => d.CanHandleContext(It.IsAny<HttpContextBase>())).Returns(false);
displayModeProvider.Modes.Add(displayMode1.Object);
var displayMode2 = new Mock<IDisplayMode>(MockBehavior.Strict);
displayMode2.Setup(d => d.CanHandleContext(It.IsAny<HttpContextBase>())).Returns(false);
displayModeProvider.Modes.Add(displayMode2.Object);
var displayMode3 = new Mock<IDisplayMode>(MockBehavior.Strict);
displayMode3.Setup(d => d.CanHandleContext(It.IsAny<HttpContextBase>())).Returns(true);
displayModeProvider.Modes.Add(displayMode3.Object);
Mock<HttpContextBase> httpContext = new Mock<HttpContextBase>(MockBehavior.Strict);
var expected = new DisplayInfo("Foo", displayMode3.Object);
Func<string, bool> fileExists = path => true;
displayMode3.Setup(d => d.GetDisplayInfo(httpContext.Object, "path", fileExists)).Returns(expected);
// Act
DisplayInfo result = displayModeProvider.GetDisplayInfoForVirtualPath("path", httpContext.Object, fileExists, currentDisplayMode: null);
// Assert
Assert.Same(expected, result);
}
public void GetDisplayInfoForVirtualPathReturnsDisplayInfoFromFirstDisplayModeToHandleRequest()
{
// Arrange
var displayModeProvider = new DisplayModeProvider();
displayModeProvider.Modes.Clear();
var displayMode1 = new Mock <IDisplayMode>(MockBehavior.Strict);
displayMode1.Setup(d => d.CanHandleContext(It.IsAny <HttpContextBase>())).Returns(false);
displayModeProvider.Modes.Add(displayMode1.Object);
var displayMode2 = new Mock <IDisplayMode>(MockBehavior.Strict);
displayMode2.Setup(d => d.CanHandleContext(It.IsAny <HttpContextBase>())).Returns(false);
displayModeProvider.Modes.Add(displayMode2.Object);
var displayMode3 = new Mock <IDisplayMode>(MockBehavior.Strict);
displayMode3.Setup(d => d.CanHandleContext(It.IsAny <HttpContextBase>())).Returns(true);
displayModeProvider.Modes.Add(displayMode3.Object);
Mock <HttpContextBase> httpContext = new Mock <HttpContextBase>(MockBehavior.Strict);
var expected = new DisplayInfo("Foo", displayMode3.Object);
Func <string, bool> fileExists = path => true;
displayMode3.Setup(d => d.GetDisplayInfo(httpContext.Object, "path", fileExists)).Returns(expected);
// Act
DisplayInfo result = displayModeProvider.GetDisplayInfoForVirtualPath("path", httpContext.Object, fileExists, currentDisplayMode: null);
// Assert
Assert.Same(expected, result);
}
public void GetDisplayModesForRequestReturnsNullIfNoDisplayModesHandleRequest()
{
// Arrange
Mock <HttpContextBase> httpContext = new Mock <HttpContextBase>(MockBehavior.Strict);
var displayModeProvider = new DisplayModeProvider();
displayModeProvider.Modes.Clear();
var displayMode1 = new Mock <IDisplayMode>(MockBehavior.Strict);
displayMode1.Setup(d => d.CanHandleContext(It.IsAny <HttpContextBase>())).Returns(false);
displayModeProvider.Modes.Add(displayMode1.Object);
var displayMode2 = new Mock <IDisplayMode>(MockBehavior.Strict);
displayMode2.Setup(d => d.CanHandleContext(It.IsAny <HttpContextBase>())).Returns(false);
displayModeProvider.Modes.Add(displayMode2.Object);
var displayMode3 = new Mock <IDisplayMode>(MockBehavior.Strict);
displayMode3.Setup(d => d.CanHandleContext(It.IsAny <HttpContextBase>())).Returns(false);
displayModeProvider.Modes.Add(displayMode3.Object);
// Act
DisplayInfo displayModeForRequest = displayModeProvider.GetDisplayInfoForVirtualPath("path", httpContext.Object, path => false, currentDisplayMode: null);
// Assert
Assert.Null(displayModeForRequest);
}
protected virtual string GetPathFromGeneralName(ControllerContext controllerContext, List <ViewLocation> locations, string name, string controllerName, string areaName, string theme, string cacheKey, ref string[] searchedLocations)
{
string result = string.Empty;
searchedLocations = new string[locations.Count];
for (int index = 0; index < locations.Count; index++)
{
var location = locations[index];
string virtualPath = location.Format(name, controllerName, areaName, theme);
var virtualPathDisplayInfo = DisplayModeProvider.GetDisplayInfoForVirtualPath(virtualPath, controllerContext.HttpContext, path => FileExists(controllerContext, path), controllerContext.DisplayMode);
if (virtualPathDisplayInfo != null)
{
string resolvedVirtualPath = virtualPathDisplayInfo.FilePath;
searchedLocations = EmptyLocations;
result = resolvedVirtualPath;
ViewLocationCache.InsertViewLocation(controllerContext.HttpContext, AppendDisplayModeToCacheKey(cacheKey, virtualPathDisplayInfo.DisplayMode.DisplayModeId), result);
if (controllerContext.DisplayMode == null)
{
controllerContext.DisplayMode = virtualPathDisplayInfo.DisplayMode;
}
// Populate the cache for all other display modes. We want to cache both file system hits and misses so that we can distinguish
// in future requests whether a file's status was evicted from the cache (null value) or if the file doesn't exist (empty string).
IEnumerable <IDisplayMode> allDisplayModes = DisplayModeProvider.Modes;
foreach (var displayMode in allDisplayModes)
{
if (displayMode.DisplayModeId != virtualPathDisplayInfo.DisplayMode.DisplayModeId)
{
var displayInfoToCache = displayMode.GetDisplayInfo(controllerContext.HttpContext, virtualPath, virtualPathExists: path => FileExists(controllerContext, path));
string cacheValue = string.Empty;
if (displayInfoToCache?.FilePath != null)
{
cacheValue = displayInfoToCache.FilePath;
}
ViewLocationCache.InsertViewLocation(controllerContext.HttpContext, AppendDisplayModeToCacheKey(cacheKey, displayMode.DisplayModeId), cacheValue);
}
}
break;
}
searchedLocations[index] = virtualPath;
}
return(result);
}
private string GetPathFromGeneralName(ControllerContext controllerContext, List <ViewLocation> locations,
string name, string controllerName, string areaName, string rootFolder, string cacheKey,
ref string[] searchedLocations)
{
var result = string.Empty;
searchedLocations = new string[locations.Count];
for (var i = 0; i < locations.Count; i++)
{
var location = locations[i];
var virtualPath = location.Format(name, controllerName, areaName, rootFolder);
var virtualPathDisplayInfo = DisplayModeProvider.GetDisplayInfoForVirtualPath(virtualPath,
controllerContext.HttpContext, path => FileExists(controllerContext, path),
controllerContext.DisplayMode);
if (virtualPathDisplayInfo != null)
{
var resolvedVirtualPath = virtualPathDisplayInfo.FilePath;
searchedLocations = _emptyLocations;
result = resolvedVirtualPath;
ViewLocationCache.InsertViewLocation(controllerContext.HttpContext,
AppendDisplayModeToCacheKey(cacheKey, virtualPathDisplayInfo.DisplayMode.DisplayModeId), result);
if (controllerContext.DisplayMode == null)
{
controllerContext.DisplayMode = virtualPathDisplayInfo.DisplayMode;
}
// Populate the cache with the existing paths returned by all display modes.
// Since we currently don't keep track of cache misses, if we cache view.aspx on a request from a standard browser
// we don't want a cache hit for view.aspx from a mobile browser so we populate the cache with view.Mobile.aspx.
IEnumerable <IDisplayMode> allDisplayModes = DisplayModeProvider.Modes;
foreach (var displayMode in allDisplayModes)
{
if (displayMode.DisplayModeId != virtualPathDisplayInfo.DisplayMode.DisplayModeId)
{
var displayInfoToCache = displayMode.GetDisplayInfo(controllerContext.HttpContext,
virtualPath, path => FileExists(controllerContext, path));
if (displayInfoToCache != null && displayInfoToCache.FilePath != null)
{
ViewLocationCache.InsertViewLocation(controllerContext.HttpContext,
AppendDisplayModeToCacheKey(cacheKey, displayInfoToCache.DisplayMode.DisplayModeId),
displayInfoToCache.FilePath);
}
}
}
break;
}
searchedLocations[i] = virtualPath;
}
return(result);
}
public void GetDisplayModesForRequestReturnsNullIfNoDisplayModesHandleRequest()
{
// Arrange
Mock<HttpContextBase> httpContext = new Mock<HttpContextBase>(MockBehavior.Strict);
var displayModeProvider = new DisplayModeProvider();
displayModeProvider.Modes.Clear();
var displayMode1 = new Mock<IDisplayMode>(MockBehavior.Strict);
displayMode1.Setup(d => d.CanHandleContext(It.IsAny<HttpContextBase>())).Returns(false);
displayModeProvider.Modes.Add(displayMode1.Object);
var displayMode2 = new Mock<IDisplayMode>(MockBehavior.Strict);
displayMode2.Setup(d => d.CanHandleContext(It.IsAny<HttpContextBase>())).Returns(false);
displayModeProvider.Modes.Add(displayMode2.Object);
var displayMode3 = new Mock<IDisplayMode>(MockBehavior.Strict);
displayMode3.Setup(d => d.CanHandleContext(It.IsAny<HttpContextBase>())).Returns(false);
displayModeProvider.Modes.Add(displayMode3.Object);
// Act
DisplayInfo displayModeForRequest = displayModeProvider.GetDisplayInfoForVirtualPath("path", httpContext.Object, path => false, currentDisplayMode: null);
// Assert
Assert.Null(displayModeForRequest);
}
protected override string GetPathFromGeneralName(
ControllerContext controllerContext,
List <ViewLocation> locations,
string name,
string controllerName,
string areaName,
string theme,
string cacheKey,
ref string[] searchedLocations)
{
var parentThemes = LoadParentThemes(theme);
string result = string.Empty;
var checkedLocations = new List <string>();
for (int i = 0; i < locations.Count; i++)
{
var location = locations[i];
string virtualPath = location.Format(name, controllerName, areaName, theme);
var virtualPathDisplayInfo = DisplayModeProvider.GetDisplayInfoForVirtualPath(
virtualPath,
controllerContext.HttpContext,
path => FileExists(controllerContext, path),
controllerContext.DisplayMode);
if (virtualPathDisplayInfo == null && virtualPath.IndexOf("/Themes/", StringComparison.InvariantCultureIgnoreCase) > -1)
{
// We're checking themes location. Try parent themes as well.
foreach (var parentTheme in parentThemes)
{
// 1. Track the last checked location
checkedLocations.Add(virtualPath);
// 2. Try parent theme
virtualPath = location.Format(name, controllerName, areaName, parentTheme);
virtualPathDisplayInfo = DisplayModeProvider.GetDisplayInfoForVirtualPath(
virtualPath,
controllerContext.HttpContext,
path => FileExists(controllerContext, path),
controllerContext.DisplayMode);
if (virtualPathDisplayInfo != null)
{
// 3. We found target view in the parent theme
break;
}
}
}
if (virtualPathDisplayInfo != null)
{
string resolvedVirtualPath = virtualPathDisplayInfo.FilePath;
checkedLocations.Clear();
result = resolvedVirtualPath;
ViewLocationCache.InsertViewLocation(
controllerContext.HttpContext,
AppendDisplayModeToCacheKey(cacheKey, virtualPathDisplayInfo.DisplayMode.DisplayModeId), result);
if (controllerContext.DisplayMode == null)
{
controllerContext.DisplayMode = virtualPathDisplayInfo.DisplayMode;
}
var allDisplayModes = DisplayModeProvider.Modes;
foreach (IDisplayMode displayMode in allDisplayModes)
{
if (displayMode.DisplayModeId != virtualPathDisplayInfo.DisplayMode.DisplayModeId)
{
var displayInfoToCache = displayMode.GetDisplayInfo(controllerContext.HttpContext, virtualPath, virtualPathExists: path => FileExists(controllerContext, path));
string cacheValue = string.Empty;
if (displayInfoToCache != null && displayInfoToCache.FilePath != null)
{
cacheValue = displayInfoToCache.FilePath;
}
ViewLocationCache.InsertViewLocation(
controllerContext.HttpContext,
AppendDisplayModeToCacheKey(cacheKey, displayMode.DisplayModeId), cacheValue);
}
}
break;
}
checkedLocations.Add(virtualPath);
}
searchedLocations = checkedLocations.ToArray();
return(result);
}
