Umbraco-CMS/src/Umbraco.Web/Routing/DocumentRequest.cs

using System;
using System.Linq;
using System.Text;
using System.Xml;
using System.Globalization;
using System.Diagnostics;

// legacy
using umbraco.cms.businesslogic.web;
using umbraco.cms.businesslogic.template;
using umbraco.cms.businesslogic.member;
using umbraco.cms.businesslogic.language;
namespace Umbraco.Web.Routing
{
    internal class DocumentRequest
    {
        static readonly TraceSource Trace = new TraceSource("DocumentRequest");

        public DocumentRequest(Uri uri, RoutingEnvironment lookups, UmbracoContext umbracoContext, NiceUrlResolver niceUrlResolver)
        {
            // register lookups
            _environment = lookups;
            UmbracoContext = umbracoContext;
            _niceUrlResolver = niceUrlResolver;

            // prepare the host
            var host = uri.Host;

            // fixme
            //var serverVarHost = httpContext.Request.ServerVariables["X_UMBRACO_HOST"];
            //if (!string.IsNullOrWhiteSpace(serverVarHost))
            //{
            //    host = serverVarHost;
            //    RequestContext.Current.Trace.Write(TraceCategory, "Domain='" + host + "' (X_UMBRACO_HOST)");
            //}

            // initialize the host
            this.Host = host;

            // prepare the path
            var path = uri.AbsolutePath;
            path = path.Substring(UrlUtility.AppVirtualPathPrefix.Length); // remove virtual directory
            path = path.TrimEnd('/'); // remove trailing /
            if (!path.StartsWith("/")) // ensure it starts with /
                path = "/" + path;
            path = path.ToLower(); // make it all lowercase
            //url = url.Replace('\'', '_'); // make it xpath compatible !! was in legacy, should be handled in xpath query, not here
            if (path.EndsWith(".aspx")) // remove trailing .aspx
                path = path.Substring(0, path.Length - ".aspx".Length);

            // initialize the path
            this.Path = path;

            // initialize the query
            this.QueryString = uri.Query.TrimStart('?');
        }

		readonly RoutingEnvironment _environment;
		private readonly NiceUrlResolver _niceUrlResolver;

		/// <summary>
		/// the id of the requested node, if any, else zero.
		/// </summary>
		int _nodeId = 0;

		/// <summary>
		/// the requested node, if any, else null.
		/// </summary>
		XmlNode _node = null;

        #region Properties

		/// <summary>
		/// Returns the current UmbracoContext
		/// </summary>
		public UmbracoContext UmbracoContext { get; private set; }

        /// <summary>
        /// Gets the request host name.
        /// </summary>
        /// <remarks>This is the original uri's host, unless modified (fixme).</remarks>
        public string Host { get; private set; }

        /// <summary>
        /// Gets the request path.
        /// </summary>
        /// <remarks>This is the original uri's path, cleaned up, without vdir, without .aspx, etc.</remarks>
        public string Path { get; private set; }

        /// <summary>
        /// Gets the request query string.
        /// </summary>
        /// <remarks>This is the original uri's querystring, without the initial '?'.</remarks>
        public string QueryString { get; private set; }

        /// <summary>
        /// Gets or sets the document request's domain.
        /// </summary>
        public Domain Domain { get; private set; }

        /// <summary>
        /// Gets a value indicating whether the document request has a domain.
        /// </summary>
        public bool HasDomain
        {
            get { return this.Domain != null; }
        }

        /// <summary>
        /// Gets or sets the document request's culture
        /// </summary>
        public CultureInfo Culture { get; private set; }

        // fixme - do we want to have an ordered list of alternate cultures,
        //         to allow for fallbacks when doing dictionnary lookup and such?

        /// <summary>
        /// Gets or sets the document request's document xml node.
        /// </summary>
        public XmlNode Node
        {
            get
            {
                return _node;
            }
            set
            {
                _node = value;
                this.Template = null;
                if (_node != null)
                    _nodeId = int.Parse(_environment.ContentStore.GetNodeProperty(_node, "@id"));
                else
                    _nodeId = 0;
            }
        }

        /// <summary>
        /// Gets or sets the document request's template.
        /// </summary>
        public Template Template { get; set; }

