f7f83bc057
an UmbracoHelper property to the PluginController class which will expose any methods needed by devs to retreive media or content. Have updated UmbracoHelper with loads of new helpful methods and moved the Wrap methods to HtmlHelper extensions because this is purely to do with rendering html (have written unit tests for it too). Updated some 'library' methods to proxy calls to UmbracoHelper so we only have to maintain one set of code. Added a convenience property to UmbracoContext to return the current NiceUrlProvider so you don't have to go through the RoutingContext to get it.
298 lines
9.9 KiB
C#
298 lines
9.9 KiB
C#
using System;
|
||
using System.Web;
|
||
using Umbraco.Core;
|
||
using Umbraco.Web.Routing;
|
||
using umbraco;
|
||
using umbraco.IO;
|
||
using umbraco.presentation;
|
||
using umbraco.presentation.LiveEditing;
|
||
using umbraco.BasePages;
|
||
using umbraco.cms.businesslogic.web;
|
||
using umbraco.BusinessLogic;
|
||
using System.Xml;
|
||
using umbraco.presentation.preview;
|
||
using Examine.Providers;
|
||
using Examine;
|
||
|
||
namespace Umbraco.Web
|
||
{
|
||
|
||
/// <summary>
|
||
/// Class that encapsulates Umbraco information of a specific HTTP request
|
||
/// </summary>
|
||
public class UmbracoContext
|
||
{
|
||
|
||
private const string HttpContextItemName = "Umbraco.Web.UmbracoContext";
|
||
private static readonly object Locker = new object();
|
||
|
||
private PreviewContent _previewContent;
|
||
|
||
/// <summary>
|
||
/// Used if not running in a web application (no real HttpContext)
|
||
/// </summary>
|
||
private static UmbracoContext _umbracoContext;
|
||
|
||
/// <summary>
|
||
/// Creates a new Umbraco context.
|
||
/// </summary>
|
||
/// <param name="httpContext"></param>
|
||
/// <param name="applicationContext"> </param>
|
||
/// <param name="routesCache"> </param>
|
||
internal UmbracoContext(
|
||
HttpContextBase httpContext,
|
||
ApplicationContext applicationContext,
|
||
IRoutesCache routesCache)
|
||
{
|
||
if (httpContext == null) throw new ArgumentNullException("httpContext");
|
||
if (applicationContext == null) throw new ArgumentNullException("applicationContext");
|
||
|
||
HttpContext = httpContext;
|
||
Application = applicationContext;
|
||
RoutesCache = routesCache;
|
||
|
||
// set the urls
|
||
this.RequestUrl = httpContext.Request.Url;
|
||
//RawUrl gets preserved across rewrites
|
||
this.ClientUrl = UriUtility.ToFullUrl(httpContext.Request.RawUrl, httpContext);
|
||
|
||
//// from IIS Rewrite Module documentation:
|
||
//// "The URL Rewrite Module preserves the original requested URL path in the following server variables:
|
||
//// - HTTP_X_ORIGINAL_URL – this server variable contains the original URL in decoded format;
|
||
//// - UNENCODED_URL – this server variable contains the original URL exactly as it was requested by a Web client, with all original encoding preserved."
|
||
////
|
||
//// see also http://forums.iis.net/t/1152581.aspx
|
||
////
|
||
//var iisOrig = httpContext.Request.ServerVariables["HTTP_X_ORIGINAL_URL"];
|
||
//if (!string.IsNullOrWhiteSpace(iisOrig))
|
||
// this.ClientUrl = new Uri(iisOrig);
|
||
}
|
||
|
||
/// <summary>
|
||
/// Gets the current Umbraco Context.
|
||
/// </summary>
|
||
public static UmbracoContext Current
|
||
{
|
||
get
|
||
{
|
||
//if we have a real context then return the request based object
|
||
if (System.Web.HttpContext.Current != null)
|
||
{
|
||
return (UmbracoContext)System.Web.HttpContext.Current.Items[HttpContextItemName];
|
||
}
|
||
|
||
//return the object if not running in a real HttpContext
|
||
return _umbracoContext;
|
||
}
|
||
|
||
set
|
||
{
|
||
lock (Locker)
|
||
{
|
||
//if running in a real HttpContext, this can only be set once
|
||
if (System.Web.HttpContext.Current != null && Current != null)
|
||
{
|
||
throw new ApplicationException("The current httpContext can only be set once during a request.");
|
||
}
|
||
|
||
//if there is an HttpContext, return the item
|
||
if (System.Web.HttpContext.Current != null)
|
||
{
|
||
System.Web.HttpContext.Current.Items[HttpContextItemName] = value;
|
||
}
|
||
else
|
||
{
|
||
_umbracoContext = value;
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
/// <summary>
|
||
/// Gets the current ApplicationContext
|
||
/// </summary>
|
||
public ApplicationContext Application { get; private set; }
|
||
|
||
internal IRoutesCache RoutesCache { get; private set; }
|
||
|
||
/// <summary>
|
||
/// Gets/sets the original URL of the request
|
||
/// </summary>
|
||
internal Uri ClientUrl { get; set; }
|
||
|
||
private Uri _requestUrl;
|
||
|
||
/// <summary>
|
||
/// Gets the uri that is handled by ASP.NET after server-side rewriting took place.
|
||
/// </summary>
|
||
internal Uri RequestUrl
|
||
{
|
||
get
|
||
{
|
||
return _requestUrl;
|
||
}
|
||
set
|
||
{
|
||
_requestUrl = value;
|
||
this.UmbracoUrl = UriUtility.UriToUmbraco(_requestUrl);
|
||
}
|
||
}
|
||
|
||
/// <summary>
|
||
/// Gets the cleaned up url that is handled by Umbraco.
|
||
/// </summary>
|
||
/// <remarks>That is, lowercase, no trailing slash after path, no .aspx...</remarks>
|
||
internal Uri UmbracoUrl { get; private set; }
|
||
|
||
private Func<XmlDocument> _xmlDelegate;
|
||
|
||
/// <summary>
|
||
/// Gets/sets the delegate used to retreive the Xml content, generally the setter is only used for unit tests
|
||
/// and by default if it is not set will use the standard delegate which ONLY works when in the context an Http Request
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// If not defined, we will use the standard delegate which ONLY works when in the context an Http Request
|
||
/// mostly because the 'content' object heavily relies on HttpContext, SQL connections and a bunch of other stuff
|
||
/// that when run inside of a unit test fails.
|
||
/// </remarks>
|
||
internal Func<XmlDocument> GetXmlDelegate
|
||
{
|
||
get
|
||
{
|
||
return _xmlDelegate ?? (_xmlDelegate = () =>
|
||
{
|
||
if (InPreviewMode)
|
||
{
|
||
if (_previewContent == null)
|
||
{
|
||
_previewContent = new PreviewContent(UmbracoUser, new Guid(StateHelper.Cookies.Preview.GetValue()), true);
|
||
if (_previewContent.ValidPreviewSet)
|
||
_previewContent.LoadPreviewset();
|
||
}
|
||
if (_previewContent.ValidPreviewSet)
|
||
return _previewContent.XmlContent;
|
||
}
|
||
return content.Instance.XmlContent;
|
||
});
|
||
}
|
||
set { _xmlDelegate = value; }
|
||
}
|
||
|
||
/// <summary>
|
||
/// Returns the XML Cache document
|
||
/// </summary>
|
||
/// <returns></returns>
|
||
/// <remarks>
|
||
/// This is marked internal for now because perhaps we might return a wrapper like CacheData so that it doesn't have a reliance
|
||
/// specifically on XML.
|
||
/// </remarks>
|
||
internal XmlDocument GetXml()
|
||
{
|
||
return GetXmlDelegate();
|
||
}
|
||
|
||
/// <summary>
|
||
/// Boolean value indicating whether the current request is a front-end umbraco request
|
||
/// </summary>
|
||
public bool IsFrontEndUmbracoRequest
|
||
{
|
||
get { return DocumentRequest != null; }
|
||
}
|
||
|
||
/// <summary>
|
||
/// A shortcut to the UmbracoContext's RoutingContext's NiceUrlProvider
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// If the RoutingContext is null, this will throw an exception.
|
||
/// </remarks>
|
||
internal NiceUrlProvider NiceUrlProvider
|
||
{
|
||
get
|
||
{
|
||
if (RoutingContext == null)
|
||
throw new InvalidOperationException("Cannot access the NiceUrlProvider when the UmbracoContext's RoutingContext is null");
|
||
return RoutingContext.NiceUrlProvider;
|
||
}
|
||
}
|
||
|
||
/// <summary>
|
||
/// Gets/sets the RoutingContext object
|
||
/// </summary>
|
||
internal RoutingContext RoutingContext { get; set; }
|
||
|
||
/// <summary>
|
||
/// Gets/sets the DocumentRequest object
|
||
/// </summary>
|
||
internal DocumentRequest DocumentRequest { get; set; }
|
||
|
||
/// <summary>
|
||
/// Exposes the HttpContext for the current request
|
||
/// </summary>
|
||
public HttpContextBase HttpContext { get; private set; }
|
||
|
||
/// <summary>
|
||
/// Gets a value indicating whether the request has debugging enabled
|
||
/// </summary>
|
||
/// <value><c>true</c> if this instance is debug; otherwise, <c>false</c>.</value>
|
||
public bool IsDebug
|
||
{
|
||
get
|
||
{
|
||
return GlobalSettings.DebugMode && (!string.IsNullOrEmpty(HttpContext.Request["umbdebugshowtrace"]) || !string.IsNullOrEmpty(HttpContext.Request["umbdebug"]));
|
||
}
|
||
}
|
||
|
||
/// <summary>
|
||
/// Gets the current page ID, or <c>null</c> if no page ID is available (e.g. a custom page).
|
||
/// </summary>
|
||
public virtual int? PageId
|
||
{
|
||
get
|
||
{
|
||
try
|
||
{
|
||
//TODO: this should be done with a wrapper: http://issues.umbraco.org/issue/U4-61
|
||
return int.Parse(HttpContext.Items["pageID"].ToString());
|
||
}
|
||
catch
|
||
{
|
||
return null;
|
||
}
|
||
}
|
||
}
|
||
|
||
/// <summary>
|
||
/// Gets the current logged in Umbraco user (editor).
|
||
/// </summary>
|
||
/// <value>The Umbraco user object or null</value>
|
||
public virtual User UmbracoUser
|
||
{
|
||
get
|
||
{
|
||
return UmbracoEnsuredPage.CurrentUser;
|
||
}
|
||
|
||
}
|
||
|
||
/// <summary>
|
||
/// Determines whether the current user is in a preview mode and browsing the site (ie. not in the admin UI)
|
||
/// </summary>
|
||
public virtual bool InPreviewMode
|
||
{
|
||
get
|
||
{
|
||
if (HttpContext.Request == null || HttpContext.Request.Url == null)
|
||
return false;
|
||
|
||
var currentUrl = HttpContext.Request.Url.AbsolutePath;
|
||
// zb-00004 #29956 : refactor cookies names & handling
|
||
return
|
||
StateHelper.Cookies.Preview.HasValue // has preview cookie
|
||
&& UmbracoUser != null // has user
|
||
&& !currentUrl.StartsWith(Umbraco.Core.IO.IOHelper.ResolveUrl(Umbraco.Core.IO.SystemDirectories.Umbraco)); // is not in admin UI
|
||
}
|
||
}
|
||
|
||
|
||
}
|
||
} |