        /// <summary>
        /// Gets a value indicating whether the document request has a template.
        /// </summary>
        public bool HasTemplate
        {
            get { return this.Template != null; }
        }

        /// <summary>
        /// Gets the id of the document.
        /// </summary>
        /// <exception cref="InvalidOperationException">Thrown when the document request has no document.</exception>
        public int NodeId
        {
            get
            {
                if (this.Node == null)
                    throw new InvalidOperationException("DocumentRequest has no document.");
                return _nodeId;
            }
        }

        /// <summary>
        /// Gets a value indicating whether the document request has a document.
        /// </summary>
        public bool HasNode
        {
            get { return this.Node != null; }
        }

        /// <summary>
        /// Gets or sets a value indicating whether the requested document could not be found.
        /// </summary>
        public bool Is404 { get; private set; }

        /// <summary>
        /// Gets a value indicating whether the document request triggers a redirect.
        /// </summary>
        public bool IsRedirect { get { return !string.IsNullOrWhiteSpace(this.RedirectUrl); } }

        /// <summary>
        /// Gets the url to redirect to, when the document request triggers a redirect.
        /// </summary>
        public string RedirectUrl { get; set; }

        #endregion

        #region Resolve

        /// <summary>
        /// Determines the site root (if any) matching the http request.
        /// </summary>        
        /// <returns>A value indicating whether a domain was found.</returns>
        public bool ResolveSiteRoot()
        {
            const string tracePrefix = "ResolveSiteRoot: ";

            // note - we are not handling schemes nor ports here.

            Trace.TraceInformation("{0}Host=\"{1}\"", tracePrefix, this.Host);

            Domain domain = null;

            // get domains, those with a slash coming first, so that 'foo.com/en' takes precedence over 'foo.com'.
            // domains should NOT begin with 'http://'.
            var domains = Domain.GetDomains().OrderByDescending(od => od.Name.IndexOf('/'));

            // try to find a domain matching the current request
            string urlWithDomain = UrlUtility.EnsureScheme(this.Host + this.Path, "http"); // FIXME-NICEURL - current Uri?!
            domain = domains.FirstOrDefault(d => UrlUtility.IsBaseOf(d.Name, urlWithDomain));

            // handle domain
            if (domain != null)
            {
                // matching an existing domain
                Trace.TraceInformation("{0}Matches domain=\"{1}\", rootId={2}, culture=\"{3}\"",
                                       tracePrefix,
                                       domain.Name, domain.RootNodeId, domain.Language.CultureAlias);

                this.Domain = domain;
                this.Culture = new CultureInfo(domain.Language.CultureAlias);

                // canonical?
                // FIXME - NOT IMPLEMENTED AT THE MOMENT + THEN WE WOULD RETURN THE CANONICAL DOMAIN AND ASK FOR REDIRECT
                // but then how do I translate if domain is bar.com/en ? will depend on how we handle domains
            }
            else
            {
                // not matching any existing domain
                Trace.TraceInformation("{0}Matches no domain", tracePrefix);

                var defaultLanguage = Language.GetAllAsList().FirstOrDefault();
                this.Culture = defaultLanguage == null ? CultureInfo.CurrentUICulture : new CultureInfo(defaultLanguage.CultureAlias);
            }

            Trace.TraceInformation("{0}Culture=\"{1}\"", tracePrefix, this.Culture.Name);
            return this.Domain != null;
        }

        /// <summary>
        /// Determines the Umbraco document (if any) matching the http request.
        /// </summary>
        /// <returns>A value indicating whether a document and template nave been found.</returns>
        public bool ResolveDocument()
        {
            const string tracePrefix = "ResolveDocument: ";
            Trace.TraceInformation("{0}Path=\"{1}\"", tracePrefix, this.Path);

            // look for the document
            // the first successful lookup, if any, will set this.Node, and may also set this.Template
            // some lookups may implement caching
            Trace.TraceInformation("{0}Begin lookup", tracePrefix);
        	var lookups = _environment.RouteLookups.GetLookups();
			lookups.Any(lookup => lookup.LookupDocument(this));
            Trace.TraceInformation("{0}End lookup, {1}", tracePrefix, (this.HasNode ? "a document was found" : "no document was found"));

            // fixme - not handling umbracoRedirect
            // should come after internal redirects
            // so after ResolveDocument2() => docreq.IsRedirect => handled by the module!

            // handle not-found, redirects, access, template
            ResolveDocument2();

            // handle umbracoRedirect (moved from umbraco.page)
            FollowRedirect();

            bool resolved = this.HasNode && this.HasTemplate;
            return resolved;
        }

        /// <summary>
        /// Performs the document resolution second pass.
        /// </summary>
        /// <remarks>The second pass consists in handling "not found", internal redirects, access validation, and template.</remarks>
        void ResolveDocument2()
        {
            const string tracePrefix = "ResolveDocument2: ";

            // handle "not found", follow internal redirects, validate access, template
            // because these might loop, we have to have some sort of infinite loop detection 
            int i = 0, j = 0;
            const int maxLoop = 12;
            do
            {
                Trace.TraceInformation("{0}{1}", tracePrefix, (i == 0 ? "Begin" : "Loop"));

                // handle not found
                if (!this.HasNode)
                {
                    this.Is404 = true;
                    Trace.TraceInformation("{0}No document, try notFound lookup", tracePrefix);

                    // if it fails then give up, there isn't much more that we can do
                    if (_environment.LookupNotFound == null || !_environment.LookupNotFound.LookupDocument(this))
                    {
                        Trace.TraceInformation("{0}Failed to find a document, give up", tracePrefix);
                        break;
                    }
                    else
                    {
                        Trace.TraceInformation("{0}Found a document", tracePrefix);
                    }
                }

                // follow internal redirects as long as it's not running out of control ie infinite loop of some sort
                j = 0;
                while (FollowInternalRedirects() && j++ < maxLoop) ;
                if (j == maxLoop) // we're running out of control
                    break;

                // ensure access
                if (this.HasNode)
                    EnsureNodeAccess();

                // resolve template
                if (this.HasNode)
                    ResolveTemplate();

                // loop while we don't have page, ie the redirect or access
                // got us to nowhere and now we need to run the notFoundLookup again
                // as long as it's not running out of control ie infinite loop of some sort

            } while (!this.HasNode && i++ < maxLoop);

            if (i == maxLoop || j == maxLoop)
            {
                Trace.TraceInformation("{0}Looks like we're running into an infinite loop, abort", tracePrefix);
                this.Node = null;
            }
            Trace.TraceInformation("{0}End", tracePrefix);
        }

        /// <summary>
        /// Follows internal redirections through the <c>umbracoInternalRedirectId</c> document property.
        /// </summary>
        /// <returns>A value indicating whether redirection took place and led to a new published document.</returns>
        /// <remarks>Redirecting to a different site root and/or culture will not pick the new site root nor the new culture.</remarks>
        bool FollowInternalRedirects()
        {
            const string tracePrefix = "FollowInternalRedirects: ";

            if (this.Node == null)
                throw new InvalidOperationException("There is no node.");

            bool redirect = false;
            string internalRedirect = _environment.ContentStore.GetNodeProperty(this.Node, "umbracoInternalRedirectId");

            if (!string.IsNullOrWhiteSpace(internalRedirect))
            {
                Trace.TraceInformation("{0}Found umbracoInternalRedirectId={1}", tracePrefix, internalRedirect);

                int internalRedirectId;
                if (!int.TryParse(internalRedirect, out internalRedirectId))
                    internalRedirectId = -1;

                if (internalRedirectId <= 0)
                {
                    // bad redirect
                    this.Node = null;
                    Trace.TraceInformation("{0}Failed to redirect to id={1}: invalid value", tracePrefix, internalRedirect);
                }
                else if (internalRedirectId == this.NodeId)
                {
                    // redirect to self
                    Trace.TraceInformation("{0}Redirecting to self, ignore", tracePrefix);
                }
                else
                {
                    // redirect to another page
                    var node = _environment.ContentStore.GetNodeById(internalRedirectId);
                    this.Node = node;
                    if (node != null)
                    {
                        redirect = true;
                        Trace.TraceInformation("{0}Redirecting to id={1}", tracePrefix, internalRedirectId);
                    }
                    else
                    {
                        Trace.TraceInformation("{0}Failed to redirect to id={1}: no such published document", tracePrefix, internalRedirectId);
                    }
                }
            }

            return redirect;
        }

        /// <summary>
        /// Ensures that access to current node is permitted.
        /// </summary>
        /// <remarks>Redirecting to a different site root and/or culture will not pick the new site root nor the new culture.</remarks>
        void EnsureNodeAccess()
        {
            const string tracePrefix = "EnsurePageAccess: ";

            if (this.Node == null)
                throw new InvalidOperationException("There is no node.");

            var path = _environment.ContentStore.GetNodeProperty(this.Node, "@path");

            if (Access.IsProtected(this.NodeId, path))
            {
                Trace.TraceInformation("{0}Page is protected, check for access", tracePrefix);

                var user = System.Web.Security.Membership.GetUser();

                if (user == null || !Member.IsLoggedOn())
                {
                    Trace.TraceInformation("{0}Not logged in, redirect to login page", tracePrefix);
                    var loginPageId = Access.GetLoginPage(path);
                    if (loginPageId != this.NodeId)
                        this.Node = _environment.ContentStore.GetNodeById(loginPageId);
                }
                else if (!Access.HasAccces(this.NodeId, user.ProviderUserKey))
                {
                    Trace.TraceInformation("{0}Current member has not access, redirect to error page", tracePrefix);
                    var errorPageId = Access.GetErrorPage(path);
                    if (errorPageId != this.NodeId)
                        this.Node = _environment.ContentStore.GetNodeById(errorPageId);
                }
                else
                {
                    Trace.TraceInformation("{0}Current member has access", tracePrefix);
                }
            }
            else
            {
                Trace.TraceInformation("{0}Page is not protected", tracePrefix);
            }
        }

        /// <summary>
        /// Resolves a template for the current node.
        /// </summary>
        void ResolveTemplate()
        {
            const string tracePrefix = "ResolveTemplate: ";

            if (this.Node == null)
                throw new InvalidOperationException("There is no node.");

            var templateAlias = UmbracoContext.HttpContext.Request.QueryString["altTemplate"];
            if (string.IsNullOrWhiteSpace(templateAlias))
                templateAlias = UmbracoContext.HttpContext.Request.Form["altTemplate"];

            // fixme - we might want to support cookies?!? NO but provide a hook to change the template

            if (!this.HasTemplate || !string.IsNullOrWhiteSpace(templateAlias))
            {
                if (string.IsNullOrWhiteSpace(templateAlias))
                {
                    templateAlias = _environment.ContentStore.GetNodeProperty(this.Node, "@template");
                    Trace.TraceInformation("{0}Look for template id={1}", tracePrefix, templateAlias);
                    int templateId;
                    if (!int.TryParse(templateAlias, out templateId))
                        templateId = 0;
                    this.Template = templateId > 0 ? new Template(templateId) : null;
                }
                else
                {
                    Trace.TraceInformation("{0}Look for template alias=\"{1}\" (altTemplate)", tracePrefix, templateAlias);
                    this.Template = Template.GetByAlias(templateAlias);
                }

                if (!this.HasTemplate)
                {
                    Trace.TraceInformation("{0}No template was found", tracePrefix);

                    //TODO: I like the idea of this new setting, but lets get this in to the core at a later time, for now lets just get the basics working.
                    //if (Settings.HandleMissingTemplateAs404)
                    //{
                    //    this.Node = null;
                    //    Trace.TraceInformation("{0}Assume page not found (404)", tracePrefix);
                    //}

                    // else we have no template
                    // and there isn't much more we can do about it
                }
                else
                {
                    Trace.TraceInformation("{0}Found", tracePrefix);
                }
            }
        }

        /// <summary>
        /// Follows external redirection through <c>umbracoRedirect</c> document property.
        /// </summary>
        void FollowRedirect()
        {
            if (this.HasNode)
            {
                int redirectId;
                if (!int.TryParse(_environment.ContentStore.GetNodeProperty(this.Node, "umbracoRedirect"), out redirectId))
                    redirectId = -1;
                string redirectUrl = "#";
                if (redirectId > 0)
                    redirectUrl = _niceUrlResolver.GetNiceUrl(redirectId);
                if (redirectUrl != "#")
                    this.RedirectUrl = redirectUrl;
            }
        }

        #endregion
    }
}